Microsoft Azure
Microsoft Azure Resource Manager API

Azure Resource Manager is the deployment and management service for Azure that provides a management layer enabling you to create, update, and delete resources in your Azure account. The REST API provides operations for managing resources, resource groups, deployments, subscriptions, tenants, and policies, serving as the foundational control plane for all Azure resource management operations.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: Microsoft Azure Azure Resource Manager API
  description: >-
    Azure Resource Manager is the deployment and management service for Azure.
    It provides a management layer that enables you to create, update, and delete
    resources in your Azure account. You use management features like access control,
    locks, and tags to secure and organize your resources after deployment. The
    Resource Manager REST API provides operations for managing resources, resource
    groups, deployments, subscriptions, tenants, providers, and tags.
  version: '2024-03-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
    email: [email protected]
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/
  x-logo:
    url: https://azure.microsoft.com/svghandler/azure-logo.png
servers:
- url: https://management.azure.com
  description: Azure Resource Manager global endpoint
security:
- oauth2:
  - https://management.azure.com/.default
tags:
- name: Deployments
  description: Operations for managing resource deployments
- name: Providers
  description: Operations for listing resource providers
- name: Resource Groups
  description: Operations for managing resource groups
- name: Resources
  description: Operations for managing Azure resources
- name: Subscriptions
  description: Operations for managing subscriptions
paths:
  /subscriptions:
    get:
      operationId: Subscriptions_List
      summary: Microsoft Azure List All Subscriptions
      description: Gets all subscriptions for the authenticated tenant.
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the list of subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionListResult'
              examples:
                SubscriptionsList200Example:
                  summary: Default Subscriptions_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      subscriptionId: '500123'
                      displayName: example_value
                      tenantId: '500123'
                      state: Enabled
                      authorizationSource: example_value
                      tags: example_value
                    nextLink: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                SubscriptionsListdefaultExample:
                  summary: Default Subscriptions_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}:
    get:
      operationId: Subscriptions_Get
      summary: Microsoft Azure Get a Subscription
      description: Gets details about the specified subscription.
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the subscription details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
              examples:
                SubscriptionsGet200Example:
                  summary: Default Subscriptions_Get 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    subscriptionId: '500123'
                    displayName: example_value
                    tenantId: '500123'
                    state: Enabled
                    subscriptionPolicies:
                      locationPlacementId: '500123'
                      quotaId: '500123'
                      spendingLimit: 'On'
                    authorizationSource: example_value
                    tags: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                SubscriptionsGetdefaultExample:
                  summary: Default Subscriptions_Get default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/resourcegroups:
    get:
      operationId: ResourceGroups_List
      summary: Microsoft Azure List Resource Groups
      description: Gets all the resource groups for a subscription.
      tags:
      - Resource Groups
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: $filter
        in: query
        description: The filter to apply on the operation using OData syntax.
        schema:
          type: string
        example: example_value
      - name: $top
        in: query
        description: The number of results to return.
        schema:
          type: integer
          format: int32
        example: 10
      responses:
        '200':
          description: Successfully returned the list of resource groups.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroupListResult'
              examples:
                ResourcegroupsList200Example:
                  summary: Default ResourceGroups_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      name: Example Title
                      type: example_value
                      location: example_value
                      managedBy: example_value
                      tags: example_value
                    nextLink: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcegroupsListdefaultExample:
                  summary: Default ResourceGroups_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}:
    get:
      operationId: ResourceGroups_Get
      summary: Microsoft Azure Get a Resource Group
      description: Gets a resource group by name.
      tags:
      - Resource Groups
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
              examples:
                ResourcegroupsGet200Example:
                  summary: Default ResourceGroups_Get 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    managedBy: example_value
                    tags: example_value
                    properties:
                      provisioningState: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcegroupsGetdefaultExample:
                  summary: Default ResourceGroups_Get default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: ResourceGroups_CreateOrUpdate
      summary: Microsoft Azure Create or Update a Resource Group
      description: Creates or updates a resource group.
      tags:
      - Resource Groups
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceGroup'
            examples:
              ResourcegroupsCreateorupdateRequestExample:
                summary: Default ResourceGroups_CreateOrUpdate request
                x-microcks-default: true
                value:
                  id: abc123
                  name: Example Title
                  type: example_value
                  location: example_value
                  managedBy: example_value
                  tags: example_value
                  properties:
                    provisioningState: example_value
      responses:
        '200':
          description: Successfully updated the resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
              examples:
                ResourcegroupsCreateorupdate200Example:
                  summary: Default ResourceGroups_CreateOrUpdate 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    managedBy: example_value
                    tags: example_value
                    properties:
                      provisioningState: example_value
        '201':
          description: Successfully created the resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
              examples:
                ResourcegroupsCreateorupdate201Example:
                  summary: Default ResourceGroups_CreateOrUpdate 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    managedBy: example_value
                    tags: example_value
                    properties:
                      provisioningState: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcegroupsCreateorupdatedefaultExample:
                  summary: Default ResourceGroups_CreateOrUpdate default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: ResourceGroups_Delete
      summary: Microsoft Azure Delete a Resource Group
      description: >-
        Deletes a resource group. When you delete a resource group, all of its
        resources are also deleted.
      tags:
      - Resource Groups
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: forceDeletionTypes
        in: query
        description: >-
          The resource types that should be force deleted. Comma-separated list
          of resource type names.
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successfully deleted the resource group.
        '202':
          description: Accepted. The resource group deletion is in progress.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcegroupsDeletedefaultExample:
                  summary: Default ResourceGroups_Delete default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: ResourceGroups_Update
      summary: Microsoft Azure Update a Resource Group
      description: >-
        Updates a resource group. Resource groups can be updated by patching the
        resource group properties, such as tags.
      tags:
      - Resource Groups
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceGroupPatchable'
            examples:
              ResourcegroupsUpdateRequestExample:
                summary: Default ResourceGroups_Update request
                x-microcks-default: true
                value:
                  name: Example Title
                  tags: example_value
                  properties:
                    provisioningState: example_value
      responses:
        '200':
          description: Successfully updated the resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
              examples:
                ResourcegroupsUpdate200Example:
                  summary: Default ResourceGroups_Update 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    managedBy: example_value
                    tags: example_value
                    properties:
                      provisioningState: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcegroupsUpdatedefaultExample:
                  summary: Default ResourceGroups_Update default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/resources:
    get:
      operationId: Resources_List
      summary: Microsoft Azure List All Resources in a Subscription
      description: Get all the resources in a subscription.
      tags:
      - Resources
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: $filter
        in: query
        description: The filter to apply on the operation using OData syntax.
        schema:
          type: string
        example: example_value
      - name: $expand
        in: query
        description: >-
          Comma-separated list of additional properties to be included in the
          response. Valid values include createdTime, changedTime, and
          provisioningState.
        schema:
          type: string
        example: example_value
      - name: $top
        in: query
        description: The number of results to return.
        schema:
          type: integer
          format: int32
        example: 10
      responses:
        '200':
          description: Successfully returned the list of resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceListResult'
              examples:
                ResourcesList200Example:
                  summary: Default Resources_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - properties: example_value
                      kind: example_value
                      managedBy: example_value
                    nextLink: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcesListdefaultExample:
                  summary: Default Resources_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/resources:
    get:
      operationId: Resources_ListByResourceGroup
      summary: Microsoft Azure List Resources in a Resource Group
      description: Get all the resources for a resource group.
      tags:
      - Resources
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: $filter
        in: query
        description: The filter to apply on the operation using OData syntax.
        schema:
          type: string
        example: example_value
      - name: $top
        in: query
        description: The number of results to return.
        schema:
          type: integer
          format: int32
        example: 10
      responses:
        '200':
          description: Successfully returned the list of resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceListResult'
              examples:
                ResourcesListbyresourcegroup200Example:
                  summary: Default Resources_ListByResourceGroup 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - properties: example_value
                      kind: example_value
                      managedBy: example_value
                    nextLink: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ResourcesListbyresourcegroupdefaultExample:
                  summary: Default Resources_ListByResourceGroup default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}:
    put:
      operationId: Deployments_CreateOrUpdate
      summary: Microsoft Azure Create or Update a Deployment
      description: >-
        Deploys resources at resource group scope. You can provide the template
        and parameters directly in the request or link to JSON files.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: deploymentName
        in: path
        required: true
        description: The name of the deployment.
        schema:
          type: string
          minLength: 1
          maxLength: 64
          pattern: '^[-\w\._\(\)]+$'
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Deployment'
            examples:
              DeploymentsCreateorupdateRequestExample:
                summary: Default Deployments_CreateOrUpdate request
                x-microcks-default: true
                value:
                  location: example_value
                  properties:
                    template: example_value
                    parameters: example_value
                    mode: Incremental
                  tags: example_value
      responses:
        '200':
          description: Successfully updated the deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentExtended'
              examples:
                DeploymentsCreateorupdate200Example:
                  summary: Default Deployments_CreateOrUpdate 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    properties:
                      provisioningState: NotSpecified
                      correlationId: '500123'
                      timestamp: '2026-01-15T10:30:00Z'
                      duration: example_value
                      outputs: example_value
                      mode: Incremental
                    tags: example_value
        '201':
          description: Successfully created the deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentExtended'
              examples:
                DeploymentsCreateorupdate201Example:
                  summary: Default Deployments_CreateOrUpdate 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    properties:
                      provisioningState: NotSpecified
                      correlationId: '500123'
                      timestamp: '2026-01-15T10:30:00Z'
                      duration: example_value
                      outputs: example_value
                      mode: Incremental
                    tags: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                DeploymentsCreateorupdatedefaultExample:
                  summary: Default Deployments_CreateOrUpdate default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: Deployments_Get
      summary: Microsoft Azure Get a Deployment
      description: Gets a deployment by name.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: deploymentName
        in: path
        required: true
        description: The name of the deployment.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentExtended'
              examples:
                DeploymentsGet200Example:
                  summary: Default Deployments_Get 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: example_value
                    location: example_value
                    properties:
                      provisioningState: NotSpecified
                      correlationId: '500123'
                      timestamp: '2026-01-15T10:30:00Z'
                      duration: example_value
                      outputs: example_value
                      mode: Incremental
                    tags: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                DeploymentsGetdefaultExample:
                  summary: Default Deployments_Get default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/providers:
    get:
      operationId: Providers_List
      summary: Microsoft Azure List Resource Providers
      description: Gets all resource providers for a subscription.
      tags:
      - Providers
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: $expand
        in: query
        description: >-
          The properties to include in the results. For example, use
          resourceTypes/aliases to get the aliases for resource types.
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successfully returned the list of providers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderListResult'
              examples:
                ProvidersList200Example:
                  summary: Default Providers_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      namespace: example_value
                      registrationState: example_value
                      registrationPolicy: example_value
                      resourceTypes: {}
                    nextLink: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                ProvidersListdefaultExample:
                  summary: Default Providers_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscriptions/{subscriptionId}/tagNames:
    get:
      operationId: Tags_List
      summary: Microsoft Azure List Predefined Tag Names
      description: >-
        Gets a summary of tag usage under the subscription. This operation
        performs a union of predefined tags, resource tags, resource group tags
        and subscription tags.
      tags: []
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the tag names.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsListResult'
              examples:
                TagsList200Example:
                  summary: Default Tags_List 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      tagName: example_value
                      values: {}
                    nextLink: example_value
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
              examples:
                TagsListdefaultExample:
                  summary: Default Tags_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      target: example_value
                      details:
                      - {}
             

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-resource-manager-openapi.yml
Microsoft Azure Resource Manager API

Documentation

Specifications

Other Resources

OpenAPI Specification
