対象ユーザー データの取得

組織の対象ユーザーを取得するには、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

要求ヘッダー

Header	型	説明
承認	string	必須。 Bearer<token> 形式の Microsoft Entra ID アクセス トークン。
accept	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"
    }
  ]
}

このリソースには、次の値があります。

値	種類	説明
value	配列	各対象ユーザーに関する情報を含むオブジェクトの配列です。 各オブジェクトのデータについて詳しくは、「対象ユーザー」をご覧ください。
links	配列	包含エンティティに関する有用なリンクを持つオブジェクトの配列。 詳しくは、「リンク オブジェクト」をご覧ください。

関連項目

• ハードウェア ダッシュボード API のサンプル (GitHub)