openapi-directory/api/azure.com/web-ResourceProvider.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":" API Client","version":"2018-02-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"web-ResourceProvider","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Web/publishingUsers/web":{"get":{"description":"Gets publishing user","operationId":"GetPublishingUser","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User credentials used for publishing activity.","properties":{"properties":{"description":"User resource specific properties","properties":{"publishingPassword":{"description":"Password used for publishing.","format":"password","type":"string"},"publishingPasswordHash":{"description":"Password hash used for publishing.","format":"password","type":"string"},"publishingPasswordHashSalt":{"description":"Password hash salt used for publishing.","format":"password","type":"string"},"publishingUserName":{"description":"Username used for publishing.","type":"string"},"scmUri":{"description":"Url of SCM site.","type":"string"}},"required":["publishingUserName"],"x-ms-client-flatten":true}},"type":"object"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets publishing user"},"put":{"description":"Updates publishing user","operationId":"UpdatePublishingUser","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User credentials used for publishing activity.","properties":{"properties":{"description":"User resource specific properties","properties":{"publishingPassword":{"description":"Password used for publishing.","format":"password","type":"string"},"publishingPasswordHash":{"description":"Password hash used for publishing.","format":"password","type":"string"},"publishingPasswordHashSalt":{"description":"Password hash salt used for publishing.","format":"password","type":"string"},"publishingUserName":{"description":"Username used for publishing.","type":"string"},"scmUri":{"description":"Url of SCM site.","type":"string"}},"required":["publishingUserName"],"x-ms-client-flatten":true}},"type":"object"}}},"description":"Details of publishing user","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User credentials used for publishing activity.","properties":{"properties":{"description":"User resource specific properties","properties":{"publishingPassword":{"description":"Password used for publishing.","format":"password","type":"string"},"publishingPasswordHash":{"description":"Password hash used for publishing.","format":"password","type":"string"},"publishingPasswordHashSalt":{"description":"Password hash salt used for publishing.","format":"password","type":"string"},"publishingUserName":{"description":"Username used for publishing.","type":"string"},"scmUri":{"description":"Url of SCM site.","type":"string"}},"required":["publishingUserName"],"x-ms-client-flatten":true}},"type":"object"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Updates publishing user"}},"/providers/Microsoft.Web/sourcecontrols":{"get":{"description":"Gets the source controls available for Azure websites.","operationId":"ListSourceControls","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControlCollection"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets the source controls available for Azure websites.","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Web/sourcecontrols/{sourceControlType}":{"get":{"description":"Gets source control token","operationId":"GetSourceControl","parameters":[{"description":"Type of source control","in":"path","name":"sourceControlType","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets source control token"},"put":{"description":"Updates source control token","operationId":"UpdateSourceControl","parameters":[{"description":"Type of source control","in":"path","name":"sourceControlType","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"}}},"description":"Source control token information","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Updates source control token"}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters":{"get":{"description":"Gets a list of meters for a given location.","operationId":"ListBillingMeters","parameters":[{"description":"Azure Location of billable resource","in":"query","name":"billingLocation","schema":{"type":"string"}},{"description":"App Service OS type meters used for","in":"query","name":"osType","schema":{"type":"string"}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterCollection"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets a list of meters for a given location.","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability":{"post":{"description":"Check if a resource name is available.","operationId":"CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNameAvailabilityRequest"}}},"description":"Name availability request.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNameAvailability"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Check if a resource name is available."}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations":{"get":{"description":"Gets list of available geo regions plus ministamps","operationId":"GetSubscriptionDeploymentLocations","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentLocations"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets list of available geo regions plus ministamps"}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions":{"get":{"description":"Get a list of available geographical regions.","operationId":"ListGeoRegions","parameters":[{"description":"Name of SKU used to filter the regions.","in":"query","name":"sku","x-ms-enum":{"modelAsString":true,"name":"SkuName"},"schema":{"type":"string","enum":["Free","Shared","Basic","Standard","Premium","Dynamic","Isolated","PremiumV2","ElasticPremium","ElasticIsolated"]}},{"description":"Specify <code>true</code> if you want to filter to only regions that support Linux workers.","in":"query","name":"linuxWorkersEnabled","schema":{"type":"boolean"}},{"description":"Specify <code>true</code> if you want to filter to only regions that support Xenon workers.","in":"query","name":"xenonWorkersEnabled","schema":{"type":"boolean"}},{"description":"Specify <code>true</code> if you want to filter to only regions that support Linux Consumption Workers.","in":"query","name":"linuxDynamicWorkersEnabled","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegionCollection"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Get a list of available geographical regions.","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName":{"post":{"description":"List all apps that are assigned to a hostname.","operationId":"ListSiteIdentifiersAssignedToHostName","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Identifies an object.","properties":{"name":{"description":"Name of the object.","type":"string"}},"type":"object"}}},"description":"Hostname information.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Collection of identifiers.","properties":{"nextLink":{"description":"Link to next page of resources.","readOnly":true,"type":"string"},"value":{"description":"Collection of resources.","items":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"A domain specific resource identifier.","properties":{"properties":{"description":"Identifier resource specific properties","properties":{"id":{"description":"String representation of the identity.","type":"string"}},"x-ms-client-flatten":true}},"type":"object"},"type":"array"}},"required":["value"],"type":"object"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"List all apps that are assigned to a hostname.","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers":{"get":{"description":"List all premier add-on offers.","operationId":"ListPremierAddOnOffers","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PremierAddOnOfferCollection"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"List all premier add-on offers.","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/skus":{"get":{"description":"List all SKUs.","operationId":"ListSkus","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkuInfos"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"List all SKUs."}},"/subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet":{"post":{"description":"Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.","operationId":"VerifyHostingEnvironmentVnet","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VnetParameters"}}},"description":"VNET information","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VnetValidationFailureDetails"},"examples":{"VerifyHostingEnvironmentVnet":{"$ref":"#/components/examples/VerifyHostingEnvironmentVnet"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules."}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources":{"post":{"description":"Move resources between resource groups.","operationId":"Move","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/CsmMoveResourceEnvelope"},"responses":{"204":{"description":"No Content"}},"summary":"Move resources between resource groups."}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate":{"post":{"description":"Validate if a resource can be created.","operationId":"Validate","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateRequest"}}},"description":"Request with the resources to validate.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateResponse"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Validate if a resource can be created."}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validateContainerSettings":{"post":{"description":"Validate if the container settings are correct.","operationId":"ValidateContainerSettings","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateContainerSettingsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Validate if the container settings are correct."}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources":{"post":{"description":"Validate whether a resource can be moved.","operationId":"ValidateMove","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/CsmMoveResourceEnvelope"},"responses":{"204":{"description":"No Content"}},"summary":"Validate whether a resource can be moved."}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"VerifyHostingEnvironmentVnet":{"value":{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/verifyHostingEnvironmentVnet","properties":{"failed":false,"failedTests":[]}}}},"parameters":{"apiVersionParameter":{"description":"API Version","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VerifyHostingEnvironmentVnet":{"value":"2018-02-01"}}},"resourceGroupNameParameter":{"description":"Name of the resource group to which the resource belongs.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+[^\\.]$"}},"subscriptionIdParameter":{"description":"Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"VerifyHostingEnvironmentVnet":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"}}}},"requestBodies":{"CsmMoveResourceEnvelope":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsmMoveResourceEnvelope"}}},"description":"Object that represents the resource to move.","required":true}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"BillingMeter":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.","properties":{"properties":{"description":"BillingMeter resource specific properties","properties":{"billingLocation":{"description":"Azure Location of billable resource","type":"string"},"friendlyName":{"description":"Friendly name of the meter","type":"string"},"meterId":{"description":"Meter GUID onboarded in Commerce","type":"string"},"osType":{"description":"App Service OS type meter used for","type":"string"},"resourceType":{"description":"App Service ResourceType meter used for","type":"string"},"shortName":{"description":"Short Name from App Service Azure pricing Page","type":"string"}},"x-ms-client-flatten":true}},"type":"object"},"BillingMeterCollection":{"description":"Collection of Billing Meters","properties":{"nextLink":{"description":"Link to next page of resources.","readOnly":true,"type":"string"},"value":{"description":"Collection of resources.","items":{"$ref":"#/components/schemas/BillingMeter"},"type":"array"}},"required":["value"],"type":"object"},"CsmMoveResourceEnvelope":{"description":"Object with a list of the resources that need to be moved and the resource group they should be moved to.","properties":{"resources":{"items":{"type":"string"},"type":"array"},"targetResourceGroup":{"maxLength":90,"minLength":1,"pattern":" ^[-\\w\\._\\(\\)]+[^\\.]$","type":"string"}},"type":"object"},"DeploymentLocations":{"description":"List of available locations (regions or App Service Environments) for\ndeployment of App Service resources.","properties":{"hostingEnvironmentDeploymentInfos":{"description":"Available App Service Environments with basic information.","items":{"$ref":"#/components/schemas/HostingEnvironmentDeploymentInfo"},"type":"array"},"hostingEnvironments":{"description":"Available App Service Environments with full descriptions of the environments.","items":{"description":"Description of an App Service Environment.","properties":{"allowedMultiSizes":{"description":"List of comma separated strings describing which VM sizes are allowed for front-ends.","readOnly":true,"type":"string"},"allowedWorkerSizes":{"description":"List of comma separated strings describing which VM sizes are allowed for workers.","readOnly":true,"type":"string"},"apiManagementAccountId":{"description":"API Management Account associated with the App Service Environment.","type":"string"},"clusterSettings":{"description":"Custom settings for changing the behavior of the App Service Environment.","items":{"description":"Name value pair.","properties":{"name":{"description":"Pair name.","type":"string"},"value":{"description":"Pair value.","type":"string"}},"type":"object"},"type":"array"},"databaseEdition":{"description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\".","readOnly":true,"type":"string"},"databaseServiceObjective":{"description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\".","readOnly":true,"type":"string"},"defaultFrontEndScaleFactor":{"description":"Default Scale Factor for FrontEnds.","format":"int32","readOnly":true,"type":"integer"},"dnsSuffix":{"description":"DNS suffix of the App Service Environment.","type":"string"},"dynamicCacheEnabled":{"description":"True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).","type":"boolean"},"environmentCapacities":{"description":"Current total, used, and available worker capacities.","items":{"description":"Stamp capacity information.","properties":{"availableCapacity":{"description":"Available capacity (# of machines, bytes of storage etc...).","format":"int64","type":"integer"},"computeMode":{"description":"Shared/dedicated workers.","enum":["Shared","Dedicated","Dynamic"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"ComputeModeOptions"}},"excludeFromCapacityAllocation":{"description":"If <code>true</code>, it includes basic apps.\nBasic apps are not used for capacity allocation.","type":"boolean"},"isApplicableForAllComputeModes":{"description":"<code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.","type":"boolean"},"isLinux":{"description":"Is this a linux stamp capacity","type":"boolean"},"name":{"description":"Name of the stamp.","type":"string"},"siteMode":{"description":"Shared or Dedicated.","type":"string"},"totalCapacity":{"description":"Total capacity (# of machines, bytes of storage etc...).","format":"int64","type":"integer"},"unit":{"description":"Name of the unit.","type":"string"},"workerSize":{"description":"Size of the machines.","enum":["Small","Medium","Large","D1","D2","D3","Default"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"WorkerSizeOptions"}},"workerSizeId":{"description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large","format":"int32","type":"integer"}},"type":"object"},"readOnly":true,"type":"array"},"environmentIsHealthy":{"description":"True/false indicating whether the App Service Environment is healthy.","readOnly":true,"type":"boolean"},"environmentStatus":{"description":"Detailed message about with results of the last check of the App Service Environment.","readOnly":true,"type":"string"},"frontEndScaleFactor":{"description":"Scale factor for front-ends.","format":"int32","type":"integer"},"hasLinuxWorkers":{"description":"Flag that displays whether an ASE has linux workers or not","type":"boolean"},"internalLoadBalancingMode":{"description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.","enum":["None","Web","Publishing"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"InternalLoadBalancingMode"}},"ipsslAddressCount":{"description":"Number of IP SSL addresses reserved for the App Service Environment.","format":"int32","type":"integer"},"lastAction":{"description":"Last deployment action on the App Service Environment.","readOnly":true,"type":"string"},"lastActionResult":{"description":"Result of the last deployment action on the App Service Environment.","readOnly":true,"type":"string"},"location":{"description":"Location of the App Service Environment, e.g. \"West US\".","type":"string"},"maximumNumberOfMachines":{"description":"Maximum number of VMs in the App Service Environment.","format":"int32","readOnly":true,"type":"integer"},"multiRoleCount":{"description":"Number of front-end instances.","format":"int32","type":"integer"},"multiSize":{"description":"Front-end VM size, e.g. \"Medium\", \"Large\".","type":"string"},"name":{"description":"Name of the App Service Environment.","type":"string"},"networkAccessControlList":{"description":"Access control list for controlling traffic to the App Service Environment.","items":{"description":"Network access control entry.","properties":{"action":{"description":"Action object.","enum":["Permit","Deny"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"AccessControlEntryAction"}},"description":{"description":"Description of network access control entry.","type":"string"},"order":{"description":"Order of precedence.","format":"int32","type":"integer"},"remoteSubnet":{"description":"Remote subnet.","type":"string"}},"type":"object"},"type":"array"},"provisioningState":{"description":"Provisioning state of the App Service Environment.","enum":["Succeeded","Failed","Canceled","InProgress","Deleting"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":false,"name":"ProvisioningState"}},"resourceGroup":{"description":"Resource group of the App Service Environment.","readOnly":true,"type":"string"},"sslCertKeyVaultId":{"description":"Key Vault ID for ILB App Service Environment default SSL certificate","type":"string"},"sslCertKeyVaultSecretName":{"description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate","type":"string"},"status":{"description":"Current status of the App Service Environment.","enum":["Preparing","Ready","Scaling","Deleting"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":false,"name":"HostingEnvironmentStatus"}},"subscriptionId":{"description":"Subscription of the App Service Environment.","readOnly":true,"type":"string"},"suspended":{"description":"<code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available\n (most likely because NSG blocked the incoming traffic).","type":"boolean"},"upgradeDomains":{"description":"Number of upgrade domains of the App Service Environment.","format":"int32","readOnly":true,"type":"integer"},"userWhitelistedIpRanges":{"description":"User added ip ranges to whitelist on ASE db","items":{"type":"string"},"type":"array"},"vipMappings":{"description":"Description of IP SSL mapping for the App Service Environment.","items":{"description":"Virtual IP mapping.","properties":{"inUse":{"description":"Is virtual IP mapping in use.","type":"boolean"},"internalHttpPort":{"description":"Internal HTTP port.","format":"int32","type":"integer"},"internalHttpsPort":{"description":"Internal HTTPS port.","format":"int32","type":"integer"},"virtualIP":{"description":"Virtual IP address.","type":"string"}},"type":"object"},"readOnly":true,"type":"array"},"virtualNetwork":{"description":"Specification for using a Virtual Network.","properties":{"id":{"description":"Resource id of the Virtual Network.","type":"string"},"name":{"description":"Name of the Virtual Network (read-only).","readOnly":true,"type":"string"},"subnet":{"description":"Subnet within the Virtual Network.","type":"string"},"type":{"description":"Resource type of the Virtual Network (read-only).","readOnly":true,"type":"string"}},"type":"object"},"vnetName":{"description":"Name of the Virtual Network for the App Service Environment.","type":"string"},"vnetResourceGroupName":{"description":"Resource group of the Virtual Network.","type":"string"},"vnetSubnetName":{"description":"Subnet of the Virtual Network.","type":"string"},"workerPools":{"description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.","items":{"description":"Worker pool of an App Service Environment.","properties":{"computeMode":{"description":"Shared or dedicated app hosting.","enum":["Shared","Dedicated","Dynamic"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"ComputeModeOptions"}},"instanceNames":{"description":"Names of all instances in the worker pool (read only).","items":{"type":"string"},"readOnly":true,"type":"array"},"workerCount":{"description":"Number of instances in the worker pool.","format":"int32","type":"integer"},"workerSize":{"description":"VM size of the worker pool instances.","type":"string"},"workerSizeId":{"description":"Worker size ID for referencing this worker pool.","format":"int32","type":"integer"}},"type":"object"},"type":"array"}},"required":["name","location","virtualNetwork","workerPools"],"type":"object"},"type":"array"},"locations":{"description":"Available regions.","items":{"$ref":"#/components/schemas/GeoRegion"},"type":"array"}},"type":"object"},"GeoRegion":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Geographical region.","properties":{"properties":{"description":"GeoRegion resource specific properties","properties":{"description":{"description":"Region description.","readOnly":true,"type":"string"},"displayName":{"description":"Display name for region.","readOnly":true,"type":"string"}},"x-ms-client-flatten":true}},"type":"object"},"GeoRegionCollection":{"description":"Collection of geographical regions.","properties":{"nextLink":{"description":"Link to next page of resources.","readOnly":true,"type":"string"},"value":{"description":"Collection of resources.","items":{"$ref":"#/components/schemas/GeoRegion"},"type":"array"}},"required":["value"],"type":"object"},"GlobalCsmSkuDescription":{"description":"A Global SKU Description.","properties":{"capabilities":{"description":"Capabilities of the SKU, e.g., is traffic manager enabled?","items":{"description":"Describes the capabilities/features allowed for a specific SKU.","properties":{"name":{"description":"Name of the SKU capability.","type":"string"},"reason":{"description":"Reason of the SKU capability.","type":"string"},"value":{"description":"Value of the SKU capability.","type":"string"}},"type":"object"},"type":"array"},"capacity":{"description":"Description of the App Service plan scale options.","properties":{"default":{"description":"Default number of workers for this App Service plan SKU.","format":"int32","type":"integer"},"maximum":{"description":"Maximum number of workers for this App Service plan SKU.","format":"int32","type":"integer"},"minimum":{"description":"Minimum number of workers for this App Service plan SKU.","format":"int32","type":"integer"},"scaleType":{"description":"Available scale configurations for an App Service plan.","type":"string"}},"type":"object"},"family":{"description":"Family code of the resource SKU.","type":"string"},"locations":{"description":"Locations of the SKU.","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the resource SKU.","type":"string"},"size":{"description":"Size specifier of the resource SKU.","type":"string"},"tier":{"description":"Service Tier of the resource SKU.","type":"string"}},"type":"object"},"HostingEnvironmentDeploymentInfo":{"description":"Information needed to create resources on an App Service Environment.","properties":{"location":{"description":"Location of the App Service Environment.","type":"string"},"name":{"description":"Name of the App Service Environment.","type":"string"}},"type":"object"},"PremierAddOnOffer":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Premier add-on offer.","proper