你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Person Directory Operations - Get Dynamic Person Group

服务:

Azure AI Services

API 版本:

v1.2-preview.1

检索动态人员组的信息，包括其名称和 userData。
此 API 仅返回动态人员组信息，请改用人员目录“获取动态人员组人员”来检索动态人员组下的人员信息。

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

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
dynamicPersonGroupId	path	True	string	动态人员组的 ID。 正则表达式模式: ^[a-z0-9-_]+$
endpoint	path	True	string uri	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。

响应

名称	类型	说明
200 OK	DynamicPersonGroup	成功的呼叫返回动态人员组的信息。
Other Status Codes	FaceErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 URL: https://api.example.com/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Get DynamicPersonGroup

示例请求

HTTP

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

示例响应

状态代码:

200

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

定义

名称	说明
DynamicPersonGroup	引用 Person 目录“创建人员”的容器。
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。

DynamicPersonGroup

引用 Person 目录“创建人员”的容器。

名称	类型	说明
dynamicPersonGroupId	string	动态人员组的 ID。
name	string	用户定义的名称，最大长度为 128。
userData	string	可选用户定义数据。 长度不应超过 16K。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
message	string	错误的人工可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	FaceError	错误对象。