Person Directory Operations - Update Dynamic Person Group
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 |
---|---|---|---|---|
api
|
path | True |
string |
API-versie |
dynamic
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[a-z0-9-_]+$ |
Id van de dynamische persoonsgroep. |
endpoint
|
path | True |
string (uri) |
Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://{resource-name}.cognitiveservices.azure.com). |
Aanvraagbody
Name | Type | Description |
---|---|---|
name |
string minLength: 1maxLength: 128 |
Door de gebruiker gedefinieerde naam, de maximale lengte is 128. |
userData |
string maxLength: 16384 |
Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De aanvraag is voltooid. |
|
Other Status Codes |
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
PATCH {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id
{
"name": "your_dynamic_person_group_name",
"userData": "your_user_data"
}
Voorbeeldrespons
Definities
Name | Description |
---|---|
Face |
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. |
Face |
Een antwoord met foutdetails. |
User |
Door de gebruiker gedefinieerde velden voor het bijwerken van objecten. |
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 |
Het foutobject. |
UserDefinedFieldsForUpdate
Door de gebruiker gedefinieerde velden voor het bijwerken van objecten.
Name | Type | Description |
---|---|---|
name |
string minLength: 1maxLength: 128 |
Door de gebruiker gedefinieerde naam, de maximale lengte is 128. |
userData |
string maxLength: 16384 |
Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000. |