Share via

Snapshot - Update

Service:
Azure AI Services
API Version:
1.0

Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.

PATCH {Endpoint}/face/v1.0/snapshots/{snapshotId}

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
snapshotId
 path True

string (uuid)

Id referencing a particular snapshot.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
applyScope

string[] (uuid)

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.
userData

string

maxLength: 16384

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

Responses

Name Type Description
200 OK

A successful call returns an empty response body.
Other Status Codes

APIError

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Update snapshot example

Sample request

PATCH {Endpoint}/face/v1.0/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc


{
  "applyScope": [
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

Sample response

Status code:
200

Definitions

Name Description
APIError

Error information returned by the API
Error

Error body.
UpdateSnapshotRequest

Request body for updating a snapshot, with a combination of user defined apply scope and user specified data.

APIError

Object

Error information returned by the API

Name Type Description
error

Error

Error body.

Error

Object

Error body.

Name Type Description
code

string

message

string

UpdateSnapshotRequest

Object

Request body for updating a snapshot, with a combination of user defined apply scope and user specified data.

Name Type Description
applyScope

string[] (uuid)

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.
userData

string

maxLength: 16384

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