Snapshot - Update

Servicio:

Azure AI Services

Versión de la API:

1.0

Actualice la información de una instantánea. Solo la suscripción de origen que tomó la instantánea puede actualizar la instantánea.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
snapshotId	path	True	string uuid	Identificador que hace referencia a una instantánea determinada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Tipo	Description
applyScope	string[]	Matriz de los identificadores de suscripción de Face de destino para la instantánea, especificados por el usuario que creó la instantánea al llamar a Snapshot - Take. Para cada instantánea, solo las suscripciones incluidas en applyScope of Snapshot - Take pueden aplicarla.
userData	string	Los datos especificados por el usuario sobre la instantánea para cualquier propósito. La longitud no debe superar los 16 KB.

Respuestas

Nombre	Tipo	Description
200 OK		Una llamada correcta devuelve un cuerpo de respuesta vacío.
Other Status Codes	APIError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Update snapshot example

Solicitud de ejemplo

HTTP

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."
}

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
APIError	Información de error devuelta por la API
Error	Cuerpo del error.
UpdateSnapshotRequest	Cuerpo de la solicitud para actualizar una instantánea, con una combinación de los datos especificados por el usuario y el ámbito de aplicación definidos por el usuario.

APIError

Información de error devuelta por la API

Nombre	Tipo	Description
error	Error	Cuerpo del error.

Error

Cuerpo del error.

Nombre	Tipo	Description
code	string
message	string

UpdateSnapshotRequest

Cuerpo de la solicitud para actualizar una instantánea, con una combinación de los datos especificados por el usuario y el ámbito de aplicación definidos por el usuario.

Nombre	Tipo	Description
applyScope	string[]	Matriz de los identificadores de suscripción de Face de destino para la instantánea, especificados por el usuario que creó la instantánea al llamar a Snapshot - Take. Para cada instantánea, solo las suscripciones incluidas en applyScope of Snapshot - Take pueden aplicarla.
userData	string	Los datos especificados por el usuario sobre la instantánea para cualquier propósito. La longitud no debe superar los 16 KB.