swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Resource Groups API
  description: Operations for managing resource groups
schemes:
- https
tags:
- name: Resource Groups
  description: Operations for managing resource groups
paths:
  /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
components:
  schemas:
    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
    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: []
    CloudError:
      type: object
      description: An error response for a resource management request.
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponse'
    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
  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'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'