Person Directory Operations - Update Dynamic Person Group

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Atualize o nome ou userData de um Grupo de Pessoas Dinâmicas existente e gerencie seus membros adicionando ou removendo pessoas.
As propriedades permanecem inalteradas se não estiverem no corpo da solicitação.

PATCH {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
apiVersion	path	True	string	Versão da API
dynamicPersonGroupId	path	True	string	ID do grupo dinâmico de pessoas. Padrão Regex: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://{resource-name}.cognitiveservices.azure.com).

Corpo do Pedido

Name	Tipo	Description
name	string	Nome definido pelo usuário, comprimento máximo é 128.
userData	string	Dados opcionais definidos pelo usuário. O comprimento não deve exceder 16K.

Respostas

Name	Tipo	Description
200 OK		O pedido foi bem-sucedido.
Other Status Codes	FaceErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura do Azure AI Face.

Tipo: apiKey
Em: header

AADToken

O fluxo OAuth2 do Azure Ative Directory

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

Update DynamicPersonGroup

Pedido de amostra

HTTP

PATCH {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data"
}

Resposta da amostra

Código de estado:

200

Definições

Name	Description
FaceError	O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Face Service, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Uma resposta contendo detalhes do erro.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Face Service, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
message	string	Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	FaceError	O objeto de erro.