Person Directories - Get

Serviço:

Azure AI Services

Versão da API:

2025-05-01-preview

Obtenha as propriedades do diretório de pessoas.

GET {endpoint}/contentunderstanding/personDirectories/{personDirectoryId}?api-version=2025-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade de serviço de Compreensão de Conteúdo.
personDirectoryId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	O identificador exclusivo do diretório de pessoas.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	PersonDirectory	A solicitação foi bem-sucedida. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Get Person Directory

Solicitação de exemplo

HTTP

GET {endpoint}/contentunderstanding/personDirectories/myDirectory?api-version=2025-05-01-preview

Resposta de exemplo

Código de status:

200

{
  "personDirectoryId": "myDirectory",
  "description": "My person directory",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "tags": {
    "location": "Building A",
    "type": "Access Control",
    "updatedBy": "Paul"
  },
  "personCount": 0,
  "faceCount": 0
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
PersonDirectory	Diretório de pessoas e seus rostos.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação do erro em formato legível por humanos.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

PersonDirectory

Objeto

Diretório de pessoas e seus rostos.

Nome	Tipo	Description
createdAt	string (date-time)	A data e a hora em que o diretório de pessoas foi criado.
description	string	Uma descrição do diretório de pessoas.
faceCount	integer (int32)	Número de rostos no diretório de pessoas.
lastModifiedAt	string (date-time)	A data e a hora em que o diretório de pessoas foi modificado pela última vez.
personCount	integer (int32)	Número de pessoas no diretório de pessoas.
personDirectoryId	string pattern: ^[a-zA-Z0-9._-]{1,64}$	O identificador exclusivo do diretório de pessoas.
tags	object	Tags associadas ao diretório de pessoas.