Snapshot - Update

Referência

Serviço:: Azure AI Services

Versão da API:: 1.0-preview

Atualize as informações de um instantâneo. Somente a assinatura de origem que tirou o instantâneo pode atualizar o instantâneo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
snapshotId	path	True	string uuid	Id referenciando um instantâneo específico.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Tipo	Description
applyScope	string[]	Matriz das IDs de assinatura face de destino para o instantâneo, especificada pelo usuário que criou o instantâneo ao chamar Snapshot – Take. Para cada instantâneo, somente as assinaturas incluídas no applyScope de Snapshot – Take podem aplicá-lo.
userData	string	O usuário especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder 16 KB.

Respostas

Nome	Tipo	Description
200 OK		Uma chamada bem-sucedida retorna um corpo de resposta vazio.
Other Status Codes	APIError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Update snapshot example

Solicitação de exemplo

HTTP

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


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

Resposta de exemplo

Código de status:: 200

Definições

Nome	Description
APIError	Informações de erro retornadas pela API
Error	Corpo do erro.
UpdateSnapshotRequest	Corpo da solicitação para atualizar um instantâneo, com uma combinação de escopo de aplicação definido pelo usuário e dados especificados pelo usuário.

APIError

Informações de erro retornadas pela API

Nome	Tipo	Description
error	Error	Corpo do erro.

Error

Corpo do erro.

Nome	Tipo	Description
code	string
message	string

UpdateSnapshotRequest

Corpo da solicitação para atualizar um instantâneo, com uma combinação de escopo de aplicação definido pelo usuário e dados especificados pelo usuário.

Nome	Tipo	Description
applyScope	string[]	Matriz das IDs de assinatura face de destino para o instantâneo, especificada pelo usuário que criou o instantâneo ao chamar Snapshot – Take. Para cada instantâneo, somente as assinaturas incluídas no applyScope de Snapshot – Take podem aplicá-lo.
userData	string	O usuário especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder 16 KB.

Compartilhar via