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: azuresupport@microsoft.com
  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:
                      - {}
                      additionalInfo:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            https://management.azure.com/.default: Access Azure Resource Manager
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        format: uuid
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group. The name is case insensitive.
      schema:
        type: string
        minLength: 1
        maxLength: 90
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        default: '2024-03-01'
  schemas:
    Subscription:
      type: object
      description: Subscription information.
      properties:
        id:
          type: string
          readOnly: true
          description: The fully qualified ID for the subscription.
          example: abc123
        subscriptionId:
          type: string
          readOnly: true
          description: The subscription ID.
          example: '500123'
        displayName:
          type: string
          readOnly: true
          description: The subscription display name.
          example: example_value
        tenantId:
          type: string
          readOnly: true
          description: The subscription tenant ID.
          example: '500123'
        state:
          type: string
          readOnly: true
          description: The subscription state.
          enum:
          - Enabled
          - Warned
          - PastDue
          - Disabled
          - Deleted
          example: Enabled
        subscriptionPolicies:
          $ref: '#/components/schemas/SubscriptionPolicies'
        authorizationSource:
          type: string
          description: >-
            The authorization source of the request. Valid values are one or more
            combinations of Legacy, RoleBased, Bypassed, Direct, Management.
          example: example_value
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags attached to the subscription.
          example: example_value
    SubscriptionPolicies:
      type: object
      description: Subscription policies.
      properties:
        locationPlacementId:
          type: string
          readOnly: true
          description: The subscription location placement ID.
          example: '500123'
        quotaId:
          type: string
          readOnly: true
          description: The subscription quota ID.
          example: '500123'
        spendingLimit:
          type: string
          readOnly: true
          description: The subscription spending limit.
          enum:
          - 'On'
          - 'Off'
          - CurrentPeriodOff
          example: 'On'
    SubscriptionListResult:
      type: object
      description: Subscription list operation response.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: An array of subscriptions.
          example: []
        nextLink:
          type: string
          description: The URL to get the next set of results.
          example: example_value
      required:
      - value
    ResourceGroup:
      type: object
      description: Resource group information.
      properties:
        id:
          type: string
          readOnly: true
          description: The ID of the resource group.
          example: abc123
        name:
          type: string
          readOnly: true
          description: The name of the resource group.
          example: Example Title
        type:
          type: string
          readOnly: true
          description: The type of the resource group.
          example: example_value
        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.
          example: example_value
        managedBy:
          type: string
          description: The ID of the resource that manages this resource group.
          example: example_value
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags attached to the resource group.
          example: example_value
        properties:
          $ref: '#/components/schemas/ResourceGroupProperties'
      required:
      - location
    ResourceGroupProperties:
      type: object
      description: The resource group properties.
      properties:
        provisioningState:
          type: string
          readOnly: true
          description: The provisioning state.
          example: example_value
    ResourceGroupPatchable:
      type: object
      description: Resource group information for update.
      properties:
        name:
          type: string
          description: The name of the resource group.
          example: Example Title
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags attached to the resource group.
          example: example_value
        properties:
          $ref: '#/components/schemas/ResourceGroupProperties'
    ResourceGroupListResult:
      type: object
      description: List of resource groups.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ResourceGroup'
          description: An array of resource groups.
          example: []
        nextLink:
          type: string
          readOnly: true
          description: The URL to get the next set of results.
          example: example_value
    GenericResource:
      type: object
      description: Resource information.
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        plan:
          $ref: '#/components/schemas/Plan'
        properties:
          type: object
          description: The resource properties.
          example: example_value
        kind:
          type: string
          description: The kind of the resource.
          pattern: '^[-\w\._,\(\)]+$'
          example: example_value
        managedBy:
          type: string
          description: ID of the resource that manages this resource.
          example: example_value
        sku:
          $ref: '#/components/schemas/Sku'
        identity:
          $ref: '#/components/schemas/Identity'
    Resource:
      type: object
      description: Specified resource.
      properties:
        id:
          type: string
          readOnly: true
          description: Resource ID.
          example: abc123
        name:
          type: string
          readOnly: true
          description: Resource name.
          example: Example Title
        type:
          type: string
          readOnly: true
          description: Resource type.
          example: example_value
        location:
          type: string
          description: Resource location.
          example: example_value
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
          example: example_value
    ResourceListResult:
      type: object
      description: List of resource groups.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/GenericResource'
          description: An array of resources.
          example: []
        nextLink:
          type: string
          readOnly: true
          description: The URL to get the next set of results.
          example: example_value
    Plan:
      type: object
      description: Plan for the resource.
      properties:
        name:
          type: string
          description: The plan ID.
          example: Example Title
        publisher:
          type: string
          description: The publisher ID.
          example: example_value
        product:
          type: string
          description: The offer ID.
          example: example_value
        promotionCode:
          type: string
          description: The promotion code.
          example: example_value
        version:
          type: string
          description: The plan's version.
          example: example_value
    Sku:
      type: object
      description: SKU for the resource.
      properties:
        name:
          type: string
          description: The SKU name.
          example: Example Title
        tier:
          type: string
          description: The SKU tier.
          example: example_value
        size:
          type: string
          description: The SKU size.
          example: example_value
        family:
          type: string
          description: The SKU family.
          example: example_value
        model:
          type: string
          description: The SKU model.
          example: example_value
        capacity:
          type: integer
          format: int32
          description: The SKU capacity.
          example: 10
    Identity:
      type: object
      description: Identity for the resource.
      properties:
        principalId:
          type: string
          readOnly: true
          description: The principal ID of resource identity.
          example: '500123'
        tenantId:
          type: string
          readOnly: true
          description: The tenant ID of resource.
          example: '500123'
        type:
          type: string
          description: The identity type.
          enum:
          - SystemAssigned
          - UserAssigned
          - SystemAssigned, UserAssigned
          - None
          example: SystemAssigned
        userAssignedIdentities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UserAssignedIdentity'
          description: The list of user-assigned identities.
          example: example_value
    UserAssignedIdentity:
      type: object
      description: User-assigned managed identity.
      properties:
        principalId:
          type: string
          readOnly: true
          description: The principal ID of the user-assigned identity.
          example: '500123'
        clientId:
          type: string
          readOnly: true
          description: The client ID of the user-assigned identity.
          example: '500123'
    Deployment:
      type: object
      description: Deployment operation parameters.
      properties:
        location:
          type: string
          description: >-
            The location to store the deployment data.
          example: example_value
        properties:
          $ref: '#/components/schemas/DeploymentProperties'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Deployment tags.
          example: example_value
      required:
      - properties
    DeploymentProperties:
      type: object
      description: Deployment properties.
      properties:
        template:
          type: object
          description: >-
            The template content. Use this element when you want to pass the
            template syntax directly in the request rather than link to an
            existing template.
          example: example_value
        templateLink:
          $ref: '#/components/schemas/TemplateLink'
        parameters:
          type: object
          description: >-
            Name and value pairs that define the deployment parameters.
          example: example_value
        parametersLink:
          $ref: '#/components/schemas/ParametersLink'
        mode:
          type: string
          description: The mode that is used to deploy resources.
          enum:
          - Incremental
          - Complete
          example: Incremental
        debugSetting:
          $ref: '#/components/schemas/DebugSetting'
      required:
      - mode
    TemplateLink:
      type: object
      description: Entity representing the reference to the template.
      properties:
        uri:
          type: string
          description: The URI of the template.
          example: example_value
        contentVersion:
          type: string
          description: The content version of the template.
          example: example_value
      required:
      - uri
    ParametersLink:
      type: object
      description: Entity representing the reference to the deployment parameters.
      properties:
        uri:
          type: string
          description: The URI of the parameters file.
          example: example_value
        contentVersion:
          type: string
          description: The content version of the parameters.
          example: example_value
      required:
      - uri
    DebugSetting:
      type: object
      description: The debug setting.
      properties:
        detailLevel:
          type: string
          description: >-
            Specifies the type of information to log for debugging. The
            permitted values are none, requestContent, responseContent, or both.
          example: example_value
    DeploymentExtended:
      type: object
      description: Deployment information.
      properties:
        id:
          type: string
          readOnly: true
          description: The ID of the deployment.
          example: abc123
        name:
          type: string
          readOnly: true
          description: The name of the deployment.
          example: Example Title
        type:
          type: string
          readOnly: true
          description: The type of the deployment.
          example: example_value
        location:
          type: string
          description: The location of the deployment.
          example: example_value
        properties:
          $ref: '#/components/schemas/DeploymentPropertiesExtended'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Deployment tags.
          example: example_value
    DeploymentPropertiesExtended:
      type: object
      description: Deployment properties with additional details.
      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
          example: NotSpecified
        correlationId:
          type: string
          readOnly: true
          description: The correlation ID of the deployment.
          example: '500123'
        timestamp:
          type: string
          format: date-time
          readOnly: true
          description: The timestamp of the template deployment.
          example: '2026-01-15T10:30:00Z'
        duration:
          type: string
          readOnly: true
          description: The duration of the template deployment.
          example: example_value
        outputs:
          type: object
          readOnly: true
          description: Key/value pairs that represent deployment output.
          example: example_value
        mode:
          type: string
          readOnly: true
          description: The deployment mode.
          enum:
          - Incremental
          - Complete
          example: Incremental
    ProviderListResult:
      type: object
      description: List of resource providers.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Provider'
          description: An array of resource providers.
          example: []
        nextLink:
          type: string
          readOnly: true
          description: The URL to get the next set of results.
          example: example_value
    Provider:
      type: object
      description: Resource provider information.
      properties:
        id:
          type: string
          readOnly: true
          description: The provider ID.
          example: abc123
        namespace:
          type: string
          description: The namespace of the resource provider.
          example: example_value
        registrationState:
          type: string
          readOnly: true
          description: The registration state of the resource provider.
          example: example_value
        registrationPolicy:
          type: string
          readOnly: true
          description: The registration policy of the resource provider.
          example: example_value
        resourceTypes:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ProviderResourceType'
          description: The collection of provider resource types.
          example: []
    ProviderResourceType:
      type: object
      description: Resource type managed by the resource provider.
      properties:
        resourceType:
          type: string
          description: The resource type.
          example: example_value
        locations:
          type: array
          items:
            type: string
          description: The collection of locations where this resource type can be created.
          example: []
        apiVersions:
          type: array
          items:
            type: string
          description: The API version.
          example: []
    TagsListResult:
      type: object
      description: List of subscription tags.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/TagDetails'
          description: An array of tags.
          example: []
        nextLink:
          type: string
          readOnly: true
          description: The URL to get the next set of results.
          example: example_value
    TagDetails:
      type: object
      description: Tag details.
      properties:
        id:
          type: string
          readOnly: true
          description: The tag name ID.
          example: abc123
        tagName:
          type: string
          description: The tag name.
          example: example_value
        count:
          $ref: '#/components/schemas/TagCount'
        values:
          type: array
          items:
            $ref: '#/components/schemas/TagValue'
          description: The list of tag values.
          example: []
    TagCount:
      type: object
      description: Tag count.
      properties:
        type:
          type: string
          description: Type of count.
          example: example_value
        value:
          type: integer
          format: int32
          description: Value of count.
          example: 10
    TagValue:
      type: object
      description: Tag information.
      properties:
        id:
          type: string
          readOnly: true
          description: The tag value ID.
          example: abc123
        tagValue:
          type: string
          description: The tag value.
          example: example_value
        count:
          $ref: '#/components/schemas/TagCount'
    CloudError:
      type: object
      description: An error response for a resource management request.
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponse'
    ErrorResponse:
      type: object
      description: Common error response for all Azure Resource Manager APIs.
      properties:
        code:
          type: string
          readOnly: true
          description: The error code.
          example: example_value
        message:
          type: string
          readOnly: true
          description: The error message.
          example: example_value
        target:
          type: string
          readOnly: true
          description: The error target.
          example: example_value
        details:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ErrorResponse'
          description: The error details.
          example: []
        additionalInfo:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          description: The error additional info.
          example: []
    ErrorAdditionalInfo:
      type: object
      description: The resource management error additional info.
      properties:
        type:
          type: string
          readOnly: true
          description: The additional info type.
          example: example_value
        info:
          type: object
          readOnly: true
          description: The additional info.
          example: example_value