Person Directory Operations - Get Dynamic Person Group

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Haal de gegevens van een dynamische persoonsgroep op, inclusief de naam en userData.
Deze API retourneert alleen informatie over dynamische personengroep, gebruik persoonsdirectory 'Dynamische persoongroep personen ophalen' in plaats daarvan om persoonsgegevens op te halen onder de dynamische persoonsgroep.

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

URI-parameters

Name	In	Vereist	Type	Description
apiVersion	path	True	string	API-versie
dynamicPersonGroupId	path	True	string	Id van de dynamische persoonsgroep. Regex-patroon: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://{resource-name}.cognitiveservices.azure.com).

Antwoorden

Name	Type	Description
200 OK	DynamicPersonGroup	Een geslaagde aanroep retourneert de gegevens van de dynamische persoonsgroep.
Other Status Codes	FaceErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure AI Face-abonnement.

Type: apiKey
In: header

AADToken

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiken

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

Voorbeelden

Get DynamicPersonGroup

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
DynamicPersonGroup	Een container die verwijst naar Person Directory 'Create Person'.
FaceError	Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Een antwoord met foutdetails.

DynamicPersonGroup

Een container die verwijst naar Person Directory 'Create Person'.

Name	Type	Description
dynamicPersonGroupId	string	Id van de dynamische persoonsgroep.
name	string	Door de gebruiker gedefinieerde naam, de maximale lengte is 128.
userData	string	Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000.

FaceError

Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
message	string	Een leesbare weergave van de fout.

FaceErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.