次の方法で共有

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

  • [アーティクル]

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

指定した顧客のデバイス バッチのコレクションを取得する方法。

各デバイス バッチには、ゼロタッチ展開に登録されているデバイスに関する概要の状態情報が含まれています。

対象ロール: 管理エージェント | 販売エージェント

前提条件

  • パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。

  • 顧客 ID です (customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 お客様のアカウント ページで、[顧客のアカウント情報] セクションの Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

C#

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

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

var devicesBatches =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.Get();

サンプル: Console テスト アプリ。 プロジェクト: パートナー センター SDK サンプル Class: GetDevicesBatches.cs

REST 要求

要求の構文

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

URI パラメーター

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

名前 タイプ Required 説明
customer-id string はい 顧客を識別する GUID 形式の文字列。

要求ヘッダー

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

要求本文

なし

要求の例

GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches 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 応答

成功した場合、応答本文には DeviceBatch リソースのコレクションが含まれます。

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

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

応答の例

HTTP/1.1 200 OK
Content-Length: 339
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": 1,
    "items": [{
            "id": "Test batch",
            "status": "finished",
            "creationDate": "2017-07-25T01:51:00",
            "devicesCount": 5,
            "devicesLink": {
                "uri": "/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/Test batch/devices",
                "method": "GET",
                "headers": []
            },
            "attributes": {
                "objectType": "DeviceBatch"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}