swagger: '2.0' info: title: Microsoft Azure ResourceManagementClient version: '2022-09-01' description: Provides operations for working with resources and resource groups. host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account paths: /providers/Microsoft.Resources/operations: get: tags: - Operations operationId: microsoftAzureOperationsList description: Lists all of the available Microsoft.Resources REST API operations. parameters: - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/OperationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Resources Operations /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteatscope summary: 'Microsoft Azure Deletes A Deployment From The Deployment History' 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. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/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. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceatscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Scope Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateatscope summary: 'Microsoft Azure Deploys Resources At A Given Scope' description: >- You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: >- Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Create deployment at a given scope.: $ref: ./examples/PutDeploymentAtScope.json get: tags: - Deployments operationId: microsoftAzureDeploymentsGetatscope description: Gets a deployment. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Scope Providers Microsoft Resources Deployments Deploymentname /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel: post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelatscope summary: 'Microsoft Azure Cancels A Currently Running Template Deployment' 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. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate: post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateatscope x-ms-long-running-operation: true description: >- Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: >- Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Scope Providers Microsoft Resources Deployments Deploymentname Validate /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate: post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateatscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Scope Providers Microsoft Resources Deployments Deploymentname Exporttemplate /{scope}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListatscope description: Get all the deployments at the given scope. parameters: - $ref: '#/parameters/ScopeParameter' - name: $filter in: query required: false type: string description: >- The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: >- The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: 'Microsoft Azure Get Scope Providers Microsoft Resources Deployments' /providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteattenantscope summary: 'Microsoft Azure Deletes A Deployment From The Deployment History' 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. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/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. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceattenantscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateattenantscope summary: 'Microsoft Azure Deploys Resources At Tenant Scope' description: >- You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: >- Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Create deployment at tenant scope.: $ref: ./examples/PutDeploymentAtTenant.json get: tags: - Deployments operationId: microsoftAzureDeploymentsGetattenantscope description: Gets a deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Providers Microsoft Resources Deployments Deploymentname /providers/Microsoft.Resources/deployments/{deploymentName}/cancel: post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelattenantscope summary: 'Microsoft Azure Cancels A Currently Running Template Deployment' 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. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /providers/Microsoft.Resources/deployments/{deploymentName}/validate: post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateattenantscope x-ms-long-running-operation: true description: >- Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: >- Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Validate /providers/Microsoft.Resources/deployments/{deploymentName}/whatIf: post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatifattenantscope description: >- Returns changes that will be made by the deployment if executed at the scope of the tenant group. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeploymentWhatIf' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: >- Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at management group scope: $ref: ./examples/PostDeploymentWhatIfOnTenant.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Whatif /providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate: post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateattenantscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Exporttemplate /providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListattenantscope description: Get all the deployments at the tenant scope. parameters: - name: $filter in: query required: false type: string description: >- The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: >- The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: 'Microsoft Azure Get Providers Microsoft Resources Deployments' /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteatmanagementgroupscope summary: 'Microsoft Azure Deletes A Deployment From The Deployment History' 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. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/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. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceatmanagementgroupscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Head Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateatmanagementgroupscope summary: 'Microsoft Azure Deploys Resources At Management Group Scope' description: >- You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: >- Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Create deployment at management group scope.: $ref: ./examples/PutDeploymentAtManagementGroup.json get: tags: - Deployments operationId: microsoftAzureDeploymentsGetatmanagementgroupscope description: Gets a deployment. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel : post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelatmanagementgroupscope summary: 'Microsoft Azure Cancels A Currently Running Template Deployment' 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. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate : post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateatmanagementgroupscope x-ms-long-running-operation: true description: >- Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: >- Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Validate ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf : post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatifatmanagementgroupscope description: >- Returns changes that will be made by the deployment if executed at the scope of the management group. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeploymentWhatIf' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: >- Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at management group scope: $ref: ./examples/PostDeploymentWhatIfOnManagementGroup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Whatif ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate : post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateatmanagementgroupscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Exporttemplate /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListatmanagementgroupscope description: Get all the deployments for a management group. parameters: - $ref: '#/parameters/GroupIdParameter' - name: $filter in: query required: false type: string description: >- The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: >- The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: >- Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteatsubscriptionscope summary: 'Microsoft Azure Deletes A Deployment From The Deployment History' 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. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/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. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceatsubscriptionscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Head Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateatsubscriptionscope summary: 'Microsoft Azure Deploys Resources At Subscription Scope' description: >- You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: >- Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Create a deployment that will deploy a templateSpec with the given resourceId: $ref: ./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json x-ms-long-running-operation: true get: tags: - Deployments operationId: microsoftAzureDeploymentsGetatsubscriptionscope description: Gets a deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel: post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelatsubscriptionscope summary: 'Microsoft Azure Cancels A Currently Running Template Deployment' 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. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate: post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateatsubscriptionscope x-ms-long-running-operation: true description: >- Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: >- Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Validate /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf: post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatifatsubscriptionscope description: >- Returns changes that will be made by the deployment if executed at the scope of the subscription. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/DeploymentWhatIf' description: Parameters to What If. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: >- Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at subscription scope: $ref: ./examples/PostDeploymentWhatIfOnSubscription.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Whatif /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate: post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateatsubscriptionscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Exporttemplate /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListatsubscriptionscope description: Get all the deployments for a subscription. parameters: - name: $filter in: query required: false type: string description: >- The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: >- The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName} : delete: tags: - Deployments operationId: microsoftAzureDeploymentsDelete summary: 'Microsoft Azure Deletes A Deployment From The Deployment History' description: >- A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. 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. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group with the deployment to delete. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/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. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistence description: Checks whether the deployment exists. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group with the deployment to check. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdate summary: 'Microsoft Azure Deploys Resources To A Resource Group' description: >- You can provide the template and parameters directly in the request or link to JSON files. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: >- Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Create a deployment that will redeploy the last successful deployment on failure: $ref: ./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json Create a deployment that will redeploy another deployment on failure: $ref: ./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json Create a deployment that will deploy a templateSpec with the given resourceId: $ref: ./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json Create a deployment that will deploy a template with a uri and queryString: $ref: ./examples/PutDeploymentResourceGroup.json x-ms-long-running-operation: true get: tags: - Deployments operationId: microsoftAzureDeploymentsGet description: Gets a deployment. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel : post: tags: - Deployments operationId: microsoftAzureDeploymentsCancel summary: 'Microsoft Azure Cancels A Currently Running Template Deployment' 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 resource group partially deployed. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate : post: tags: - Deployments operationId: microsoftAzureDeploymentsValidate x-ms-long-running-operation: true description: >- Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group the template will be deployed to. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: >- Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Validate ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf : post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatif description: >- Returns changes that will be made by the deployment if executed at the scope of the resource group. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group the template will be deployed to. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/DeploymentWhatIf' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: >- Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at resource group scope: $ref: ./examples/PostDeploymentWhatIfOnResourceGroup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Whatif ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate : post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplate description: Exports the template used for specified deployment. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Exporttemplate /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListbyresourcegroup description: Get all the deployments for a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group with the deployments to get. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: $filter in: query required: false type: string description: >- The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: >- The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister: post: tags: - Providers operationId: microsoftAzureProvidersUnregister description: Unregisters a subscription from a resource provider. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider to unregister. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Resourceprovidernamespace Unregister /providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register: post: tags: - Providers operationId: microsoftAzureProvidersRegisteratmanagementgroupscope description: >- Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider to register. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/GroupIdParameter' responses: '200': description: OK - Returns information about the resource provider. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Resourceprovidernamespace Register /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/providerPermissions: get: tags: - Providers operationId: microsoftAzureProvidersProviderpermissions description: Get the provider permissions. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information on the provider permissions. schema: $ref: '#/definitions/ProviderPermissionListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Get provider resource types.: $ref: ./examples/GetProviderPermissions.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Resourceprovidernamespace Providerpermissions /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register: post: tags: - Providers operationId: microsoftAzureProvidersRegister description: Registers a subscription with a resource provider. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider to register. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - name: properties in: body required: false schema: $ref: '#/definitions/ProviderRegistrationRequest' description: The third party consent for S2S. responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Resourceprovidernamespace Register /subscriptions/{subscriptionId}/providers: get: tags: - Providers operationId: microsoftAzureProvidersList description: Gets all resource providers for a subscription. parameters: - name: $expand in: query required: false type: string 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. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of resource providers. schema: $ref: '#/definitions/ProviderListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get providers.: $ref: ./examples/GetProviders.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers /providers: get: tags: - Providers operationId: microsoftAzureProvidersListattenantscope description: Gets all resource providers for the tenant. parameters: - name: $expand in: query required: false type: string 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of resource providers. schema: $ref: '#/definitions/ProviderListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}: get: tags: - Providers operationId: microsoftAzureProvidersGet description: Gets the specified resource provider. parameters: - name: $expand in: query required: false type: string description: >- The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Get provider.: $ref: ./examples/GetProvider.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Resourceprovidernamespace /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/resourceTypes: get: tags: - Providers operationId: microsoftAzureProviderresourcetypesList description: List the resource types for a specified resource provider. parameters: - name: $expand in: query required: false type: string description: >- The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns resource types information for the resource provider. schema: $ref: '#/definitions/ProviderResourceTypeListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Get provider resource types.: $ref: ./examples/GetProviderResourceTypes.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Resourceprovidernamespace Resourcetypes /providers/{resourceProviderNamespace}: get: tags: - Providers x-ms-examples: Get a resource provider at tenant scope: $ref: ./examples/GetNamedProviderAtTenant.json operationId: microsoftAzureProvidersGetattenantscope description: Gets the specified resource provider at the tenant level. parameters: - name: $expand in: query required: false type: string description: >- The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Providers Resourceprovidernamespace /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources: get: tags: - ResourceGroups operationId: microsoftAzureResourcesListbyresourcegroup description: Get all the resources for a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The resource group with the resources to get. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: $filter in: query required: false type: string description: >- The filter to apply on the operation.

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.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

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.

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. - name: $expand in: query required: false type: string description: >- Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. - name: $top in: query required: false type: integer format: int32 description: >- The number of results to return. If null is passed, returns all resources. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of resources schema: $ref: '#/definitions/ResourceListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/GenericResourceFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Resources /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}: head: tags: - ResourceGroups operationId: microsoftAzureResourcegroupsCheckexistence description: Checks whether a resource group exists. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group to check. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname put: tags: - ResourceGroups x-ms-examples: Create or update a resource group: $ref: ./examples/CreateResourceGroup.json operationId: microsoftAzureResourcegroupsCreateorupdate description: Creates or updates a resource group. parameters: - name: resourceGroupName in: path required: true type: string 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. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: parameters in: body required: true schema: $ref: '#/definitions/ResourceGroup' description: Parameters supplied to the create or update a resource group. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the new resource group. schema: $ref: '#/definitions/ResourceGroup' '201': description: Created - Returns information about the new resource group. schema: $ref: '#/definitions/ResourceGroup' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname delete: tags: - ResourceGroups operationId: microsoftAzureResourcegroupsDelete summary: 'Microsoft Azure Deletes A Resource Group' 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. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group to delete. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: forceDeletionTypes in: query required: false type: string description: >- The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' x-ms-examples: Force delete all the Virtual Machines in a resource group: $ref: ./examples/ForceDeleteVMsInResourceGroup.json Force delete all the Virtual Machines and Virtual Machine Scale Sets in a resource group: $ref: ./examples/ForceDeleteVMsAndVMSSInResourceGroup.json responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true get: tags: - ResourceGroups operationId: microsoftAzureResourcegroupsGet description: Gets a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group to get. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource group. schema: $ref: '#/definitions/ResourceGroup' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname patch: tags: - ResourceGroups operationId: microsoftAzureResourcegroupsUpdate summary: 'Microsoft Azure Updates A Resource Group' 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. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group to update. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: parameters in: body required: true schema: $ref: '#/definitions/ResourceGroupPatchable' description: Parameters supplied to update a resource group. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource group. schema: $ref: '#/definitions/ResourceGroup' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate: post: tags: - ResourceGroups operationId: microsoftAzureResourcegroupsExporttemplate description: Captures the specified resource group as a template. parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/ExportTemplateRequest' description: Parameters for exporting the template. x-ms-examples: Export a resource group: $ref: ./examples/ExportResourceGroup.json Export a resource group with filtering: $ref: ./examples/ExportResourceGroupWithFiltering.json responses: '200': description: OK - Returns the result of the export. schema: $ref: '#/definitions/ResourceGroupExportResult' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Exporttemplate /subscriptions/{subscriptionId}/resourcegroups: get: tags: - ResourceGroups operationId: microsoftAzureResourcegroupsList description: Gets all the resource groups for a subscription. parameters: - name: $filter in: query required: false type: string description: >- The filter to apply on the operation.

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' - name: $top in: query required: false type: integer format: int32 description: >- The number of results to return. If null is passed, returns all resource groups. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of resource groups. schema: $ref: '#/definitions/ResourceGroupListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/ResourceGroupFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources: post: tags: - Resources operationId: microsoftAzureResourcesMoveresources summary: 'Microsoft Azure Moves Resources From One Resource Group To Another Resource Group' description: >- The resources to be moved must be in the same source resource group in the source subscription being used. 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. parameters: - name: sourceResourceGroupName in: path required: true type: string description: >- The name of the resource group from the source subscription containing the resources to be moved. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: parameters in: body required: true schema: $ref: '#/definitions/ResourcesMoveInfo' description: Parameters for moving resources. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources: post: tags: - Resources operationId: microsoftAzureResourcesValidatemoveresources summary: >- Microsoft Azure Validates Whether Resources Can Be Moved From One Resource Group To Another Resource Group description: >- This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. 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. parameters: - name: sourceResourceGroupName in: path required: true type: string description: >- The name of the resource group from the source subscription containing the resources to be validated for move. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: parameters in: body required: true schema: $ref: '#/definitions/ResourcesMoveInfo' description: Parameters for moving resources. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resources: get: tags: - Resources operationId: microsoftAzureResourcesList description: Get all the resources in a subscription. parameters: - name: $filter in: query required: false type: string description: >- The filter to apply on the operation.

Filter comparison operators include `eq` (equals) and `ne` (not equals) and may be used with the following properties: `location`, `resourceType`, `name`, `resourceGroup`, `identity`, `identity/principalId`, `plan`, `plan/publisher`, `plan/product`, `plan/name`, `plan/version`, and `plan/promotionCode`.

For example, to filter by a resource type, use `$filter=resourceType eq 'Microsoft.Network/virtualNetworks'`


`substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup`

For example, to get all resources with 'demo' anywhere in the resource name, use `$filter=substringof('demo', name)`

Multiple substring operations can also be combined using `and`/`or` operators.

Note that any truncated number of results queried via `$top` may also not be compatible when using a filter.


Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use `$filter=tagName eq 'tag1' and tagValue eq 'Value1'`. Note that when resources are filtered by tag name and value, the original tags for each resource will not be returned in the results. Any list of additional properties queried via `$expand` may also not be compatible when filtering by tag names/values.

For tag names only, resources can be filtered by prefix using the following syntax: `$filter=startswith(tagName, 'depart')`. This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.)


Note that some properties can be combined when filtering resources, which include the following: `substringof() and/or resourceType`, `plan and plan/publisher and plan/name`, and `identity and identity/principalId`. - name: $expand in: query required: false type: string description: >- Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. - name: $top in: query required: false type: integer format: int32 description: >- The number of recommendations per page if a paged version of this API is being used. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of resources. schema: $ref: '#/definitions/ResourceListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/GenericResourceFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resources ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName} : head: tags: - Resources operationId: microsoftAzureResourcesCheckexistence description: Checks whether a resource exists. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group containing the resource to check. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: resourceProviderNamespace in: path required: true type: string description: The resource provider of the resource to check. - name: parentResourcePath in: path required: true type: string description: The parent resource identity. x-ms-skip-url-encoding: true - name: resourceType in: path required: true type: string description: The resource type. x-ms-skip-url-encoding: true - name: resourceName in: path required: true type: string description: The name of the resource to check whether it exists. - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename delete: tags: - Resources operationId: microsoftAzureResourcesDelete description: Deletes a resource. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group that contains the resource to delete. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - name: parentResourcePath in: path required: true type: string description: The parent resource identity. x-ms-skip-url-encoding: true - name: resourceType in: path required: true type: string description: The resource type. x-ms-skip-url-encoding: true - name: resourceName in: path required: true type: string description: The name of the resource to delete. - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename put: tags: - Resources operationId: microsoftAzureResourcesCreateorupdate description: Creates a resource. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group for the resource. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - name: parentResourcePath in: path required: true type: string description: The parent resource identity. x-ms-skip-url-encoding: true - name: resourceType in: path required: true type: string description: The resource type of the resource to create. x-ms-skip-url-encoding: true - name: resourceName in: path required: true type: string description: The name of the resource to create. - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - name: parameters in: body required: true schema: $ref: '#/definitions/GenericResource' description: Parameters for creating or updating the resource. - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' '201': description: Created - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename patch: tags: - Resources operationId: microsoftAzureResourcesUpdate description: Updates a resource. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group for the resource. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - name: parentResourcePath in: path required: true type: string description: The parent resource identity. x-ms-skip-url-encoding: true - name: resourceType in: path required: true type: string description: The resource type of the resource to update. x-ms-skip-url-encoding: true - name: resourceName in: path required: true type: string description: The name of the resource to update. - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - name: parameters in: body required: true schema: $ref: '#/definitions/GenericResource' description: Parameters for updating the resource. - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename get: tags: - Resources operationId: microsoftAzureResourcesGet description: Gets a resource. parameters: - name: resourceGroupName in: path required: true type: string description: >- The name of the resource group containing the resource to get. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - name: parentResourcePath in: path required: true type: string description: The parent resource identity. x-ms-skip-url-encoding: true - name: resourceType in: path required: true type: string description: The resource type of the resource. x-ms-skip-url-encoding: true - name: resourceName in: path required: true type: string description: The name of the resource to get. - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename /{resourceId}: head: tags: - Resources operationId: microsoftAzureResourcesCheckexistencebyid description: >- Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource. parameters: - name: resourceId in: path required: true type: string description: >- The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} x-ms-skip-url-encoding: true - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Resourceid delete: tags: - Resources operationId: microsoftAzureResourcesDeletebyid description: Deletes a resource by ID. parameters: - name: resourceId in: path required: true type: string description: >- The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} x-ms-skip-url-encoding: true - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: Microsoft Azure Delete Resourceid put: tags: - Resources operationId: microsoftAzureResourcesCreateorupdatebyid description: Create a resource by ID. parameters: - name: resourceId in: path required: true type: string description: >- The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} x-ms-skip-url-encoding: true - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - name: parameters in: body required: true schema: $ref: '#/definitions/GenericResource' description: Create or update resource parameters. responses: '200': description: OK - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' '201': description: Created - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: Microsoft Azure Put Resourceid patch: tags: - Resources operationId: microsoftAzureResourcesUpdatebyid description: Updates a resource by ID. parameters: - name: resourceId in: path required: true type: string description: >- The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} x-ms-skip-url-encoding: true - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false - name: parameters in: body required: true schema: $ref: '#/definitions/GenericResource' description: Update resource parameters. responses: '200': description: OK - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: Microsoft Azure Patch Resourceid get: tags: - Resources operationId: microsoftAzureResourcesGetbyid description: Gets a resource by ID. parameters: - name: resourceId in: path required: true type: string description: >- The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} x-ms-skip-url-encoding: true - name: api-version in: query required: true type: string description: The API version to use for the operation. x-ms-api-version: false responses: '200': description: OK - Returns information about the resource. schema: $ref: '#/definitions/GenericResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Resourceid /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}: delete: tags: [] operationId: microsoftAzureTagsDeletevalue summary: 'Microsoft Azure Deletes A Predefined Tag Value For A Predefined Tag Name' description: >- This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource. parameters: - name: tagName in: path required: true type: string description: The name of the tag. - name: tagValue in: path required: true type: string description: The value of the tag to delete. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Predefined tag value successfully deleted. '204': description: Predefined tag value did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' put: tags: [] operationId: microsoftAzureTagsCreateorupdatevalue summary: 'Microsoft Azure Creates A Predefined Value For A Predefined Tag Name' description: >- This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters. parameters: - name: tagName in: path required: true type: string description: The name of the tag. - name: tagValue in: path required: true type: string description: The value of the tag to create. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- Predefined tag value already exists. Returns information about the predefined tag value. schema: $ref: '#/definitions/TagValue' '201': description: >- Predefined tag value successfully created. Returns information about the predefined tag value. schema: $ref: '#/definitions/TagValue' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /subscriptions/{subscriptionId}/tagNames/{tagName}: put: tags: [] operationId: microsoftAzureTagsCreateorupdate summary: 'Microsoft Azure Creates A Predefined Tag Name' description: >- This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'. parameters: - name: tagName in: path required: true type: string description: The name of the tag to create. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- Predefined tag name already exists. Returns information about the predefined tag name. schema: $ref: '#/definitions/TagDetails' '201': description: >- Predefined tag name successfully created. Returns information about the predefined tag name. schema: $ref: '#/definitions/TagDetails' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' delete: tags: [] operationId: microsoftAzureTagsDelete summary: 'Microsoft Azure Deletes A Predefined Tag Name' description: >- This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted. parameters: - name: tagName in: path required: true type: string description: The name of the tag. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Predefined tag name successfully deleted. '204': description: Predefined tag name did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /subscriptions/{subscriptionId}/tagNames: get: tags: [] operationId: microsoftAzureTagsList summary: 'Microsoft Azure Gets A Summary Of Tag Usage Under The Subscription' description: >- This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result. parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of tag names and values. schema: $ref: '#/definitions/TagsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsGetatscope description: Gets a deployments operation. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: operationId in: path required: true type: string description: The ID of the operation to get. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment operation. schema: $ref: '#/definitions/DeploymentOperation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Scope Providers Microsoft Resources Deployments Deploymentname Operations Operationid /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsListatscope description: Gets all deployments operations for a deployment. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: $top in: query required: false type: integer format: int32 description: The number of results to return. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Return an array of deployment operations. schema: $ref: '#/definitions/DeploymentOperationsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Scope Providers Microsoft Resources Deployments Deploymentname Operations /providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsGetattenantscope description: Gets a deployments operation. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: operationId in: path required: true type: string description: The ID of the operation to get. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment operation. schema: $ref: '#/definitions/DeploymentOperation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Providers Microsoft Resources Deployments Deploymentname Operations Operationid /providers/Microsoft.Resources/deployments/{deploymentName}/operations: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsListattenantscope description: Gets all deployments operations for a deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: $top in: query required: false type: integer format: int32 description: The number of results to return. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Return an array of deployment operations. schema: $ref: '#/definitions/DeploymentOperationsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Resources Deployments Deploymentname Operations ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId} : get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsGetatmanagementgroupscope description: Gets a deployments operation. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: operationId in: path required: true type: string description: The ID of the operation to get. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment operation. schema: $ref: '#/definitions/DeploymentOperation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Operations Operationid ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations : get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsListatmanagementgroupscope description: Gets all deployments operations for a deployment. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: $top in: query required: false type: integer format: int32 description: The number of results to return. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Return an array of deployment operations. schema: $ref: '#/definitions/DeploymentOperationsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Operations /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsGetatsubscriptionscope description: Gets a deployments operation. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: operationId in: path required: true type: string description: The ID of the operation to get. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the deployment operation. schema: $ref: '#/definitions/DeploymentOperation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Operations Operationid /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsListatsubscriptionscope description: Gets all deployments operations for a deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: $top in: query required: false type: integer format: int32 description: The number of results to return. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Return an array of deployment operations. schema: $ref: '#/definitions/DeploymentOperationsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Operations /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsGet description: Gets a deployments operation. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: operationId in: path required: true type: string description: The ID of the operation to get. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the deployment operation. schema: $ref: '#/definitions/DeploymentOperation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Deployments Deploymentname Operations Operationid /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations: get: tags: - DeploymentOperations operationId: microsoftAzureDeploymentoperationsList description: Gets all deployments operations for a deployment. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: $top in: query required: false type: integer format: int32 description: The number of results to return. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Return an array of deployment operations. schema: $ref: '#/definitions/DeploymentOperationsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Deployments Deploymentname Operations /providers/Microsoft.Resources/calculateTemplateHash: post: tags: - Deployments operationId: microsoftAzureDeploymentsCalculatetemplatehash description: Calculate the hash of the given template. parameters: - $ref: '#/parameters/ApiVersionParameter' - name: template in: body required: true schema: type: object description: The template provided to calculate hash. x-ms-examples: Calculate template hash: $ref: ./examples/CalculateTemplateHash.json responses: '200': description: OK - Returns the hash. schema: $ref: '#/definitions/TemplateHashResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Resources Calculatetemplatehash /{scope}/providers/Microsoft.Resources/tags/default: put: tags: [] operationId: microsoftAzureTagsCreateorupdateatscope summary: 'Microsoft Azure Creates Or Updates The Entire Set Of Tags On A Resource Or Subscription' description: >- This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/TagsResource' responses: '200': description: Tags updated successfully. Returns tags from the specified object. schema: $ref: '#/definitions/TagsResource' '202': headers: Location: type: string description: URL to get status of this long-running operation. description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Update tags on a resource: $ref: ./examples/PutTagsResource.json Update tags on a subscription: $ref: ./examples/PutTagsSubscription.json patch: tags: [] operationId: microsoftAzureTagsUpdateatscope summary: 'Microsoft Azure Selectively Updates The Set Of Tags On A Resource Or Subscription' description: >- This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/TagsPatchResource' responses: '200': description: Tags updated successfully. Returns tags from the specified object. schema: $ref: '#/definitions/TagsResource' '202': headers: Location: type: string description: URL to get status of this long-running operation. description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Update tags on a resource: $ref: ./examples/PatchTagsResource.json Update tags on a subscription: $ref: ./examples/PatchTagsSubscription.json get: tags: [] operationId: microsoftAzureTagsGetatscope summary: 'Microsoft Azure Gets The Entire Set Of Tags On A Resource Or Subscription' parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Returns tags from the specified object. schema: $ref: '#/definitions/TagsResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Get tags on a resource: $ref: ./examples/GetTagsResource.json Get tags on a subscription: $ref: ./examples/GetTagsSubscription.json description: Needs a more full description created. delete: tags: [] operationId: microsoftAzureTagsDeleteatscope summary: 'Microsoft Azure Deletes The Entire Set Of Tags On A Resource Or Subscription' parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Tags successfully deleted. '202': headers: Location: type: string description: URL to get status of this long-running operation. description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Update tags on a resource: $ref: ./examples/DeleteTagsResource.json Update tags on a subscription: $ref: ./examples/DeleteTagsSubscription.json description: Needs a more full description created. definitions: DeploymentExtendedFilter: properties: provisioningState: type: string description: The provisioning state. description: Deployment filter. GenericResourceFilter: properties: resourceType: type: string description: The resource type. tagname: type: string description: The tag name. tagvalue: type: string description: The tag value. description: Resource filter. ResourceGroupFilter: properties: tagName: type: string description: The tag name. tagValue: type: string description: The tag value. description: Resource group filter. TemplateLink: properties: uri: type: string description: >- The URI of the template to deploy. Use either the uri or id property, but not both. id: type: string description: >- The resource id of a Template Spec. Use either the id or uri property, but not both. relativePath: type: string description: >- The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs contentVersion: type: string description: If included, must match the ContentVersion in the template. queryString: type: string description: >- The query string (for example, a SAS token) to be used with the templateLink URI. description: Entity representing the reference to the template. ParametersLink: properties: uri: type: string description: The URI of the parameters file. contentVersion: type: string description: If included, must match the ContentVersion in the template. required: - uri description: Entity representing the reference to the deployment parameters. DeploymentProperties: properties: template: type: object description: >- The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. templateLink: $ref: '#/definitions/TemplateLink' description: >- The URI of the template. Use either the templateLink property or the template property, but not both. parameters: type: object additionalProperties: $ref: '#/definitions/DeploymentParameter' description: >- Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. parametersLink: $ref: '#/definitions/ParametersLink' description: >- The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. mode: type: string description: >- The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. enum: - Incremental - Complete x-ms-enum: name: DeploymentMode modelAsString: false debugSetting: $ref: '#/definitions/DebugSetting' description: The debug setting of the deployment. onErrorDeployment: $ref: '#/definitions/OnErrorDeployment' description: The deployment on error behavior. expressionEvaluationOptions: $ref: '#/definitions/ExpressionEvaluationOptions' description: >- Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. required: - mode description: Deployment properties. DeploymentParameter: type: object properties: value: description: Input value to the parameter . reference: $ref: '#/definitions/KeyVaultParameterReference' description: Azure Key Vault parameter reference. description: Deployment parameter for the template. KeyVaultParameterReference: type: object properties: keyVault: $ref: '#/definitions/KeyVaultReference' description: Azure Key Vault reference. secretName: type: string description: Azure Key Vault secret name. secretVersion: type: string description: Azure Key Vault secret version. required: - keyVault - secretName description: Azure Key Vault parameter reference. KeyVaultReference: type: object properties: id: type: string description: Azure Key Vault resource id. required: - id description: Azure Key Vault reference. DebugSetting: properties: detailLevel: type: string description: >- Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. description: The debug setting. Deployment: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentProperties' description: The deployment properties. tags: type: object additionalProperties: type: string description: Deployment tags required: - properties description: Deployment operation parameters. ScopedDeployment: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentProperties' description: The deployment properties. tags: type: object additionalProperties: type: string description: Deployment tags required: - location - properties description: Deployment operation parameters. DeploymentExportResult: properties: template: type: object description: The template content. description: 'The deployment export result. ' DeploymentWhatIf: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentWhatIfProperties' description: The deployment properties. required: - properties description: Deployment What-if operation parameters. ScopedDeploymentWhatIf: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentWhatIfProperties' description: The deployment properties. required: - location - properties description: Deployment What-if operation parameters. DeploymentWhatIfProperties: properties: whatIfSettings: $ref: '#/definitions/DeploymentWhatIfSettings' description: Optional What-If operation settings. allOf: - $ref: '#/definitions/DeploymentProperties' description: Deployment What-if properties. DeploymentWhatIfSettings: properties: resultFormat: type: string description: The format of the What-If results enum: - ResourceIdOnly - FullResourcePayloads x-ms-enum: name: WhatIfResultFormat modelAsString: false description: Deployment What-If operation settings. CloudError: x-ms-external: true properties: error: $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: An error response for a resource management request. ApiProfile: properties: profileVersion: type: string readOnly: true description: The profile version. apiVersion: type: string readOnly: true description: The API version. AliasPathMetadata: properties: type: type: string readOnly: true enum: - NotSpecified - Any - String - Object - Array - Integer - Number - Boolean x-ms-enum: name: AliasPathTokenType modelAsString: true values: - value: NotSpecified description: The token type is not specified. - value: Any description: The token type can be anything. - value: String description: The token type is string. - value: Object description: The token type is object. - value: Array description: The token type is array. - value: Integer description: The token type is integer. - value: Number description: The token type is number. - value: Boolean description: The token type is boolean. description: The type of the token that the alias path is referring to. attributes: type: string readOnly: true enum: - None - Modifiable x-ms-enum: name: AliasPathAttributes modelAsString: true values: - value: None description: The token that the alias path is referring to has no attributes. - value: Modifiable description: >- The token that the alias path is referring to is modifiable by policies with 'modify' effect. description: The attributes of the token that the alias path is referring to. AliasPath: properties: path: type: string description: The path of an alias. apiVersions: type: array items: type: string description: The API versions. pattern: $ref: '#/definitions/AliasPattern' description: The pattern for an alias path. metadata: readOnly: true $ref: '#/definitions/AliasPathMetadata' description: >- The metadata of the alias path. If missing, fall back to the default metadata of the alias. description: The type of the paths for alias. AliasPattern: properties: phrase: type: string description: The alias pattern phrase. variable: type: string description: The alias pattern variable. type: type: string enum: - NotSpecified - Extract x-ms-enum: name: AliasPatternType modelAsString: false values: - value: NotSpecified description: NotSpecified is not allowed. - value: Extract description: Extract is the only allowed value. description: The type of alias pattern description: The type of the pattern for an alias path. Alias: properties: name: type: string description: The alias name. paths: type: array items: $ref: '#/definitions/AliasPath' x-ms-identifiers: [] description: The paths for an alias. type: type: string description: The type of the alias. enum: - NotSpecified - PlainText - Mask x-ms-enum: name: AliasType modelAsString: false values: - value: NotSpecified description: Alias type is unknown (same as not providing alias type). - value: PlainText description: Alias value is not secret. - value: Mask description: Alias value is secret. defaultPath: type: string description: The default path for an alias. defaultPattern: $ref: '#/definitions/AliasPattern' description: The default pattern for an alias. defaultMetadata: readOnly: true $ref: '#/definitions/AliasPathMetadata' description: >- The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata description: 'The alias type. ' ProviderExtendedLocation: properties: location: type: string description: The azure location. type: type: string description: The extended location type. extendedLocations: type: array items: type: string description: The extended locations for the azure location. description: 'The provider extended location. ' ProviderResourceType: properties: resourceType: type: string description: The resource type. locations: type: array items: type: string description: The collection of locations where this resource type can be created. locationMappings: type: array items: $ref: '#/definitions/ProviderExtendedLocation' x-ms-identifiers: - location - type description: The location mappings that are supported by this resource type. aliases: type: array items: $ref: '#/definitions/Alias' x-ms-identifiers: - name description: The aliases that are supported by this resource type. apiVersions: type: array items: type: string description: The API version. defaultApiVersion: type: string readOnly: true description: The default API version. zoneMappings: type: array items: $ref: '#/definitions/ZoneMapping' x-ms-identifiers: - location apiProfiles: type: array readOnly: true items: $ref: '#/definitions/ApiProfile' x-ms-identifiers: - apiVersion - profileVersion description: The API profiles for the resource provider. capabilities: type: string description: The additional capabilities offered by this resource type. properties: type: object additionalProperties: type: string description: 'The additional properties. ' description: The properties. description: Resource type managed by the resource provider. Provider: properties: id: readOnly: true type: string description: The provider ID. namespace: type: string description: The namespace of the resource provider. registrationState: readOnly: true type: string description: The registration state of the resource provider. registrationPolicy: readOnly: true type: string description: The registration policy of the resource provider. resourceTypes: readOnly: true type: array items: $ref: '#/definitions/ProviderResourceType' x-ms-identifiers: - resourceType description: The collection of provider resource types. providerAuthorizationConsentState: type: string enum: - NotSpecified - Required - NotRequired - Consented description: The provider authorization consent state. x-ms-enum: name: ProviderAuthorizationConsentState modelAsString: true description: Resource provider information. BasicDependency: properties: id: type: string description: The ID of the dependency. resourceType: type: string description: The dependency resource type. resourceName: type: string description: The dependency resource name. description: Deployment dependency information. Dependency: properties: dependsOn: type: array items: $ref: '#/definitions/BasicDependency' description: The list of dependencies. id: type: string description: The ID of the dependency. resourceType: type: string description: The dependency resource type. resourceName: type: string description: The dependency resource name. description: Deployment dependency information. DeploymentPropertiesExtended: properties: provisioningState: type: string readOnly: true description: Denotes the state of provisioning. enum: - NotSpecified - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Updating x-ms-enum: name: ProvisioningState modelAsString: true correlationId: readOnly: true type: string description: The correlation ID of the deployment. timestamp: readOnly: true type: string format: date-time description: The timestamp of the template deployment. duration: readOnly: true type: string description: The duration of the template deployment. outputs: readOnly: true type: object description: Key/value pairs that represent deployment output. providers: readOnly: true type: array items: $ref: '#/definitions/Provider' description: The list of resource providers needed for the deployment. dependencies: readOnly: true type: array items: $ref: '#/definitions/Dependency' description: The list of deployment dependencies. templateLink: readOnly: true $ref: '#/definitions/TemplateLink' description: The URI referencing the template. parameters: readOnly: true type: object description: 'Deployment parameters. ' parametersLink: readOnly: true $ref: '#/definitions/ParametersLink' description: 'The URI referencing the parameters. ' mode: readOnly: true type: string description: The deployment mode. Possible values are Incremental and Complete. enum: - Incremental - Complete x-ms-enum: name: DeploymentMode modelAsString: false debugSetting: readOnly: true $ref: '#/definitions/DebugSetting' description: The debug setting of the deployment. onErrorDeployment: readOnly: true $ref: '#/definitions/OnErrorDeploymentExtended' description: The deployment on error behavior. templateHash: readOnly: true type: string description: The hash produced for the template. outputResources: readOnly: true type: array description: Array of provisioned resources. items: $ref: '#/definitions/ResourceReference' description: Details of provisioned resources. validatedResources: readOnly: true type: array description: Array of validated resources. items: $ref: '#/definitions/ResourceReference' description: Details of validated resources. error: readOnly: true $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: The deployment error. description: Deployment properties with additional details. ResourceReference: description: The resource Id model. properties: id: readOnly: true type: string description: The fully qualified resource Id. OnErrorDeployment: properties: type: type: string description: >- The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. enum: - LastSuccessful - SpecificDeployment x-ms-enum: name: OnErrorDeploymentType modelAsString: false deploymentName: type: string description: The deployment to be used on error case. description: Deployment on error behavior. OnErrorDeploymentExtended: properties: provisioningState: readOnly: true type: string description: The state of the provisioning for the on error deployment. type: type: string description: >- The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. enum: - LastSuccessful - SpecificDeployment x-ms-enum: name: OnErrorDeploymentType modelAsString: false deploymentName: type: string description: The deployment to be used on error case. description: Deployment on error behavior with additional details. DeploymentValidateResult: properties: error: readOnly: true $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: The deployment validation error. properties: $ref: '#/definitions/DeploymentPropertiesExtended' description: The template deployment properties. description: Information from validate template deployment response. DeploymentExtended: properties: id: readOnly: true type: string description: The ID of the deployment. name: readOnly: true type: string description: The name of the deployment. type: readOnly: true type: string description: The type of the deployment. location: type: string description: the location of the deployment. properties: $ref: '#/definitions/DeploymentPropertiesExtended' description: Deployment properties. tags: type: object additionalProperties: type: string description: Deployment tags x-ms-azure-resource: true description: Deployment information. DeploymentListResult: properties: value: type: array items: $ref: '#/definitions/DeploymentExtended' description: An array of deployments. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of deployments. ProviderListResult: properties: value: type: array items: $ref: '#/definitions/Provider' description: An array of resource providers. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of resource providers. ProviderResourceTypeListResult: properties: value: type: array items: $ref: '#/definitions/ProviderResourceType' x-ms-identifiers: - resourceType description: An array of resource types. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of resource types of a resource provider. GenericResource: properties: plan: $ref: '#/definitions/Plan' description: The plan of the resource. properties: type: object description: The resource properties. kind: type: string description: The kind of the resource. pattern: ^[-\w\._,\(\)]+$ managedBy: type: string description: ID of the resource that manages this resource. sku: $ref: '#/definitions/Sku' description: The SKU of the resource. identity: $ref: '#/definitions/Identity' description: The identity of the resource. allOf: - $ref: '#/definitions/Resource' description: Resource information. ExtendedLocation: properties: type: type: string enum: - EdgeZone x-ms-enum: name: ExtendedLocationType modelAsString: true description: The extended location type. name: type: string description: The extended location name. description: Resource extended location. GenericResourceExpanded: properties: createdTime: readOnly: true type: string format: date-time description: >- The created time of the resource. This is only present if requested via the $expand query parameter. changedTime: readOnly: true type: string format: date-time description: >- The changed time of the resource. This is only present if requested via the $expand query parameter. provisioningState: readOnly: true type: string description: >- The provisioning state of the resource. This is only present if requested via the $expand query parameter. allOf: - $ref: '#/definitions/GenericResource' description: Resource information. Plan: properties: name: type: string description: The plan ID. publisher: type: string description: The publisher ID. product: type: string description: The offer ID. promotionCode: type: string description: The promotion code. version: type: string description: The plan's version. description: Plan for the resource. Sku: properties: name: type: string description: The SKU name. tier: type: string description: The SKU tier. size: type: string description: The SKU size. family: type: string description: The SKU family. model: type: string description: The SKU model. capacity: type: integer format: int32 description: The SKU capacity. description: SKU for the resource. Identity: properties: principalId: readOnly: true type: string description: The principal ID of resource identity. tenantId: readOnly: true type: string description: The tenant ID of resource. type: type: string description: The identity type. enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ResourceIdentityType modelAsString: false userAssignedIdentities: type: object additionalProperties: type: object x-ms-client-name: IdentityUserAssignedIdentitiesValue properties: principalId: readOnly: true type: string description: The principal id of user assigned identity. clientId: readOnly: true type: string description: The client id of user assigned identity. description: >- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. description: Identity for the resource. ResourceListResult: properties: value: type: array items: $ref: '#/definitions/GenericResourceExpanded' description: An array of resources. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of resource groups. ResourceGroup: properties: id: readOnly: true type: string description: The ID of the resource group. name: readOnly: true type: string description: The name of the resource group. type: readOnly: true type: string description: The type of the resource group. properties: $ref: '#/definitions/ResourceGroupProperties' description: The resource group properties. location: type: string description: >- The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. managedBy: type: string description: The ID of the resource that manages this resource group. tags: type: object additionalProperties: type: string description: 'The additional properties. ' description: The tags attached to the resource group. required: - location x-ms-azure-resource: true description: Resource group information. ResourceGroupPatchable: properties: name: type: string description: The name of the resource group. properties: $ref: '#/definitions/ResourceGroupProperties' description: The resource group properties. managedBy: type: string description: The ID of the resource that manages this resource group. tags: type: object additionalProperties: type: string description: 'The additional properties. ' description: The tags attached to the resource group. description: Resource group information. ResourceGroupProperties: properties: provisioningState: readOnly: true type: string description: 'The provisioning state. ' description: The resource group properties. ResourceGroupListResult: properties: value: type: array items: $ref: '#/definitions/ResourceGroup' description: An array of resource groups. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of resource groups. ResourcesMoveInfo: properties: resources: type: array items: type: string description: The IDs of the resources. targetResourceGroup: type: string description: The target resource group. description: Parameters of move resources. ExportTemplateRequest: properties: resources: type: array items: type: string description: >- The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'. options: type: string description: >- The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization' description: Export resource group template request parameters. TagCount: properties: type: type: string description: Type of count. value: type: integer description: Value of count. description: Tag count. TagValue: properties: id: readOnly: true type: string description: The tag value ID. tagValue: type: string description: The tag value. count: $ref: '#/definitions/TagCount' description: The tag value count. x-ms-azure-resource: true description: Tag information. TagDetails: properties: id: readOnly: true type: string description: The tag name ID. tagName: type: string description: The tag name. count: $ref: '#/definitions/TagCount' description: >- The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. values: type: array items: $ref: '#/definitions/TagValue' description: The list of tag values. x-ms-azure-resource: true description: Tag details. TagsListResult: properties: value: type: array items: $ref: '#/definitions/TagDetails' description: An array of tags. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of subscription tags. TargetResource: properties: id: type: string description: The ID of the resource. resourceName: type: string description: The name of the resource. resourceType: type: string description: The type of the resource. description: Target resource. HttpMessage: properties: content: type: object description: HTTP message content. description: HTTP message. DeploymentOperationProperties: properties: provisioningOperation: readOnly: true type: string description: The name of the current provisioning operation. enum: - NotSpecified - Create - Delete - Waiting - AzureAsyncOperationWaiting - ResourceCacheWaiting - Action - Read - EvaluateDeploymentOutput - DeploymentCleanup x-ms-enum: name: ProvisioningOperation modelAsString: false values: - value: NotSpecified description: The provisioning operation is not specified. - value: Create description: The provisioning operation is create. - value: Delete description: The provisioning operation is delete. - value: Waiting description: The provisioning operation is waiting. - value: AzureAsyncOperationWaiting description: The provisioning operation is waiting Azure async operation. - value: ResourceCacheWaiting description: The provisioning operation is waiting for resource cache. - value: Action description: The provisioning operation is action. - value: Read description: The provisioning operation is read. - value: EvaluateDeploymentOutput description: The provisioning operation is evaluate output. - value: DeploymentCleanup description: >- The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. provisioningState: readOnly: true type: string description: The state of the provisioning. timestamp: readOnly: true type: string format: date-time description: The date and time of the operation. duration: readOnly: true type: string description: The duration of the operation. serviceRequestId: readOnly: true type: string description: Deployment operation service request id. statusCode: readOnly: true type: string description: >- Operation status code from the resource provider. This property may not be set if a response has not yet been received. statusMessage: readOnly: true description: >- Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. $ref: '#/definitions/StatusMessage' targetResource: readOnly: true $ref: '#/definitions/TargetResource' description: The target resource. request: readOnly: true $ref: '#/definitions/HttpMessage' description: The HTTP request message. response: readOnly: true $ref: '#/definitions/HttpMessage' description: The HTTP response message. description: Deployment operation properties. DeploymentOperation: properties: id: readOnly: true type: string description: Full deployment operation ID. operationId: readOnly: true type: string description: Deployment operation ID. properties: $ref: '#/definitions/DeploymentOperationProperties' description: Deployment properties. description: Deployment operation information. DeploymentOperationsListResult: properties: value: type: array items: $ref: '#/definitions/DeploymentOperation' description: An array of deployment operations. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of deployment operations. ResourceProviderOperationDisplayProperties: properties: publisher: type: string description: Operation description. provider: type: string description: Operation provider. resource: type: string description: Operation resource. operation: type: string description: Resource provider operation. description: type: string description: Operation description. description: Resource provider operation's display properties. Resource: properties: id: readOnly: true type: string description: Resource ID name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type location: type: string description: Resource location extendedLocation: $ref: '#/definitions/ExtendedLocation' x-ms-mutability: - read - create description: Resource extended location. tags: type: object additionalProperties: type: string description: Resource tags x-ms-azure-resource: true description: Specified resource. SubResource: properties: id: type: string description: Resource ID x-ms-azure-resource: true description: Sub-resource. ResourceGroupExportResult: properties: template: type: object description: The template content. error: $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: The template export error. description: Resource group export result. Operation: description: Microsoft.Resources operation type: object properties: name: description: 'Operation name: {provider}/{resource}/{operation}' type: string display: description: The object that represents the operation. properties: provider: description: 'Service provider: Microsoft.Resources' type: string resource: description: >- Resource on which the operation is performed: Profile, endpoint, etc. type: string operation: description: 'Operation type: Read, write, delete, etc.' type: string description: description: Description of the operation. type: string OperationListResult: description: >- Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results. properties: value: type: array items: $ref: '#/definitions/Operation' x-ms-identifiers: - name description: List of Microsoft.Resources operations. nextLink: type: string description: URL to get the next set of operation list results if there are any. TemplateHashResult: description: >- Result of the request to calculate template hash. It contains a string of minified template and its hash. properties: minifiedTemplate: type: string description: The minified template string. templateHash: type: string description: The template hash. WhatIfPropertyChange: required: - path - propertyChangeType properties: path: type: string description: The path of the property. propertyChangeType: type: string description: The type of property change. enum: - Create - Delete - Modify - Array - NoEffect x-ms-enum: name: PropertyChangeType modelAsString: false values: - value: Create description: >- The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. - value: Delete description: >- The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. - value: Modify description: >- The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. - value: Array description: The property is an array and contains nested changes. - value: NoEffect description: The property will not be set or updated. before: type: object description: The value of the property before the deployment is executed. after: type: object description: The value of the property after the deployment is executed. children: type: array items: $ref: '#/definitions/WhatIfPropertyChange' x-ms-identifiers: - path description: Nested property changes. description: The predicted change to the resource property. WhatIfChange: description: Information about a single resource change predicted by What-If operation. required: - resourceId - changeType properties: resourceId: type: string description: Resource ID changeType: type: string description: >- Type of change that will be made to the resource when the deployment is executed. enum: - Create - Delete - Ignore - Deploy - NoChange - Modify - Unsupported x-ms-enum: name: ChangeType modelAsString: false values: - value: Create description: >- The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. - value: Delete description: >- The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. - value: Ignore description: >- The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. - value: Deploy description: >- The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. - value: NoChange description: >- The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. - value: Modify description: >- The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. - value: Unsupported description: The resource is not supported by What-If. unsupportedReason: type: string description: The explanation about why the resource is unsupported by What-If. before: type: object description: The snapshot of the resource before the deployment is executed. after: type: object description: >- The predicted snapshot of the resource after the deployment is executed. delta: type: array items: $ref: '#/definitions/WhatIfPropertyChange' x-ms-identifiers: - path description: The predicted changes to resource properties. WhatIfOperationProperties: description: Deployment operation properties. properties: changes: type: array items: $ref: '#/definitions/WhatIfChange' x-ms-identifiers: - resourceId - changeType description: List of resource changes predicted by What-If operation. WhatIfOperationResult: description: >- Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results. properties: status: type: string description: Status of the What-If operation. properties: x-ms-client-flatten: true $ref: '#/definitions/WhatIfOperationProperties' description: What-If operation properties. error: $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: Error when What-If operation fails. Tags: description: A dictionary of name and value pairs. properties: tags: type: object additionalProperties: type: string description: The tag value. TagsPatchResource: type: object description: Wrapper resource for tags patch API request only. properties: operation: type: string description: The operation type for the patch API. enum: - Replace - Merge - Delete x-ms-enum: name: tagsPatchOperation modelAsString: true values: - value: Replace description: >- The 'replace' option replaces the entire set of existing tags with a new set. - value: Merge description: >- The 'merge' option allows adding tags with new names and updating the values of tags with existing names. - value: Delete description: >- The 'delete' option allows selectively deleting tags based on given names or name/value pairs. properties: $ref: '#/definitions/Tags' description: The set of tags. TagsResource: type: object description: Wrapper resource for tags API requests and responses. required: - properties properties: id: readOnly: true type: string description: The ID of the tags wrapper resource. name: readOnly: true type: string description: The name of the tags wrapper resource. type: readOnly: true type: string description: The type of the tags wrapper resource. properties: $ref: '#/definitions/Tags' description: The set of tags. x-ms-azure-resource: true Permission: type: object readOnly: true properties: actions: type: array items: type: string description: Allowed actions. notActions: type: array items: type: string description: Denied actions. dataActions: type: array items: type: string description: Allowed Data actions. notDataActions: type: array items: type: string description: Denied Data actions. description: Role definition permissions. RoleDefinition: type: object properties: id: type: string description: The role definition ID. name: type: string description: The role definition name. isServiceRole: type: boolean description: If this is a service role. permissions: type: array items: $ref: '#/definitions/Permission' x-ms-identifiers: [] description: Role definition permissions. scopes: type: array items: type: string description: Role definition assignable scopes. description: Role definition properties. ProviderPermission: type: object description: The provider permission properties: applicationId: type: string description: The application id. roleDefinition: $ref: '#/definitions/RoleDefinition' description: Role definition properties. managedByRoleDefinition: $ref: '#/definitions/RoleDefinition' description: Role definition properties. providerAuthorizationConsentState: type: string enum: - NotSpecified - Required - NotRequired - Consented description: The provider authorization consent state. x-ms-enum: name: ProviderAuthorizationConsentState modelAsString: true ProviderPermissionListResult: properties: value: type: array items: $ref: '#/definitions/ProviderPermission' x-ms-identifiers: [] description: An array of provider permissions. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of provider permissions. ProviderConsentDefinition: type: object description: The provider consent. properties: consentToAuthorization: type: boolean description: A value indicating whether authorization is consented or not. ProviderRegistrationRequest: type: object description: The provider registration definition. properties: thirdPartyProviderConsent: $ref: '#/definitions/ProviderConsentDefinition' description: The provider consent. StatusMessage: type: object description: Operation status message object. properties: status: type: string description: Status of the deployment operation. error: $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: The error reported by the operation. ExpressionEvaluationOptions: properties: scope: type: string description: >- The scope to be used for evaluation of parameters, variables and functions in a nested template. enum: - NotSpecified - Outer - Inner x-ms-enum: name: ExpressionEvaluationOptionsScopeType modelAsString: true description: >- Specifies whether template expressions are evaluated within the scope of the parent template or nested template. ZoneMapping: type: object properties: location: type: string description: The location of the zone mapping. zones: type: array items: type: string parameters: ScopeParameter: name: scope in: path required: true type: string description: The resource scope. x-ms-parameter-location: method x-ms-skip-url-encoding: true GroupIdParameter: name: groupId in: path required: true type: string description: The management group ID. x-ms-parameter-location: method minLength: 1 maxLength: 90 SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The Microsoft Azure subscription ID. DeploymentNameParameter: name: deploymentName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ x-ms-parameter-location: method minLength: 1 maxLength: 64 description: The name of the deployment. ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to use for this operation. tags: - name: DeploymentOperations - name: Deployments - name: Operations - name: Providers - name: ResourceGroups - name: Resources