Microsoft Azure Resource Groups API

Manage Azure resource groups

OpenAPI Specification

azure-resource-groups-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Microsoft Azure Management Resource Groups API
  description: Core Microsoft Azure Resource Manager REST API for subscription, resource group, and resource management across all Azure services.
  version: '2022-09-01'
  x-generated-from: documentation
servers:
- url: https://management.azure.com
  description: Azure Resource Manager
security:
- azure_auth:
  - user_impersonation
tags:
- name: Resource Groups
  description: Manage Azure resource groups
paths:
  /subscriptions/{subscriptionId}/resourceGroups:
    get:
      operationId: ResourceGroups_List
      summary: Microsoft Azure Azure Management List Resource Groups
      description: Gets all the resource groups for a subscription.
      tags:
      - Resource Groups
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000000
      - name: api-version
        in: query
        required: true
        schema:
          type: string
        example: '2022-09-01'
      responses:
        '200':
          description: List of resource groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroupListResult'
              examples:
                ResourceGroups_List200Example:
                  summary: Default ResourceGroups_List 200 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    name: example
                    provisioningState: Succeeded
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: ResourceGroups_CreateOrUpdate
      summary: Microsoft Azure Azure Management Create or Update Resource Group
      description: Creates or updates a resource group.
      tags:
      - Resource Groups
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000000
      - name: resourceGroupName
        in: query
        required: true
        schema:
          type: string
        example: my-resource-group
      - name: api-version
        in: query
        required: true
        schema:
          type: string
        example: '2022-09-01'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceGroup'
      responses:
        '200':
          description: Resource group updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
              examples:
                ResourceGroups_CreateOrUpdate200Example:
                  summary: Default ResourceGroups_CreateOrUpdate 200 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    name: example
                    provisioningState: Succeeded
        '201':
          description: Resource group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
              examples:
                ResourceGroups_CreateOrUpdate201Example:
                  summary: Default ResourceGroups_CreateOrUpdate 201 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    name: example
                    provisioningState: Succeeded
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ResourceGroupListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ResourceGroup'
        nextLink:
          type: string
    ResourceGroup:
      type: object
      description: Resource group information.
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        type:
          type: string
          readOnly: true
        location:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
        properties:
          type: object
          properties:
            provisioningState:
              type: string
              readOnly: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: Impersonate your user account