Person Directory Operations - Update Dynamic Person Group

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Uppdatera namnet eller userData för en befintlig dynamisk persongrupp och hantera dess medlemmar genom att lägga till eller ta bort personer.
Egenskaperna behålls oförändrade om de inte finns i begärandetexten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
dynamicPersonGroupId	path	True	string	ID för den dynamiska persongruppen.
endpoint	path	True	string (uri)	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).

Begärandetext

Name	Typ	Description
name	string	Användardefinierat namn, maximal längd är 128.
userData	string	Valfria användardefinierade data. Längden får inte överstiga 16 K.

Svar

Name	Typ	Description
200 OK		Begäran har slutförts.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Update DynamicPersonGroup

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

Definitioner

Name	Description
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.

FaceError

Objekt

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.