指定されたバッチと顧客のデバイスの一覧を取得する

[アーティクル]
09/11/2024

適用対象: パートナーセンター

この記事では、指定した顧客の指定したデバイスバッチ内のデバイスのコレクションを取得する方法について説明します。各デバイスリソースには、デバイスに関する詳細が含まれています。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、スタンドアロンの App と App+User の両方の資格情報を使用した認証がサポートされています。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、パートナーセンターで [顧客] ワークスペースを選択し、 次に顧客 の一覧から顧客を探し、[ アカウント] を選択します。お客様のアカウントページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。
デバイスバッチ識別子。

C#

指定した顧客の指定したデバイスバッチ内のデバイスのコレクションを取得するには:

指定した顧客の操作へのインターフェイスを取得するには、顧客 ID で IAggregatePartner.Customers.ById メソッドを呼び出します。
DeviceBatches.ById メソッドを呼び出して、指定されたバッチのデバイスバッチコレクション操作へのインターフェイスを取得します。
デバイス プロパティを 取得して、バッチのデバイスコレクション操作へのインターフェイスを取得します。
Get メソッドまたは GetAsync メソッドを呼び出して、デバイスのコレクションを取得します。

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;

var devices =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.ById(selectedDeviceBatchId).Devices.Get();

例については、次を参照してください。

サンプル: コンソールテストアプリ
プロジェクト: パートナーセンター SDK のサンプル
クラス: GetDevices.cs

REST 要求

要求の構文

認証方法	要求 URI
GET	{baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices HTTP/1.1

URI パラメーター

要求を作成するときは、次のパスパラメーターを使用します。

名前	Type	必須	説明
customer-id	string	はい	顧客を識別する GUID 形式の文字列。
devicebatch-id	string	はい	デバイスバッチを識別する文字列識別子。

要求ヘッダー

詳細については、「パートナーセンター REST ヘッダー」を参照してください。

[要求本文]

なし

要求の例

GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/testbatch/devices HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com

REST 応答

成功した場合、応答本文にはデバイスリソースのページングされたコレクションが含まれます。コレクションには、ページ内に 100 台のデバイスが含まれています。 100 台のデバイスの次のページを取得するには、応答本文の continuationToken を後続の要求にMS-ContinuationToken ヘッダーとして含める必要があります。

応答の成功とエラーのコード

各応答には、成功または失敗を示す HTTP ステータスコードと、追加のデバッグ情報が付属しています。このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワークトレースツールを使用します。完全な一覧については、「パートナーセンター REST エラーコード」を参照してください。

応答の例

HTTP/1.1 200 OK
Content-Length: 1742
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 7b3e2e00-b330-4480-9d84-59ace713427f
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 17:52:41 GMT

{
    "totalCount": 2,
    "items":
    [{
            "id": "7c141ea9-2816-4e15-a819-53f6856499ff",
            "serialNumber": "2R9-ZNP67",
            "productKey": "00329-00000-0003-AA6069",
            "modelName": "Precision WorkStation T7500",
            "oemManufacturerName":"Dell Inc.",
            "policies":[{
                    "key": "o_o_b_e",
                    "value": null
                }
            ],
            "uploadedDate":"2017-08-09T14:43:26.0092288-07:00",
            " attributes": {
                "objectType": "Device"
            }
        }, {
            "id": "e528a62f-5031-49f4-bea7-5fafe47388fd",
            "serialNumber": "1234567890",
            "productKey": "12345-67890-09876-54321-13579",
            "modelName": "HP Z420 Workstation",
            "oemManufacturerName": "Hewlett-Packard",
            "policies": [{
                    "key": "o_o_b_e",
                    "value": null
                }
            ],
            "uploadedDate": "2017-08-09T14:35:51.3126144-07:00",
            "attributes": {
                "objectType": "Device"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

次の方法で共有