Microsoft Azure Snapshots API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Snapshots API
schemes:
- https
tags:
- name: Snapshots
paths:
  /snapshots:
    get:
      tags:
      - Snapshots
      summary: Microsoft Azure Gets A List Of Key Value Snapshots
      operationId: microsoftAzureGetsnapshots
      consumes: []
      produces:
      - application/vnd.microsoft.appconfig.snapshotset+json
      - application/problem+json
      parameters:
      - name: name
        in: query
        description: A filter for the name of the returned snapshots.
        type: string
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        type: string
      - $ref: '#/parameters/SnapshotFields'
      - $ref: '#/parameters/Status'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SnapshotListResult'
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        GetSnapshots:
          $ref: ./examples/GetSnapshots.json
      x-ms-pageable:
        itemName: items
        nextLinkName: '@nextLink'
      description: Needs a more full description created.
    head:
      tags:
      - Snapshots
      summary: Microsoft Azure Requests The Headers And Status Of The Given Resource
      operationId: microsoftAzureChecksnapshots
      consumes: []
      produces: []
      parameters:
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        type: string
      responses:
        '200':
          description: Success
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckSnapshots:
          $ref: ./examples/CheckSnapshots.json
      description: Needs a more full description created.
    post:
      description: 'Submit an operation to take a snapshot of face list, large face list, person group or large person group, with user-specified snapshot type, source object id, apply scope and an optional user data.<br>The snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.<br>Taking snapshot is an asynchronous operation. An operation id can be obtained from the "Operation-Location" field in response header, to be used in OperationStatus - Get for tracking the progress of creating the snapshot. The snapshot id will be included in the "resourceLocation" field in OperationStatus - Get response when the operation status is "succeeded".<br>Snapshot taking time depends on the number of person and face entries in the source object. It could be in seconds, or up to several hours for 1,000,000 persons with multiple faces.<br>Snapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. User can delete the snapshot using Snapshot - Delete by themselves any time before expiration.<br>Taking snapshot for a certain object will not block any other operations against the object. All read-only operations (Get/List and Identify/FindSimilar/Verify) can be conducted as usual. For all writable operations, including Add/Update/Delete the source object or its persons/faces and Train, they are not blocked but not recommended because writable updates may not be reflected on the snapshot during its taking. After snapshot taking is completed, all readable and writable operations can work as normal. Snapshot will also include the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.<br>* Free-tier subscription quota: 100 take operations per month.<br>* S0-tier subscription quota: 100 take operations per day.'
      operationId: microsoftAzureSnapshotTake
      parameters:
      - name: body
        description: Request body for taking a snapshot.
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/TakeSnapshotRequest'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '202':
          description: The snapshot taking task was queued successfully.
          headers:
            Operation-Location:
              description: Operation location with an operation id used to track the progress of taking snapshot. The returned id is the operation id, rather than snapshot id. Snapshot id can be obtained only when the operation status becomes "succeeded" in OperationStatus - Get.
              type: string
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Take a snapshot example:
          $ref: ./examples/TakeSnapshot.json
      summary: Microsoft Azure Post Snapshots
      tags:
      - Snapshots
  /snapshots/{name}:
    get:
      tags:
      - Snapshots
      summary: Microsoft Azure Gets A Single Key Value Snapshot
      operationId: microsoftAzureGetsnapshot
      consumes: []
      produces:
      - application/vnd.microsoft.appconfig.snapshot+json
      - application/problem+json
      parameters:
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: name
        in: path
        description: The name of the key-value snapshot to retrieve.
        required: true
        type: string
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        type: string
      - name: If-None-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag does not match the value provided.
        type: string
      - $ref: '#/parameters/SnapshotFields'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Snapshot'
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              type: string
            Link:
              description: Includes links to related resources.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        GetSnapshot:
          $ref: ./examples/GetSnapshot.json
        GetSnapshot_IfMatch:
          $ref: ./examples/GetSnapshot_IfMatch.json
        GetSnapshot_IfNoneMatch:
          $ref: ./examples/GetSnapshot_IfNoneMatch.json
        GetSnapshot_Failed:
          $ref: ./examples/GetSnapshot_Failed.json
      description: Needs a more full description created.
    put:
      tags:
      - Snapshots
      summary: Microsoft Azure Creates A Key Value Snapshot
      operationId: microsoftAzureCreatesnapshot
      consumes:
      - application/vnd.microsoft.appconfig.snapshot+json
      - application/json
      produces:
      - application/vnd.microsoft.appconfig.snapshot+json
      - application/problem+json
      parameters:
      - name: name
        in: path
        description: The name of the key-value snapshot to create.
        required: true
        type: string
        maxLength: 256
      - name: entity
        in: body
        description: The key-value snapshot to create.
        required: true
        schema:
          $ref: '#/definitions/Snapshot'
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Snapshot'
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              type: string
            Link:
              description: Includes links to related resources.
              type: string
            Operation-Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        CreateSnapshot:
          $ref: ./examples/CreateSnapshot.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
    patch:
      tags:
      - Snapshots
      summary: Microsoft Azure Updates The State Of A Key Value Snapshot
      operationId: microsoftAzureUpdatesnapshot
      consumes:
      - application/json
      produces:
      - application/vnd.microsoft.appconfig.snapshot+json
      - application/problem+json
      parameters:
      - name: name
        in: path
        description: The name of the key-value snapshot to update.
        required: true
        type: string
      - name: entity
        in: body
        description: The parameters used to update the snapshot.
        required: true
        schema:
          $ref: '#/definitions/SnapshotUpdateParameters'
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        type: string
      - name: If-None-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag does not match the value provided.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Snapshot'
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              type: string
            Link:
              description: Includes links to related resources.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        UpdateSnapshot:
          $ref: ./examples/UpdateSnapshot.json
        UpdateSnapshot_IfMatch:
          $ref: ./examples/UpdateSnapshot_IfMatch.json
      description: Needs a more full description created.
    head:
      tags:
      - Snapshots
      summary: Microsoft Azure Requests The Headers And Status Of The Given Resource
      operationId: microsoftAzureChecksnapshot
      consumes: []
      produces: []
      parameters:
      - name: name
        in: path
        description: The name of the key-value snapshot to check.
        required: true
        type: string
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        type: string
      - name: If-None-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag does not match the value provided.
        type: string
      responses:
        '200':
          description: Success
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              type: string
            Link:
              description: Includes links to related resources.
              type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckSnapshot:
          $ref: ./examples/CheckSnapshot.json
        CheckSnapshot_IfMatch:
          $ref: ./examples/CheckSnapshot_IfMatch.json
        CheckSnapshot_IfNoneMatch:
          $ref: ./examples/CheckSnapshot_IfNoneMatch.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots
  : get:
      operationId: microsoftAzureSnapshotsListbypool
      tags:
      - Snapshots
      description: List Snapshot resources by Pool
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: poolName
        in: path
        description: Pool Object
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/SnapshotListResult_2'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Snapshots_ListByPool:
          $ref: ./examples/Snapshots_ListByPool.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Snapshots
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
  : get:
      operationId: microsoftAzureSnapshotsGet
      tags:
      - Snapshots
      description: Get a Snapshot
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: poolName
        in: path
        description: Pool Object
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      - name: snapshotName
        in: path
        description: Volume Snapshot Resource
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Snapshot_2'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Snapshots_Get:
          $ref: ./examples/Snapshots_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Snapshots Snapshotname
    put:
      operationId: microsoftAzureSnapshotsCreateorupdate
      tags:
      - Snapshots
      description: Create a Snapshot
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: poolName
        in: path
        description: Pool Object
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      - name: snapshotName
        in: path
        description: Volume Snapshot Resource
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/Snapshot_2'
      responses:
        '200':
          description: Resource 'Snapshot' update operation succeeded
          schema:
            $ref: '#/definitions/Snapshot_2'
        '201':
          description: Resource 'Snapshot' create operation succeeded
          schema:
            $ref: '#/definitions/Snapshot_2'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Snapshots_CreateOrUpdate:
          $ref: ./examples/Snapshots_CreateOrUpdate.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Snapshots Snapshotname
    delete:
      operationId: microsoftAzureSnapshotsDelete
      tags:
      - Snapshots
      description: Delete a Snapshot
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: poolName
        in: path
        description: Pool Object
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      - name: snapshotName
        in: path
        description: Volume Snapshot Resource
        required: true
        type: string
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Snapshots_Delete:
          $ref: ./examples/Snapshots_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Snapshots Snapshotname
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}:
    put:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsCreateorupdate
      description: Creates or updates a snapshot.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/SnapshotNameParameter'
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      - name: snapshot
        in: body
        required: true
        schema:
          $ref: '#/definitions/Snapshot_3'
        description: Snapshot object supplied in the body of the Put disk operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Snapshot_3'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/Snapshot_3'
      x-ms-examples:
        Create a snapshot from an existing snapshot in the same or a different subscription.:
          $ref: ./examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json
        Create a snapshot by importing an unmanaged blob from the same subscription.:
          $ref: ./examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json
        Create a snapshot by importing an unmanaged blob from a different subscription.:
          $ref: ./examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json
        Create a snapshot from an existing snapshot in the same or a different subscription in a different region.:
          $ref: ./examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json
        Create a snapshot from an elastic san volume snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json
        ? Create a snapshot from an existing snapshot in the same or a different subscription in a different region with quicker copy speed.
        : $ref: ./examples/snapshotExamples/Snapshot_Create_EnhancedProvisionedBandwidthCopySpeed.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots Snapshotname
    patch:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsUpdate
      description: Updates (patches) a snapshot.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/SnapshotNameParameter'
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      - name: snapshot
        in: body
        required: true
        schema:
          $ref: '#/definitions/SnapshotUpdate'
        description: Snapshot object supplied in the body of the Patch snapshot operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Snapshot_3'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/Snapshot_3'
      x-ms-examples:
        Update a snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_Update.json
        Update a snapshot with accelerated networking.:
          $ref: ./examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots Snapshotname
    get:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsGet
      description: Gets information about a snapshot.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/SnapshotNameParameter'
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Snapshot_3'
      x-ms-examples:
        Get information about a snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_Get.json
        Get information about an incremental snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots Snapshotname
    delete:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsDelete
      description: Deletes a snapshot.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/SnapshotNameParameter'
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: If the snapshot is deleted, this is an expected error code.
      x-ms-examples:
        Delete a snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_Delete.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots Snapshotname
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots:
    get:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsListbyresourcegroup
      description: Lists snapshots under a resource group.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SnapshotList'
      x-ms-examples:
        List all snapshots in a resource group.:
          $ref: ./examples/snapshotExamples/Snapshot_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots
  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots:
    get:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsList
      description: Lists snapshots under a subscription.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SnapshotList'
      x-ms-examples:
        List all snapshots in a subscription.:
          $ref: ./examples/snapshotExamples/Snapshot_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Snapshots
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess
  : post:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsGrantaccess
      description: Grants access to a snapshot.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/SnapshotNameParameter'
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      - name: grantAccessData
        in: body
        required: true
        schema:
          $ref: ./diskRPCommon.json#/definitions/GrantAccessData
        description: Access data object supplied in the body of the get snapshot access operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: ./diskRPCommon.json#/definitions/AccessUri
        '202':
          description: Accepted
      x-ms-examples:
        Get a sas on a snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_BeginGetAccess.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots Snapshotname Begingetaccess
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess
  : post:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsRevokeaccess
      description: Revokes access to a snapshot.
      parameters:
      - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter
      - $ref: ./diskRPCommon.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/SnapshotNameParameter'
      - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
      x-ms-examples:
        Revoke access to a snapshot.:
          $ref: ./examples/snapshotExamples/Snapshot_EndGetAccess.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Snapshots Snapshotname Endgetaccess
  /snapshots/{snapshotId}:
    get:
      description: Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope in Snapshot - Take.
      operationId: microsoftAzureSnapshotGet
      parameters:
      - $ref: '#/parameters/snapshotId'
      produces:
      - application/json
      responses:
        '200':
          description: A successful call returns the snapshot's information.
          schema:
            $ref: '#/definitions/Snapshot_4'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Get snapshot example:
          $ref: ./examples/GetSnapshot.json
      summary: Microsoft Azure Get Snapshots Snapshotid
      tags:
      - Snapshots
    patch:
      description: Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.
      operationId: microsoftAzureSnapshotUpdate
      parameters:
      - $ref: '#/parameters/snapshotId'
      - name: body
        description: Request body for updating a snapshot.
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/Upd

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-snapshots-api-openapi.yml