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/UpdateSnapshotRequest'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: A successful call returns an empty response body.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Update snapshot example:
          $ref: ./examples/UpdateSnapshot.json
      summary: Microsoft Azure Patch Snapshots Snapshotid
      tags:
      - Snapshots
    delete:
      description: Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription who took the snapshot can delete the snapshot. If the user does not delete a snapshot with this API, the snapshot will still be automatically deleted in 48 hours after creation.
      operationId: microsoftAzureSnapshotDelete
      parameters:
      - $ref: '#/parameters/snapshotId'
      produces:
      - application/json
      responses:
        '200':
          description: A successful call returns an empty response body.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Delete snapshot example:
          $ref: ./examples/DeleteSnapshot.json
      summary: Microsoft Azure Delete Snapshots Snapshotid
      tags:
      - Snapshots
  /snapshots/{snapshotId}/apply:
    post:
      description: 'Submit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.<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>Applying 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 applying the snapshot. The target object id will be included in the "resourceLocation" field in OperationStatus - Get response when the operation status is "succeeded".<br>Snapshot applying time depends on the number of person and face entries in the snapshot object. It could be in seconds, or up to 1 hour 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. So the target subscription is required to apply the snapshot in 48 hours since its creation.<br>Applying a snapshot will not block any other operations against the target object, however it is not recommended because the correctness cannot be guaranteed during snapshot applying. After snapshot applying is completed, all operations towards the target object can work as normal. Snapshot also includes 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>One snapshot can be applied multiple times in parallel, while currently only CreateNew apply mode is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the "objectId" in request body to avoid such conflicts.<br>* Free-tier subscription quota: 100 apply operations per month.<br>* S0-tier subscription quota: 100 apply operations per day.'
      operationId: microsoftAzureSnapshotApply
      parameters:
      - $ref: '#/parameters/snapshotId'
      - name: body
        description: Request body for applying a snapshot.
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/ApplySnapshotRequest'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '202':
          description: The snapshot applying task was queued successfully.
          headers:
            Operation-Location:
              description: Operation location with an operation id used to track the progress of applying the snapshot by OperationStatus - Get.
              type: string
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Apply snapshot example:
          $ref: ./examples/ApplySnapshot.json
      summary: Microsoft Azure Post Snapshots Snapshotid Apply
      tags:
      - Snapshots
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots
  : get:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsList
      summary: Microsoft Azure Describe All Snapshots
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      description: List all snapshots associated with the volume
      x-ms-pageable:
        nextLinkName: null
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/snapshotsList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Snapshots_List:
          $ref: examples/Snapshots_List.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
  : get:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsGet
      summary: Microsoft Azure Describe A Snapshot
      description: Get details of the specified snapshot
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/SnapshotName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/snapshot'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Snapshots_Get:
          $ref: examples/Snapshots_Get.json
    put:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsCreate
      summary: Microsoft Azure Create A Snapshot
      description: Create the specified snapshot within the given volume
      parameters:
      - name: body
        description: Snapshot object supplied in the body of the operation.
        in: body
        required: true
        schema:
          $ref: '#/definitions/snapshot'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/SnapshotName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '201':
          description: Snapshot created
          schema:
            $ref: '#/definitions/snapshot'
        '202':
          description: Accepted -- Create request accepted; operation will complete asynchronously
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Snapshots_Create:
          $ref: examples/Snapshots_Create.json
    patch:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsUpdate
      summary: Microsoft Azure Update A Snapshot
      description: Patch a snapshot
      parameters:
      - name: body
        description: Snapshot object supplied in the body of the operation.
        in: body
        required: true
        schema:
          $ref: '#/definitions/snapshotPatch'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/SnapshotName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/snapshot'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Snapshots_Update:
          $ref: examples/Snapshots_Update.json
    delete:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsDelete
      summary: Microsoft Azure Delete A Snapshot
      description: Delete snapshot
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/SnapshotName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        '202':
          description: Accepted -- Delete request accepted; operation will complete asynchronously
        '204':
          description: NoContent -- Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Snapshots_Delete:
          $ref: examples/Snapshots_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles
  : post:
      tags:
      - Snapshots
      operationId: microsoftAzureSnapshotsRestorefiles
      summary: Microsoft Azure Create A New Snapshot Restore Files Request
      description: Restore the specified files from the specified snapshot to the active filesystem
      parameters:
      - name: body
        description: Restore payload supplied in the body of the operation.
        in: body
        required: true
        schema:
          $ref: '#/definitions/snapshotRestoreFiles'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/SnapshotName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Snapshots_SingleFileRestore:
          $ref: examples/Snapshots_SingleFileRestore.json
definitions:
  Snapshot_2:
    type: object
    description: Concrete proxy resource types can be created by aliasing this type using a specific property type.
    properties:
      properties:
        $ref: '#/definitions/SnapshotProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  SnapshotListResult_2:
    type: object
    description: The response of a Snapshot list operation.
    properties:
      value:
        type: array
        description: The Snapshot items on this page
        items:
          $ref: '#/definitions/Snapshot_2'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  Snapshot_3:
    properties:
      managedBy:
        readOnly: true
        type: string
        description: Unused. Always Null.
      sku:
        $ref: '#/definitions/SnapshotSku'
      extendedLocation:
        $ref: ../../../common-types/v1/common.json#/definitions/ExtendedLocation
        description: The extended location where the snapshot will be created. Extended location cannot be changed.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SnapshotProperties_2'
    allOf:
    - $ref: ../../../common-types/v1/common.json#/definitions/Resource
    description: Snapshot resource.
  APIError:
    type: object
    description: Error information returned by the API
    properties:
      error:
        $ref: '#/definitions/Error_2'
  ApplySnapshotRequest:
    type: object
    required:
    - objectId
    description: Request body for applying snapshot operation.
    properties:
      objectId:
        type: string
        description: User specified target object id to be created from the snapshot.
        maxLength: 64
        pattern: ^[a-z0-9-_]+$
      mode:
        type: string
        description: Snapshot applying mode. Currently only CreateNew is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the "objectId" in request body to avoid such conflicts.
        default: CreateNew
        x-nullable: false
        x-ms-enum:
          name: SnapshotApplyMode
          modelAsString: false
        enum:
        - CreateNew
  Error_2:
    type: object
    description: Error body.
    properties:
      code:
        type: string
      message:
        type: string
  snapshotPatch:
    description: Snapshot patch
    type: object
    properties: {}
  snapshotProperties:
    description: Snapshot properties
    type: object
    properties:
      snapshotId:
        title: snapshotId
        type: string
        readOnly: true
        description: UUID v4 used to identify the Snapshot
        pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
        maxLength: 36
        minLength: 36
        example: 9760acf5-4638-11e7-9bdb-020073ca3333
      created:
        title: name
        type: string
        format: date-time
        readOnly: true
        description: The creation date of the snapshot
        example: '2017-08-15 13:23:33'
      provisioningState:
        type: string
        readOnly: true
        description: Azure lifecycle management
  Snapshot:
    type: object
    required:
    - filters
    properties:
      name:
        description: The name of the snapshot.
        type: string
        readOnly: true
      status:
        description: The current status of the snapshot.
        type: string
        enum:
        - provisioning
        - ready
        - archived
        - failed
        x-nullable: false
        x-ms-enum:
          name: SnapshotStatus
          modelAsString: true
        readOnly: true
      filters:
        description: A list of filters used to filter the key-values included in the snapshot.
        type: array
        minItems: 1
        maxItems: 3
        items:
          $ref: '#/definitions/KeyValueFilter'
      composition_type:
        description: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label.
        type: string
        enum:
        - key
        - key_label
        x-nullable: false
        x-ms-enum:
          name: CompositionType
          modelAsString: true
      created:
        description: The time that the snapshot was created.
        format: date-time
        type: string
        readOnly: true
      expires:
        description: The time that the snapshot will expire.
        format: date-time
        type: string
        x-nullable: true
        readOnly: true
      retention_period:
        description: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.
        type: integer
        minimum: 3600
        maximum: 7776000
        format: int64
      size:
        description: The size in bytes of the snapshot.
        type: integer
        format: int64
        readOnly: true
      items_count:
        description: The amount of key-values in the snapshot.
        type: integer
        format: int64
        readOnly: true
      tags:
        description: The tags of the snapshot.
        type: object
        additionalProperties:
          type: string
      etag:
        description: A value representing the current state of the snapshot.
        type: string
        readOnly: true
  SnapshotUpdate:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SnapshotUpdateProperties'
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
      sku:
        $ref: '#/definitions/SnapshotSku'
    description: Snapshot update resource.
  TakeSnapshotRequest:
    type: object
    required:
    - type
    - objectId
    - applyScope
    description: Request body for taking snapshot operation.
    properties:
      type:
        type: string
        description: User specified type for the source object to take snapshot from. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported.
        x-ms-enum:
          name: SnapshotObjectType
          modelAsString: false
        enum:
        - FaceList
        - LargeFaceList
        - LargePersonGroup
        - PersonGroup
      objectId:
        type: string
        description: User specified source object id to take snapshot from.
        maxLength: 64
        pattern: ^[a-z0-9-_]+$
      applyScope:
        description: User specified array of target Face subscription ids for the snapshot. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
        $ref: '#/definitions/ApplyScope'
      userData:
        type: string
        description: User specified data about the snapshot for any purpose. Length should not exceed 16KB.
        maxLength: 16384
  snapshot:
    description: Snapshot of a Volume
    type: object
    required:
    - location
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      location:
        type: string
        description: Resource location
        x-ms-mutability:
        - read
        - create
      properties:
        description: Snapshot Properties
        $ref: '#/definitions/snapshotProperties'
        x-ms-client-flatten: true
  ResourceOperationStatusState:
    type: string
    description: State of the resource.
    enum:
    - Pending
    - Available
    - Unavailable
    x-ms-enum:
      name: ResourceOperationStatusState
      modelAsString: true
      values:
      - name: Pending
        value: Pending
        description: The resource is pending.
      - name: Available
        value: Available
        description: The resource is available.
      - name: Unavailable
        value: Unavailable
        description: The resource is unavailable.
  SnapshotListResult:
    description: The result of a snapshot list request.
    type: object
    properties:
      items:
        description: The collection value.
        type: array
        items:
          $ref: '#/definitions/Snapshot'
      '@nextLink':
        description: The URI that can be used to request the next set of paged results.
        type: string
  SnapshotSku:
    properties:
      name:
        type: string
        enum:
        - Standard_LRS
        - Premium_LRS
        - Standard_ZRS
        x-ms-enum:
          name: SnapshotStorageAccountTypes
          modelAsString: true
          values:
          - value: Standard_LRS
            description: Standard HDD locally redundant storage
          - value: Premium_LRS
            description: Premium SSD locally redundant storage
          - value: Standard_ZRS
            description: Standard zone redundant storage
        description: The sku name.
      tier:
        type: string
        readOnly: true
        description: The sku tier.
    description: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
  ResourceOperationalStatus:
    type: object
    description: Status of the resource
    properties:
      state:
        $ref: '#/definitions/ResourceOperationStatusState'
        description: state of the resource
      message:
        type: string
        description: Reason for state.
    required:
    - state
  SnapshotUpdateParameters:
    description: Parameters used to update a snapshot.
    type: object
    properties:
      status:
        description: The desired status of the snapshot.
        type: string
        enum:
        - provisioning
        - ready
        - archived
        - failed
        x-nullable: false
        x-ms-enum:
          name: SnapshotStatus
          modelAsString: true
  SnapshotProperties_2:
    properties:
      timeCreated:
        readOnly: true
        type: string
        format: date-time
        description: The time when the snapshot was created.
      osType:
        type: string
        description: The Operating System type.
        enum:
        - Windows
        - Linux
        x-ms-enum:
          name: OperatingSystemTypes
          modelAsString: false
      hyperVGeneration:
        type: string
        description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
        enum:
        - V1
        - V2
        x-ms-enum:
          name: HyperVGeneration
          modelAsString: true
      purchasePlan:
        $ref: ./diskRPCommon.json#/definitions/PurchasePlan
        description: Purchase plan information for the image from which the source disk for the snapshot was originally created.
      supportedCapabilities:
        $ref: ./diskRPCommon.json#/definitions/SupportedCapabilities
        description: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
      creationData:
        $ref: ./diskRPCommon.json#/definitions/CreationData
        description: Disk source information. CreationData information cannot be changed after the disk has been created.
      diskSizeGB:
        type: integer
        format: int32
        description: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
      diskSizeBytes:
        type: integer
        format: int64
        readOnly: true
        description: The size of the disk in bytes. This field is read only.
      diskState:
        $ref: ./diskRPCommon.json#/definitions/DiskState
        description: The state of the snapshot.
      uniqueId:
        type: string
        readOnly: true
        description: Unique Guid identifying the resource.
      encryptionSettingsCollection:
        $ref: ./diskRPCommon.json#/definitions/EncryptionSettingsCollection
        description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
      provisioningState:
        readOnly: true
        type: string
        description: The disk provisioning state.
      incremental:
        type: boolean
        description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
      incrementalSnapshotFamilyId:
        type: string
        readOnly: true
        description: Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
      encryption:
        $ref: ./diskRPCommon.json#/definitions/Encryption
        description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
      networkAccessPolicy:
        $ref: ./diskRPCommon.json#/definitions/NetworkAccessPolicy
      diskAccessId:
        type: string
        description: ARM id of the DiskAccess resource for using private endpoints on disks.
      securityProfile:
        $ref: ./diskRPCommon.json#/definitions/DiskSecurityProfile
        description: Contains the security related information for the resource.
      supportsHibernation:
        type: boolean
        description: Indicates the OS on a snapshot supports hibernation.
      publicNetworkAccess:
        $ref: ./diskRPCommon.json#/definitions/PublicNetworkAccess
      completionPercent:
        type: number
        description: Percentage complete for the background copy when a resource is created via the CopyStart operation.
      copyCompletionError:
        $ref: ./diskRPCommon.json#/definitions/CopyCompletionError
        description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
      dataAccessAuthMode:
        $ref: ./diskRPCommon.json#/definitions/DataAccessAuthMode
    required:
    - creationData
    description: Snapshot resource properties.
  Snapshot_4:
    type: object
    required:
    - id
    - account
    - type
    - applyScope
    - createdTime
    - lastUpdateTime
    description: Snapshot object. The Snapshot API will move your data outside the geo you select for your resource to West US, West Europe and Southeast Asia.
    properties:
      id:
        type: string
        format: uuid
        description: Snapshot id.
      account:
        type: string
        description: Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot - Take.
      type:
        type: string
        description: Type of the source object in the snapshot, specified by the subscriber who created the snapshot when calling Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported.
        x-ms-enum:
          name: SnapshotObjectType
          modelAsString: false
        enum:
        - FaceList
        - LargeFaceList
        - LargePersonGroup
        - PersonGroup
      applyScope:
        description: Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
        $ref: '#/definitions/ApplyScope'
      userData:
        type: string
        description: User specified data about the snapshot for any purpose. Length should not exceed 16KB.
        maxLength: 16384
      createdTime:
        type: string
        format: date-time
        description: A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.
      lastUpdateTime:
        type: string
        format: date-time
        description: A combined UTC date and time string that describes the last time when the snapshot was created or updated by Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z.
  snapshotRestoreFiles:
    description: Restore payload for Single File Snapshot Restore
    type: object
    x-ms-azure-resource: true
    required:
    - filePaths
    properties:
      filePaths:
        description: List of files to be restored
        type: array
        minItems: 1
        maxItems: 10
        items:
          type: string
          maxLength: 1024
          minLength: 1
        example:
        - /dir1/customer1.db
        - /dir1/customer2.db
      destinationPath:
        description: Destination folder where the files will be restored
        type: string
        example: /AVSdataStore
  ApplyScope:
    type: array
    description: Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
    items:
      type: string
      format: uuid
      x-nullable: false
  Error:
    description: Azure App Configuration error object.
    type: object
    properties:
      type:
        description: The type of the error.
        type: string
      title:
        description: A brief summary of the error.
        type: string
      name:
        description: The name of the parameter that resulted in the error.
        type: string
      detail:
        description: A detailed description of the error.
        type: string
      status:
        description: The HTTP status code that the error maps to.
        type: integer
    readOnly: true
  snapshotsList:
    description: List of Snapshots
    type: object
    properties:
      value:
        description: A list of Snapshots
        type: array
        items:
          $ref: '#/definitions/snapshot'
  KeyValueFilter:
    description: Enables filtering of key-values.
    type: object
    required:
    - key
    properties:
      key:
        description: Filters key-values by their key field.
        type: string
      label:
        description: Filters key-values by their label field.
        type: string
  SnapshotList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Snapshot_3'
        description: A list of snapshots.
      nextLink:
        type: string
        description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.
    required:
    - value
    description: The List Snapshots operation response.
  SnapshotProperties:
    type: object
    description: Volume Snapshot Properties
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
      status:
        $ref: '#/definitions/ResourceOperationalStatus'
        description: The status of the resource.
        readOnly: true
      source:
        type: string
        description: Reference to the source volume
        minLength: 3
        maxLength: 253
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
        x-ms-mutability:
        - read
        - create
    required:
    - source
  ProvisioningState:
    type: string
    description: Provisioning state of the resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Provisioning
        value: Provisioning
        description: The resource is being provisioned
      - name: Updating
        value: Updating
        description: The resource is updating
      - name: Deleting
        value: Deleting
        description: The resource is being deleted
      - name: Accepted
        value: Accepted
        description: The resource create request has been accepted
  UpdateSnapshotRequest:
    type: object
    description: Request body for updating a snapshot, with a combination of user defined apply scope and user specified data.
    properties:
      applyScope:
        description: Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
        $ref: '#/definitions/ApplyScope'
      userData:
        type: string
        description: User specified data about the snapshot for any purpose. Length should not exceed 16KB.
        maxLength: 16384
  SnapshotUpdateProperties:
    properties:
      osType:
        type: string
        description: the Operating System type.
        enum:
        - Windows
        - Linux
        x-ms-enum:
          name: OperatingSystemTypes
          modelAsString: false
      diskSizeGB:
        type: integer
        format: int32
        description: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
      encryptionSettingsCollection:
        $ref: ./diskRPCommon.json#/definitions/EncryptionSettingsCollection
        description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
      encryption:
        $ref: ./diskRPCommon.json#/definitions/Encryption
        description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
      networkAccessPolicy:
        $ref: ./diskRPCommon.json#/definitions/NetworkAccessPolicy
      diskAccessId:
        type: string
        description: ARM id of the DiskAccess resource for using private endpoints on disks.
      supportsHibernation:
        type: boolean
        description: Indicates the OS on a snapshot supports hibernation.
      publicNetworkAccess:
        $ref: ./diskRPCommon.json#/definitions/PublicNetworkAccess
      dataAccessAuthMode:
        $ref: ./diskRPCommon.json#/definitions/DataAccessAuthMode
      supportedCapabilities:
        $ref: ./diskRPCommon.json#/definitions/SupportedCapabilities
        description: List of supported capabilities for the image from which the OS disk was created.
    description: Snapshot resource update properties.
parameters:
  PoolName:
    name: poolName
    type: string
    in: path
    required: true
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
    minLength: 1
    maxLength: 64
    description: The name of the capacity pool
    x-ms-parameter-location: method
  snapshotId:
    name: snapshotId
    in: path
    description: Id referencing a particular snapshot.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
    collectionFormat: csv
  ApiVersion:
    name: api-version
    in: query
    description: The API version to be used with the HTTP request.
    required: true
    type: string
  SnapshotFields:
    name: $Select
    in: query
    description: Used to select what fields are present in the returned resource(s).
    type: array
    items:
      type: string
      enum:
      - name
      - status
      - filters
      - composition_type
      - created
      - expires
      - retention_period
      - size
      - items_count
      - tags
      - etag
      x-ms-enum:
        name: SnapshotFields
        modelAsString: true
    x-ms-parameter-location: method
    collectionFormat: csv
  SnapshotName:
    name: snapshotName
    type: string
    in: path
    required: true
    description: The name of the snapshot
    x-ms-parameter-location: method
  VolumeName:
    name: volumeName
    type: string
    in: path
    required: true
    pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
    minLength: 1
    maxLength: 64
    description: The name of the volume
    x-ms-parameter-location: method
  SnapshotNameParameter:
    name: snapshotName
    in: path
    required: true
    type: string
    description: The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
    x-ms-parameter-location: method
  AccountName:
    name: accountName
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
    in: path
    required: true
    description: The name of the NetApp account
    x-ms-parameter-location: method
  SyncTokens:
    name: Sync-Token
    in: header
    description: Used to guarantee real-time consistency between requests.
    type: string
  Status:
    name: Status
    in: query
    description: Used to filter returned snapshots by their status property.
    type: array
    items:
      type: string
      enum:
      - provisioning
      - ready
      - archived
      - failed
      x-ms-enum:
        name: SnapshotStatus
        modelAsString: true
    x-ms-parameter-location: method
    collectionFormat: csv
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'