openapi-directory/api/azure.com/resources.json

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

{"openapi":"3.0.0","info":{"description":"Provides operations for working with resources and resource groups.","title":"ResourceManagementClient","version":"2019-08-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/resources/resource-manager/Microsoft.Resources/stable/2019-08-01/resources.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"resources","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers":{"get":{"description":"Gets all resource providers for the tenant.","operationId":"Providers_ListAtTenantScope","parameters":[{"description":"The number of results to return. If null is passed returns all providers.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns an array of resource providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Providers"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/":{"get":{"description":"Get all the deployments for a management group.","operationId":"Deployments_ListAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"description":"The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to get. If null is passed, returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns an array of deployments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"],"x-ms-odata":"#/components/schemas/DeploymentExtendedFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}":{"delete":{"description":"A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.","operationId":"Deployments_DeleteAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"202":{"description":"Accepted - Returns this status until the asynchronous operation has completed."},"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deletes a deployment from the deployment history.","tags":["Deployments"],"x-ms-long-running-operation":true},"get":{"description":"Gets a deployment.","operationId":"Deployments_GetAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]},"head":{"description":"Checks whether the deployment exists.","operationId":"Deployments_CheckExistenceAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]},"put":{"description":"You can provide the template and parameters directly in the request or link to JSON files.","operationId":"Deployments_CreateOrUpdateAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ScopedDeployment2"},"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"},"examples":{"Create deployment at management group scope.":{"$ref":"#/components/examples/Create_deployment_at_management_group_scope."}}}}},"201":{"description":"Created - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"},"examples":{"Create deployment at management group scope.":{"$ref":"#/components/examples/Create_deployment_at_management_group_scope."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deploys resources at management group scope.","tags":["Deployments"],"x-ms-long-running-operation":true}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel":{"post":{"description":"You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.","operationId":"Deployments_CancelAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Cancels a currently running template deployment.","tags":["Deployments"]}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate":{"post":{"description":"Exports the template used for specified deployment.","operationId":"Deployments_ExportTemplateAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns the template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExportResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations":{"get":{"description":"Gets all deployments operations for a deployment.","operationId":"DeploymentOperations_ListAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"description":"The number of results to return.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Return an array of deployment operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperationsListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["DeploymentOperations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}":{"get":{"description":"Gets a deployments operation.","operationId":"DeploymentOperations_GetAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"description":"The ID of the operation to get.","in":"path","name":"operationId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperation"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["DeploymentOperations"]}},"/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate":{"post":{"description":"Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..","operationId":"Deployments_ValidateAtManagementGroupScope","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ScopedDeployment"},"responses":{"200":{"description":"OK - Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"400":{"description":"Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/providers/Microsoft.Resources/calculateTemplateHash":{"post":{"description":"Calculate the hash of the given template.","operationId":"Deployments_CalculateTemplateHash","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"The template provided to calculate hash.","required":true},"responses":{"200":{"description":"OK - Returns the hash.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateHashResult"},"examples":{"Calculate template hash":{"$ref":"#/components/examples/Calculate_template_hash"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/providers/Microsoft.Resources/deployments/":{"get":{"description":"Get all the deployments at the tenant scope.","operationId":"Deployments_ListAtTenantScope","parameters":[{"description":"The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to get. If null is passed, returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns an array of deployments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"],"x-ms-odata":"#/components/schemas/DeploymentExtendedFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Resources/deployments/{deploymentName}":{"delete":{"description":"A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.","operationId":"Deployments_DeleteAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"202":{"description":"Accepted - Returns this status until the asynchronous operation has completed."},"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deletes a deployment from the deployment history.","tags":["Deployments"],"x-ms-long-running-operation":true},"get":{"description":"Gets a deployment.","operationId":"Deployments_GetAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]},"head":{"description":"Checks whether the deployment exists.","operationId":"Deployments_CheckExistenceAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]},"put":{"description":"You can provide the template and parameters directly in the request or link to JSON files.","operationId":"Deployments_CreateOrUpdateAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ScopedDeployment2"},"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"},"examples":{"Create deployment at tenant scope.":{"$ref":"#/components/examples/Create_deployment_at_tenant_scope."}}}}},"201":{"description":"Created - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"},"examples":{"Create deployment at tenant scope.":{"$ref":"#/components/examples/Create_deployment_at_tenant_scope."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deploys resources at tenant scope.","tags":["Deployments"],"x-ms-long-running-operation":true}},"/providers/Microsoft.Resources/deployments/{deploymentName}/cancel":{"post":{"description":"You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.","operationId":"Deployments_CancelAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Cancels a currently running template deployment.","tags":["Deployments"]}},"/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate":{"post":{"description":"Exports the template used for specified deployment.","operationId":"Deployments_ExportTemplateAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns the template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExportResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/providers/Microsoft.Resources/deployments/{deploymentName}/operations":{"get":{"description":"Gets all deployments operations for a deployment.","operationId":"DeploymentOperations_ListAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"description":"The number of results to return.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Return an array of deployment operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperationsListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["DeploymentOperations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}":{"get":{"description":"Gets a deployments operation.","operationId":"DeploymentOperations_GetAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"description":"The ID of the operation to get.","in":"path","name":"operationId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperation"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["DeploymentOperations"]}},"/providers/Microsoft.Resources/deployments/{deploymentName}/validate":{"post":{"description":"Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..","operationId":"Deployments_ValidateAtTenantScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ScopedDeployment"},"responses":{"200":{"description":"OK - Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"400":{"description":"Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/providers/Microsoft.Resources/operations":{"get":{"description":"Lists all of the available Microsoft.Resources REST API operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/{resourceProviderNamespace}":{"get":{"description":"Gets the specified resource provider at the tenant level.","operationId":"Providers_GetAtTenantScope","parameters":[{"description":"The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/providers":{"get":{"description":"Gets all resource providers for a subscription.","operationId":"Providers_List","parameters":[{"description":"The number of results to return. If null is passed returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resource providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Providers"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/":{"get":{"description":"Get all the deployments for a subscription.","operationId":"Deployments_ListAtSubscriptionScope","parameters":[{"description":"The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to get. If null is passed, returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of deployments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"],"x-ms-odata":"#/components/schemas/DeploymentExtendedFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}":{"delete":{"description":"A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.","operationId":"Deployments_DeleteAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"202":{"description":"Accepted - Returns this status until the asynchronous operation has completed."},"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deletes a deployment from the deployment history.","tags":["Deployments"],"x-ms-long-running-operation":true},"get":{"description":"Gets a deployment.","operationId":"Deployments_GetAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]},"head":{"description":"Checks whether the deployment exists.","operationId":"Deployments_CheckExistenceAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]},"put":{"description":"You can provide the template and parameters directly in the request or link to JSON files.","operationId":"Deployments_CreateOrUpdateAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/Deployment2"},"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"201":{"description":"Created - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deploys resources at subscription scope.","tags":["Deployments"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel":{"post":{"description":"You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.","operationId":"Deployments_CancelAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Cancels a currently running template deployment.","tags":["Deployments"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate":{"post":{"description":"Exports the template used for specified deployment.","operationId":"Deployments_ExportTemplateAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns the template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExportResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations":{"get":{"description":"Gets all deployments operations for a deployment.","operationId":"DeploymentOperations_ListAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"description":"The number of results to return.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Return an array of deployment operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperationsListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["DeploymentOperations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}":{"get":{"description":"Gets a deployments operation.","operationId":"DeploymentOperations_GetAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"description":"The ID of the operation to get.","in":"path","name":"operationId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperation"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["DeploymentOperations"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate":{"post":{"description":"Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..","operationId":"Deployments_ValidateAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/Deployment"},"responses":{"200":{"description":"OK - Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"400":{"description":"Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf":{"post":{"description":"Returns changes that will be made by the deployment if executed at the scope of the subscription.","operationId":"Deployments_WhatIfAtSubscriptionScope","parameters":[{"$ref":"#/components/parameters/DeploymentNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentWhatIf"}}},"description":"Parameters to What If.","required":true},"responses":{"200":{"description":"OK - Returns What-If operation status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatIfOperationResult"},"examples":{"Predict template changes at subscription scope":{"$ref":"#/components/examples/Predict_template_changes_at_subscription_scope"}}}}},"202":{"description":"Accepted - Returns URL in Location header to query for long-running operation status.","headers":{"Location":{"description":"URL to get status of this long-running operation.","schema":{"type":"string"},"example":"/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"},"Retry-After":{"description":"Number of seconds to wait before polling for status.","schema":{"type":"string"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Deployments"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}":{"get":{"description":"Gets the specified resource provider.","operationId":"Providers_Get","parameters":[{"description":"The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register":{"post":{"description":"Registers a subscription with a resource provider.","operationId":"Providers_Register","parameters":[{"description":"The namespace of the resource provider to register.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister":{"post":{"description":"Unregisters a subscription from a resource provider.","operationId":"Providers_Unregister","parameters":[{"description":"The namespace of the resource provider to unregister.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources":{"get":{"description":"Get all the resources for a resource group.","operationId":"Resources_ListByResourceGroup","parameters":[{"description":"The resource group with the resources to get.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"description":"The filter to apply on the operation.<br><br>The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.<br><br>For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'<br><br>You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.<br><br>For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)<br><br>You can link more than one substringof together by adding and/or operators.<br><br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.<br><br>You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"The number of results to return. If null is passed, returns all resources.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ResourceGroups"],"x-ms-odata":"#/components/schemas/GenericResourceFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources":{"post":{"description":"The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ","operationId":"Resources_MoveResources","parameters":[{"description":"The name of the resource group containing the resources to move.","in":"path","name":"sourceResourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ResourcesMoveInfo"},"responses":{"202":{"description":"Accepted"},"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Moves resources from one resource group to another resource group.","tags":["Resources"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources":{"post":{"description":"This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.","operationId":"Resources_ValidateMoveResources","parameters":[{"description":"The name of the resource group containing the resources to validate for move.","in":"path","name":"sourceResourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ResourcesMoveInfo"},"responses":{"202":{"description":"Accepted"},"204":{"description":"No Content"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Validates whether resources can be moved from one resource group to another resource group.","tags":["Resources"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourcegroups":{"get":{"description":"Gets all the resource groups for a subscription.","operationId":"ResourceGroups_List","parameters":[{"description":"The filter to apply on the operation.<br><br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to return. If null is passed, returns all resource groups.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resource groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroupListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ResourceGroups"],"x-ms-odata":"#/components/schemas/ResourceGroupFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}":{"delete":{"description":"When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.","operationId":"ResourceGroups_Delete","parameters":[{"description":"The name of the resource group to delete. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Deletes a resource group.","tags":["ResourceGroups"],"x-ms-long-running-operation":true},"get":{"description":"Gets a resource group.","operationId":"ResourceGroups_Get","parameters":[{"description":"The name of the resource group to get. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ResourceGroups"]},"head":{"description":"Checks whether a resource group exists.","operationId":"ResourceGroups_CheckExistence","parameters":[{"description":"The name of the resource group to check. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ResourceGroups"]},"patch":{"description":"Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.","operationId":"ResourceGroups_Update","parameters":[{"description":"The name of the resource group to update. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroupPatchable"}}},"description":"Parameters supplied to update a resource group.","required":true},"responses":{"200":{"description":"OK - Returns information about the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Updates a resource group.","tags":["ResourceGroups"]},"put":{"description":"Creates or updates a resource group.","operationId":"ResourceGroups_CreateOrUpdate","parameters":[{"description":"The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"Create or update a resource group":{"value":"myResourceGroup"