swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Resources API
schemes:
- https
tags:
- name: Resources
paths:
  /providers/Microsoft.ResourceGraph/resources:
    post:
      tags:
      - Resources
      operationId: microsoftAzureResources
      description: Queries the resources managed by Azure Resource Manager for scopes specified in the request.
      externalDocs:
        description: Learn more about the query syntax here
        url: https://aka.ms/resource-graph/learntoquery
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - name: query
        in: body
        required: true
        schema:
          $ref: '#/definitions/QueryRequest'
        description: Request specifying query and its options.
      responses:
        '200':
          description: Result of the query operation
          schema:
            $ref: '#/definitions/QueryResponse'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Basic query:
          $ref: ./examples/ResourcesBasicQuery.json
        Basic tenant query:
          $ref: ./examples/ResourcesTenantBasicQuery.json
        Basic management group query:
          $ref: ./examples/ResourcesMgBasicQuery.json
        Filter resources:
          $ref: ./examples/ResourcesFilterQuery.json
        Summarize resources by location:
          $ref: ./examples/ResourcesSummarizeQuery.json
        Complex query:
          $ref: ./examples/ResourcesComplexQuery.json
        Access a properties field:
          $ref: ./examples/ResourcesPropertiesQuery.json
        Query with a facet request:
          $ref: ./examples/ResourcesFacetQuery.json
        First page query:
          $ref: ./examples/ResourcesFirstPageQuery.json
        Next page query:
          $ref: ./examples/ResourcesNextPageQuery.json
        Random page query:
          $ref: ./examples/ResourcesRandomPageQuery.json
      summary: Microsoft Azure Post Providers Microsoft Resourcegraph Resources
  /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}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}
  : get:
      tags:
      - Resources
      operationId: microsoftAzureBackupvaultoperationresultsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultName'
      - name: operationId
        in: path
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/BackupVaultResource'
        '202':
          description: Accepted
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Azure-AsyncOperation:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.
              type: integer
              format: int32
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        GetOperationResult Patch:
          $ref: ./examples/VaultCRUD/GetOperationResultPatch.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Operationresults Operationid
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources:
    post:
      tags:
      - Resources
      operationId: microsoftAzureResourcesMoveresources
      summary: Microsoft Azure Moves Resources From One Resource Group To Another Resource Group
      description: 'The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. '
      parameters:
      - name: sourceResourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group from the source subscription containing the resources to be moved.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ResourcesMoveInfo'
        description: Parameters for moving resources.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources:
    post:
      tags:
      - Resources
      operationId: microsoftAzureResourcesValidatemoveresources
      summary: Microsoft Azure Validates Whether Resources Can Be Moved From One Resource Group To Another Resource Group
      description: This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
      parameters:
      - name: sourceResourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group from the source subscription containing the resources to be validated for move.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ResourcesMoveInfo'
        description: Parameters for moving resources.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
  : head:
      tags:
      - Resources
      operationId: microsoftAzureResourcesCheckexistence
      description: Checks whether a resource exists.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group containing the resource to check. The name is case insensitive.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: resourceProviderNamespace
        in: path
        required: true
        type: string
        description: The resource provider of the resource to check.
      - name: parentResourcePath
        in: path
        required: true
        type: string
        description: The parent resource identity.
        x-ms-skip-url-encoding: true
      - name: resourceType
        in: path
        required: true
        type: string
        description: The resource type.
        x-ms-skip-url-encoding: true
      - name: resourceName
        in: path
        required: true
        type: string
        description: The name of the resource to check whether it exists.
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename
    delete:
      tags:
      - Resources
      operationId: microsoftAzureResourcesDelete
      description: Deletes a resource.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group that contains the resource to delete. The name is case insensitive.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: resourceProviderNamespace
        in: path
        required: true
        type: string
        description: The namespace of the resource provider.
      - name: parentResourcePath
        in: path
        required: true
        type: string
        description: The parent resource identity.
        x-ms-skip-url-encoding: true
      - name: resourceType
        in: path
        required: true
        type: string
        description: The resource type.
        x-ms-skip-url-encoding: true
      - name: resourceName
        in: path
        required: true
        type: string
        description: The name of the resource to delete.
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename
    put:
      tags:
      - Resources
      operationId: microsoftAzureResourcesCreateorupdate
      description: Creates a resource.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group for the resource. The name is case insensitive.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: resourceProviderNamespace
        in: path
        required: true
        type: string
        description: The namespace of the resource provider.
      - name: parentResourcePath
        in: path
        required: true
        type: string
        description: The parent resource identity.
        x-ms-skip-url-encoding: true
      - name: resourceType
        in: path
        required: true
        type: string
        description: The resource type of the resource to create.
        x-ms-skip-url-encoding: true
      - name: resourceName
        in: path
        required: true
        type: string
        description: The name of the resource to create.
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GenericResource'
        description: Parameters for creating or updating the resource.
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        '201':
          description: Created - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename
    patch:
      tags:
      - Resources
      operationId: microsoftAzureResourcesUpdate
      description: Updates a resource.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group for the resource. The name is case insensitive.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: resourceProviderNamespace
        in: path
        required: true
        type: string
        description: The namespace of the resource provider.
      - name: parentResourcePath
        in: path
        required: true
        type: string
        description: The parent resource identity.
        x-ms-skip-url-encoding: true
      - name: resourceType
        in: path
        required: true
        type: string
        description: The resource type of the resource to update.
        x-ms-skip-url-encoding: true
      - name: resourceName
        in: path
        required: true
        type: string
        description: The name of the resource to update.
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GenericResource'
        description: Parameters for updating the resource.
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename
    get:
      tags:
      - Resources
      operationId: microsoftAzureResourcesGet
      description: Gets a resource.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group containing the resource to get. The name is case insensitive.
        pattern: ^[-\w\._\(\)]+$
        minLength: 1
        maxLength: 90
      - name: resourceProviderNamespace
        in: path
        required: true
        type: string
        description: The namespace of the resource provider.
      - name: parentResourcePath
        in: path
        required: true
        type: string
        description: The parent resource identity.
        x-ms-skip-url-encoding: true
      - name: resourceType
        in: path
        required: true
        type: string
        description: The resource type of the resource.
        x-ms-skip-url-encoding: true
      - name: resourceName
        in: path
        required: true
        type: string
        description: The name of the resource to get.
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovidernamespace Parentresourcepath Resourcetype Resourcename
  /{resourceId}:
    head:
      tags:
      - Resources
      operationId: microsoftAzureResourcesCheckexistencebyid
      description: Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.
      parameters:
      - name: resourceId
        in: path
        required: true
        type: string
        description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
        x-ms-skip-url-encoding: true
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      summary: Microsoft Azure Head Resourceid
    delete:
      tags:
      - Resources
      operationId: microsoftAzureResourcesDeletebyid
      description: Deletes a resource by ID.
      parameters:
      - name: resourceId
        in: path
        required: true
        type: string
        description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
        x-ms-skip-url-encoding: true
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Resourceid
    put:
      tags:
      - Resources
      operationId: microsoftAzureResourcesCreateorupdatebyid
      description: Create a resource by ID.
      parameters:
      - name: resourceId
        in: path
        required: true
        type: string
        description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
        x-ms-skip-url-encoding: true
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GenericResource'
        description: Create or update resource parameters.
      responses:
        '200':
          description: OK - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        '201':
          description: Created - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Resourceid
    patch:
      tags:
      - Resources
      operationId: microsoftAzureResourcesUpdatebyid
      description: Updates a resource by ID.
      parameters:
      - name: resourceId
        in: path
        required: true
        type: string
        description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
        x-ms-skip-url-encoding: true
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GenericResource'
        description: Update resource parameters.
      responses:
        '200':
          description: OK - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Resourceid
    get:
      tags:
      - Resources
      operationId: microsoftAzureResourcesGetbyid
      description: Gets a resource by ID.
      parameters:
      - name: resourceId
        in: path
        required: true
        type: string
        description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
        x-ms-skip-url-encoding: true
      - name: api-version
        in: query
        required: true
        type: string
        description: The API version to use for the operation.
        x-ms-api-version: false
      responses:
        '200':
          description: OK - Returns information about the resource.
          schema:
            $ref: '#/definitions/GenericResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      summary: Microsoft Azure Get Resourceid
components:
  schemas:
    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
    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
    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
    CloudError:
      type: object
      description: An error response for a resource management request.
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponse'
    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'
    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'
    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
    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
    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
  parameters:
    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'
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        format: uuid
definitions:
  DppIdentityDetails:
    description: Identity details
    properties:
      principalId:
        description: The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
        readOnly: true
        type: string
      tenantId:
        description: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
        readOnly: true
        type: string
      type:
        description: The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None
        type: string
      userAssignedIdentities:
        description: Gets or sets the user assigned identities.
        type: object
        additionalProperties:
          $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/UserAssignedIdentity
    title: DppIdentityDetails
    type: object
  QueryRequestOptions:
    description: The options for query evaluation
    properties:
      $skipToken:
        description: Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
        type: string
      $top:
        description: The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present.
        type: integer
        format: int32
        minimum: 1
        maximum: 1000
      $skip:
        description: The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present.
        type: integer
        format: int32
        minimum: 0
      resultFormat:
        description: Defines in which format query result returned.
        type: string
        enum:
        - table
        - objectArray
        default: objectArray
        x-ms-enum:
          name: ResultFormat
          modelAsString: false
      allowPartialScopes:
        description: Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits.
        type: boolean
        default: false
      authorizationScopeFilter:
        description: Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes.
        type: string
        enum:
        - AtScopeAndBelow
        - AtScopeAndAbove
        - AtScopeExact
        - AtScopeAboveAndBelow
        default: AtScopeAndBelow
        x-ms-enum:
          name: AuthorizationScopeFilter
          modelAsString: false
  ErrorDetails:
    title: Error details.
    type: object
    properties:
      code:
        type: string
        description: Error code identifying the specific error.
      message:
        type: string
        description: A human readable error message.
    additionalProperties:
      type: object
    required:
    - code
    - message
  SoftDeleteSettings:
    description: Soft delete related settings
    type: object
    properties:
      state:
        description: State of soft delete
        enum:
        - 'Off'
        - 'On'
        - AlwaysOn
        type: string
        x-ms-enum:
          name: SoftDeleteState
          modelAsString: true
          values:
          - description: Soft Delete is turned off for the BackupVault
            value: 'Off'
          - description: Soft Delete is enabled for the BackupVault but can be turned off
            value: 'On'
          - description: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed
            value: AlwaysOn
      retentionDurationInDays:
        description: Soft delete retention duration
        format: double
        type: number
  FacetRequestOptions:
    description: The options for facet evaluation
    properties:
      sortBy:
        description: The column name or query expression to sort on. Defaults to count if not present.
        type: string
      sortOrder:
        description: The sorting order by the selected column (count by default).
        type: string
        default: desc
        enum:
        - asc
        - desc
        x-ms-enum:
          name: FacetSortOrder
          modelAsString: false
      filter:
        description: Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.
        type: string
      $top:
        description: The maximum number of facet rows that should be returned.
        type: integer
        format: int32
        minimum: 1
        maximum: 1000
  Sku:
    properties:
      name:
        type: string
        description: The SKU name.
      tier:
        type: string
        description: The SKU tier.
      size:
        type: string
        description: The SKU size.
      family:
        type: string
        description: The SKU family.
      model:
        type: string
        description: The SKU model.
      capacity:
        type: integer
        format: int32
        description: The SKU capacity.
    description: SKU for the resource.
  Plan:
    properties:
      name:
        type: string
        description: The plan ID.
      publisher:
        type: string
        description: The publisher ID.
      product:
        type: string
        description: The offer ID.
      promotionCode:
        type: string
        description: The promotion code.
      version:
        type: string
        description: The plan's version.
    description: Plan for the resource.
  ExtendedLocation:
    properties:
      type:
        type: string
        enum:
        - EdgeZone
        x-ms-enum:
          name: ExtendedLocationType
          modelAsString: true
        description: The extended location type.
      name:
        type: string
        description: The extended location name.
    description: Resource extended location.
  Error_2:
    description: The resource management error response.
    properties:
      additionalInfo:
        description: The error additional info.
        items:
          $ref: '#/definitions/ErrorAdditionalInfo'
        x-ms-identifiers: []
        readOnly: true
        type: array
      code:
        description: The error code.
        readOnly: true
        type: string
      details:
        description: The error details.
        items:
          $ref: '#/definitions/Error_2'
        x-ms-identifiers: []
        readOnly: true
        type: array
      message:
        description: The error message.
        readOnly: true
        type: string
      target:
        description: The error target.
        readOnly: true
        type: string
  BackupVault:
    description: Backup Vault
    properties:
      monitoringSettings:
        $ref: '#/definitions/MonitoringSettings'
        description: Monitoring Settings
      provisioningState:
        description: Provisioning state of the BackupVault resource
        enum:
        - Failed
        - Provisioning
        - Succeeded
        - Unknown
        - Updating
        readOnly: true
        type: string
        x-ms-enum:
          modelAsString: true
          name: ProvisioningState
      resourceMoveState:
        description: Resource move state for backup vault
        enum:
        - Unknown
        - InProgress
        - PrepareFailed
        - CommitFailed
        - Failed
        - PrepareTimedout
        - CommitTimedout
        - CriticalFailure
        - PartialSuccess
        - MoveSucceeded
        type: string
        readOnly: true
        x-ms-enum:
          name: ResourceMoveState
          modelAsString: true
      resourceMoveDetails:
        $ref: '#/definitions/ResourceMoveDetails'
        description: Resource move details for backup vault
        readOnly: true
      securitySettings:
        $ref: '#/definitions/SecuritySettings'
        description: Security Settings
      storageSettings:
        description: Storage Settings
        items:
          $ref: '#/definitions/StorageSetting'
        x-ms-identifiers: []
        type: array
      isVaultProtectedByResourceGuard:
        description: Is vault protected by resource guard
        type: boolean
        readOnly: true
      featureSettings:
        $ref: '#/definitions/FeatureSettings'
        description: Feature Settings
      secureScore:
        description: Secure Score of Backup Vault
        enum:
        - None
        - Minimum
        - Adequate
        - Maximum
        - NotSupported
        type: string
        readOnly: true
        x-ms-enum:
          name: SecureScoreLevel
          modelAsString: true
      replicatedRegions:
        description: List of replicated regions for Backup Vault
        items:
          type: string
        type: array
    required:
    - storageSettings
    title: BackupVault
    type: object
  CmkKeyVaultProperties:
    type: object
    description: The properties of the Key Vault which hosts CMK
    properties:
      keyUri:
        description: The key uri of the Customer Managed Key
        type: string
  ErrorAdditionalInfo:
    description: The resource management error additional info.
    properties:
      info:
        description: The additional info.
        readOnly: true
        type: object
      type:
        description: The additional info type.
        readOnly: true
        type: string
  encryptionSettings:
    description: Customer Managed Key details of the resource.
    type: object
    properties:
      state:
        description: Encryption state of the Backup Vault.
        type: string
        enum:
        - Enabled
        - Disabled
        - Inconsistent
        x-ms-enum:
          name: EncryptionState
          modelAsString: true
          values:
          - description: CMK encryption is enabled on the Backup Vault
            value: Enabled
          - description: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'.
            value: Disabled
          - description: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state.
            value: Inconsistent
      keyVaultProperties:
        $ref: '#/definitions/CmkKeyVaultProperties'
      kekIdentity:
        $ref: '#/definitions/CmkKekIdentity'
      infrastructureEncryption:
        description: Enabling/Disabling the Double Encryption state
        type: string
        enum:
        - Enabled
        - Disabled
        x-ms-enum:
          name: InfrastructureEncryptionState
          modelAsString: true
  Facet:
    description: A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError.
    type: object
    properties:
      expression:
        description: Facet expression, same as in the corresponding facet request.
        type: string
      resultType:
        description: Result type
        type: string
    required:
    - expression
    - resultType
    discriminator: resultType
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      extendedLocation:
        $ref: '#/definitions/ExtendedLocation'
        x-ms-mutability:
        - read
        - create
        description: Resource extended location.
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    x-ms-azure-resource: true
    description: Specified resource.
  AzureMonitorAlertSettings:
    type: object
    description: Settings for Azure Monitor based alerts
    properties:
      alertsForAllJobFailures:
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: AlertsState
          modelAsString: true
  MonitoringSettings:
    type: object
    description: Monitoring Settings
    properties:
      azureMonitorAlertSettings:
        $ref: '#/definitions/AzureMonitorAlertSettings'
  SecuritySettings:
    description: Class containing security settings of vault
    type: object
    properties:
      softDeleteSettings:
        $ref: '#/definitions/SoftDeleteSettings'
      immutabilitySettings:
        $ref: '#/definitions/ImmutabilitySettings'
      encryptionSettings:
        $ref: '#/definitions/encryptionSettings'
  DppTrackedResource:
    allOf:
    - $ref: '#/definitions/DppBaseTrackedResource'
    properties:
      identity:
        $ref: '#/definitions/DppIdentityDetails'
        description: Input Managed Identity Details
    type: object
    x-ms-azure-resource: true
  GenericResource:
    properties:
      plan:
        $ref: '#/definitions/Plan'
        description: The plan of the resource.
      properties:
        type: object
        description: The resource properties.
      kind:
        type: string
        description: The kind of the resource.
        pattern: ^[-\w\._,\(\)]+$
      managedBy:
        type: string
        description: ID of the resource that manages this resource.
      sku:
        $ref: '#/definitions/Sku'
        description: The SKU of the resource.
      identity:
        $ref: '#/definitions/Identity'
        description: The identity of the resource.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Resource information.
  FeatureSettings:
    description: Class containing feature settings of vault
    type: object
    properties:
      crossSubscriptionRestoreSettings:
        $ref: '#/definitions/CrossSubscriptionRestoreSettings'
      crossRegionRestoreSettings:
        $ref: '#/definitions/CrossRegionRestoreSettings'
  QueryResponse:
    description: Query result.
    type: object
    properties:
      totalRecords:
        description: Number of total records matching the query.
        type: integer
        format: int64
      count:
        description: Number of records returned in the current response. In the case of paging, this is the number of records in the current page.
        type: integer
        format: int64
      resultTruncated:
        description: Indicates whether the query results are truncated.
        type: string
        enum:
        - 'true'
        - 'false'
        x-ms-enum:
          name: ResultTruncated
          modelAsString: false
      $skipToken:
        description: When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
        type: string
      data:
        description: Query output in JObject array or Table format.
        type: object
      facets:
        description: Query facets.
        type: array
        items:
          $ref: '#/definitions/Facet'
    required:
    - totalRecords
    - count
    - resultTruncated
    - data
  CrossSubscriptionRestoreSettings:
    description: CrossSubscriptionRestore Settings
    type: object
    properties:
      state:
        description: CrossSubscriptionRestore state
        enum:
        - Disabled
        - PermanentlyDisabled
        - Enabled
        type: string
        x-ms-enum:
          name: CrossSubscriptionRestoreState
          modelAsString: true
  FacetRequest:
    description: A request to compute additional statistics (facets) over the query results.
    type: object
    properties:
      expression:
        description: The column or list of columns to summarize by
        type: string
      options:
        description: The options for facet evaluation
        $ref: '#/definitions/FacetRequestOptions'
    required:
    - expression
  CrossRegionRestoreSettings:
    type: object
    properties:
      state:
        description: CrossRegionRestore state
        enum:
        - Disabled
        - Enabled
        type: string
        x-ms-enum:
          name: CrossRegionRestoreState
          modelAsString: true
  Identity:
    properties:
      principalId:
        readOnly: true
        type: string
        description: The principal ID of resource identity.
      tenantId:
        readOnly: true
        type: string
        description: The tenant ID of resource.
      type:
        type: string
        description: The identity type.
        enum:
        - SystemAssigned
        - UserAssigned
        - SystemAssigned, UserAssigned
        - None
        x-ms-enum:
          name: ResourceIdentityType
          modelAsString: false
      userAssignedIdentities:
        type: object
        additionalProperties:
          type: object
          x-ms-client-name: IdentityUserAssignedIdentitiesValue
          properties:
            principalId:
              readOnly: true
              type: string
              description: The principal id of user assigned identity.
            clientId:
              readOnly: true
              type: string
              description: The client id of user assigned identity.
        description: 'The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.'
    description: Identity for the resource.
  DppBaseTrackedResource:
    properties:
      eTag:
        description: Optional ETag.
        type: string
      id:
        description: Resource Id represents the complete path to the resource.
        readOnly: true
        type: string
      location:
        description: Resource location.
        type: string
      name:
        description: Resource name associated with the resource.
        readOnly: true
        type: string
      tags:
        additionalProperties:
          type: string
        description: Resource tags.
        type: object
      type:
        description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
        readOnly: true
        type: string
      systemData:
        $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/systemData
    type: object
    x-ms-azure-resource: true
  QueryRequest:
    description: Describes a query to be executed.
    type: object
    properties:
      subscriptions:
        description: Azure subscriptions against which to execute the query.
        type: array
        items:
          type: string
          description: Subscription Id.
      managementGroups:
        description: 'Azure management groups against which to execute the query. Example: [ ''mg1'', ''mg2'' ]'
        type: array
        items:
          type: string
          description: The name of Management group.
      query:
        description: The resources query.
        type: string
      options:
        description: The query evaluation options
        $ref: '#/definitions/QueryRequestOptions'
      facets:
        description: An array of facet requests to be computed against the query result.
        type: array
        items:
          $ref: '#/definitions/FacetRequest'
    required:
    - query
  StorageSetting:
    description: Storage setting
    properties:
      datastoreType:
        description: Gets or sets the type of the datastore.
        enum:
        - ArchiveStore
        - OperationalStore
        - VaultStore
        type: string
        x-ms-enum:
          modelAsString: true
          name: StorageSettingStoreTypes
      type:
        description: Gets or sets the type.
        enum:
        - GeoRedundant
        - LocallyRedundant
        - ZoneRedundant
        type: string
        x-ms-enum:
          modelAsString: true
          name: StorageSettingTypes
    title: StorageSetting
    type: object
  Error:
    title: Error info.
    type: object
    description: Error details.
    properties:
      code:
        type: string
        description: Error code identifying the specific error.
      message:
        type: string
        description: A human readable error message.
      details:
        type: array
        description: Error details
        items:
          $ref: '#/definitions/ErrorDetails'
    required:
    - code
    - message
  ResourceMoveDetails:
    description: ResourceMoveDetails will be returned in response to GetResource call from ARM
    type: object
    properties:
      operationId:
        description: CorrelationId of latest ResourceMove operation attempted
        type: string
      startTimeUtc:
        description: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
        type: string
      completionTimeUtc:
        description: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
        type: string
      sourceResourcePath:
        description: ARM resource path of source resource
        type: string
      targetResourcePath:
        description: ARM resource path of target resource used in latest ResourceMove operation
        type: string
  ErrorResponse:
    title: Error response.
    type: object
    description: An error response from the API.
    properties:
      error:
        $ref: '#/definitions/Error'
        description: Error information.
    required:
    - error
  CmkKekIdentity:
    type: object
    description: The details of the managed identity used for CMK
    properties:
      identityType:
        type: string
        description: The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity.
        enum:
        - SystemAssigned
        - UserAssigned
        x-ms-enum:
          name: IdentityType
          modelAsString: true
      identityId:
        type: string
        description: 'The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: ''UserAssigned'' only.'
  ResourcesMoveInfo:
    properties:
      resources:
        type: array
        items:
          type: string
        description: The IDs of the resources.
      targetResourceGroup:
        type: string
        description: The target resource group.
    description: Parameters of move resources.
  BackupVaultResource:
    allOf:
    - $ref: '#/definitions/DppTrackedResource'
    description: Backup Vault Resource
    properties:
      properties:
        $ref: '#/definitions/BackupVault'
        description: BackupVaultResource properties
    required:
    - location
    - properties
    title: BackupVault Resource
  CloudError:
    description: An error response from Azure Backup.
    properties:
      error:
        $ref: '#/definitions/Error_2'
    title: CloudError
    x-ms-external: true
  ImmutabilitySettings:
    description: Immutability Settings at vault level
    type: object
    properties:
      state:
        description: Immutability state
        enum:
        - Disabled
        - Unlocked
        - Locked
        type: string
        x-ms-enum:
          name: ImmutabilityState
          modelAsString: true
  CloudError_2:
    x-ms-external: true
    properties:
      error:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse
    description: An error response for a resource management request.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Api Version.
  VaultName:
    name: vaultName
    in: path
    description: The name of the backup vault.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersionParameter_2:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for this operation.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The Microsoft Azure subscription ID.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'