Person Directory Operations - Update Dynamic Person Group With Person Changes

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Aktualisieren Sie den Namen oder die Benutzerdaten einer vorhandenen dynamischen Personengruppe, und verwalten Sie ihre Mitglieder, indem Sie Personen hinzufügen oder entfernen.
Die Eigenschaften bleiben unverändert, wenn sie sich nicht im Anforderungstext befinden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiVersion	path	True	string	API-Version
dynamicPersonGroupId	path	True	string	ID der dynamischen Personengruppe. RegEx-Muster: ^[a-z0-9-_]+$
endpoint	path	True	string uri	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://{resource-name}.cognitiveservices.azure.com).

Anforderungstext

Name	Typ	Beschreibung
addPersonIds	string[]	Array von personIds, die durch das Personenverzeichnis "Person erstellen" erstellt werden, das hinzugefügt werden soll.
name	string	Benutzerdefinierter Name, maximale Länge beträgt 128.
removePersonIds	string[]	Array von personIds, die vom Personenverzeichnis "Person erstellen" erstellt wurden, das entfernt werden soll.
userData	string	Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.

Antworten

Name	Typ	Beschreibung
202 Accepted		Ein erfolgreicher Aufruf gibt einen leeren Antworttext zurück. Der Dienst hat die Anforderung angenommen und wird in Kürze mit der Verarbeitung beginnen. Der Client kann den Vorgangsstatus und das Ergebnis mithilfe der im Antwortheader "Operation-Location" angegebenen URL abfragen. Die URL läuft in 48 Stunden ab. Die URL stellt den Status bereit, wenn das Personenverzeichnis "Dynamische Personengruppenverweise abrufen" die in dieser Anforderung vorgenommenen Änderungen zurückgibt. Header operation-Location: string
Other Status Codes	FaceErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure AI Face-Abonnement.

Typ: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiche

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

Beispiele

Update DynamicPersonGroup

Beispielanforderung

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"
  ]
}

Beispiel für eine Antwort

Statuscode:

202

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

Definitionen

Name	Beschreibung
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Eine Antwort, die Fehlerdetails enthält.

FaceError

Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
message	string	Eine lesbare Darstellung des Fehlers.

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.