获取受众数据

项目
02/14/2024

在 Microsoft 硬件 API 中使用以下方法，获取适用于组织的受众。受众允许你将发布限制为具有特定配置的计算机。例如，测试部署只能传递给安装了特定注册表项的客户端。

https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences

在使用这些方法之前，产品和提交必须已存在于你的开发人员中心帐户中。若要创建或管理产品提交，请参阅管理产品提交中的方法。

说明	Method	URI
获取适用于组织的受众列表。	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences`

先决条件

完成 Microsoft 硬件 API 的所有先决条件（如果尚未这样做），然后尝试使用这其中的任何方法。

数据资源

用于获取发货标签数据的 Microsoft 硬件 API 方法使用以下 JSON 数据资源。

受众资源

此资源表示适用于组织的受众。

{
  "id": "9f4f44d8-bfec-48c6-a02c-2d9ea220f6e2",
  "name": "My Custom Audience",
  "description": "Matches machines that have the following registry key: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\FOO-BAR",
  "audienceName": "Sample_Audience_Key"
}

此资源具有以下值

值	类型	描述
id	string	受众的 ID。这是将在发货标签中接收或发送的值。
name	string	受众的友好名称
description	string	受众的说明
audienceName	string	受众的名称

请求

此方法具有以下语法。

方法	请求 URI
GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience`

请求头

标头	类型	说明
授权	字符串	必需。 Microsoft持有者*<令牌形式的* Entra ID 访问令牌。>
接受	string	可选。指定内容的类型。允许的值是“application/json”

请求参数

请勿为此方法提供请求参数。

请求正文

请勿为此方法提供请求正文。

请求示例

以下示例演示了如何检索适用于组织的受众的相关信息。

GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience HTTP/1.1
Authorization: Bearer <your access token>

响应

以下示例演示了对适用于组织的所有受众的成功请求返回的 JSON 响应正文。有关响应正文中的值的详细信息显示在示例后面的表中。

{
  "value": [
    {
      "id": "9f4f44d8-bfec-48c6-a02c-2d9ea220f6e2",
      "name": "Test Registry Key",
      "description": "Matches machines that have the following registry key: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\Test Drivers - use at own risk",
      "audienceName": "Test_Registry_Key"
    },
    {
      "id": "10415bba-3572-421b-a3de-d0d347bace5f",
      "name": "Test Audience 2",
      "description": "Additional Audience",
      "audienceName": "Test_Audeince_2"
    }
  ],
  "links": [
    {
      "href": "https://manage.devcenter..microsoft.com/api/v1/hardware/audiences",
      "rel": "self",
      "method": "GET"
    }
  ]
}