Microsoft Azure Resource Management Client

The Microsoft Azure Resource Management Client is a tool that allows users to manage their Azure resources in a more efficient and streamlined manner. With this client, users can easily create, deploy, update, and delete resources such as virtual machines, databases, web apps, and more all from a single interface. It also enables users to define and enforce policies for their resources, track usage and performance, and automate resource management tasks through scripts and templates.

OpenAPI Specification

resourcemanagementclient-openapi-original.yml Raw ↑
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: nextLi

# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/resourcemanagementclient-openapi-original.yml