Person Directory Operations - Update Dynamic Person Group With Person Changes

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Werk de naam of userData van een bestaande dynamische persoonsgroep bij en beheer de leden door personen toe te voegen of te verwijderen.
De eigenschappen blijven ongewijzigd als ze zich niet in de aanvraagbody bevinden.

PATCH {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).

Aanvraagbody

Name	Type	Description
addPersonIds	string[]	Matrix van personIds die zijn gemaakt door Person Directory 'Create Person' om toe te voegen.
name	string	Door de gebruiker gedefinieerde naam, de maximale lengte is 128.
removePersonIds	string[]	Matrix van personIds die zijn gemaakt door Person Directory 'Create Person' om te worden verwijderd.
userData	string	Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000.

Antwoorden

Name	Type	Description
202 Accepted		Een geslaagde aanroep retourneert een lege antwoordtekst. De service heeft de aanvraag geaccepteerd en wordt binnenkort verwerkt. De client kan een query uitvoeren op de bewerkingsstatus en het resultaat met behulp van de URL die is opgegeven in de antwoordheader Operation-Location. De URL verloopt over 48 uur. De URL geeft de status op wanneer persoonsadreslijst 'Dynamische persoonsgroepverwijzingen ophalen' de wijzigingen retourneert die in deze aanvraag zijn aangebracht. Kopteksten operation-Location: string
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

Update DynamicPersonGroup

Voorbeeldaanvraag

HTTP

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

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

Voorbeeldrespons

Statuscode:

202

operation-Location: https://contoso.com/operationstatus

Definities

Name	Description
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.

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.