AZazure

Changed on

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.

get/snapshots/{snapshotId}

Request

  • Base URL
    {Endpoint}/face/v1.0
  • URL
    {Endpoint}/face/v1.0/snapshots/{snapshotId}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

snapshotIdstring uuid required

Id referencing a particular snapshot.

Response

A successful call returns the snapshot's information.

idstring uuid required

Snapshot id.

accountstring required

Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot - Take.

type'FaceList' | 'LargeFaceList' | 'LargePersonGroup' | 'PersonGroup' required

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.

applyScopestring[] required

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.

userDatastring

User specified data about the snapshot for any purpose. Length should not exceed 16KB.

createdTimestring date-time required

A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.

lastUpdateTimestring date-time required

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.

Changes