デバイスの一覧を指定された顧客の既存のバッチにアップロードする

[アーティクル]
03/04/2024

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

指定した顧客の既存のバッチにデバイスに関する情報の一覧をアップロードする方法。これにより、デバイスが既に作成されているデバイスバッチに関連付けられます。

前提条件

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

C#

デバイスの一覧を既存のデバイスバッチにアップロードするには、まず、Device 型の新しい [List/dotnet/api/system.collections.generic.list-1) をインスタンス化し、その一覧にデバイスを設定します。各デバイスを識別するために、設定されたプロパティの次の組み合わせが少なくとも必要です。

HardwareHash + ProductKey。
HardwareHash + SerialNumber。
HardwareHash + ProductKey + SerialNumber。
HardwareHash のみ。
ProductKey のみ。
SerialNumber + OemManufacturerName + ModelName。

次に、顧客識別子を指定して IAggregatePartner.Customers.ById メソッドを呼び出して、指定した顧客に対する操作へのインターフェイスを取得します。次に、デバイスバッチ識別子を 使用して DeviceBatches.ById メソッドを呼び出して、指定されたバッチの操作へのインターフェイスを取得します。最後に、デバイスの一覧を使用して Devices.Create または CreateAsync メソッドを呼び出し、デバイスをデバイスバッチに追加します。

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;

List<Device> devicesToBeUploaded = new List<Device>
{
    new Device
    {
        HardwareHash = "DummyHash1234",
        ProductKey = "00329-00000-0003-AA606",
        SerialNumber = "2R9-ZNP67"
    },

    new Device
    {
        HardwareHash = "DummyHash12345",
        ProductKey = "00329-00000-0003-AA606",
        SerialNumber = "2R9-ZNP67"
    }
};

var trackingLocation =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.ById(selectedDeviceBatchId).Devices.Create(devicesToBeUploaded);

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

REST 要求

要求の構文

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

URI パラメーター

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

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

要求ヘッダー

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

要求本文

要求本文には、Device オブジェクトの配列が含まれている必要があります。デバイスを識別するための次のフィールドの組み合わせが受け入れられます。

hardwareHash + productKey。
hardwareHash + serialNumber。
hardwareHash + productKey + serialNumber。
hardwareHash のみ。
productKey のみ。
serialNumber + oemManufacturerName + modelName。

要求の例

POST https://api.partnercenter.microsoft.com/v1/customers/c7f3c849-129f-4b85-a96d-4f8e88b315a3/deviceBatches/Test/devices HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e286d69b-7f5f-4098-8999-21d3b54e4e47
MS-CorrelationId: 772871a9-399b-4f3b-b8c7-38f550e4f22a
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 482
Expect: 100-continue

[{
        "Id": null,
        "SerialNumber": "2R9-ZNP67",
        "ProductKey": "00329-00000-0003-AA606",
        "HardwareHash": "DummyHash1234",
        "Policies": null,
        "CreatedBy": null,
        "UploadedDate": "0001-01-01T00:00:00",
        "AllowedOperations": null,
        "Attributes": {
            "ObjectType": "Device"
        }
    }, {
        "Id": null,
        "SerialNumber": "2R9-ZNP67",
        "ProductKey": "00329-00000-0003-AA606",
        "HardwareHash": "DummyHash12345",
        "Policies": null,
        "CreatedBy": null,
        "UploadedDate": "0001-01-01T00:00:00",
        "AllowedOperations": null,
        "Attributes": {
            "ObjectType": "Device"
        }
    }
]

重要

2023 年 6 月の時点で、最新のパートナーセンター .NET SDK リリース 3.4.0 がアーカイブされるようになりました。 SDK リリースは、有用な情報が記載された readme ファイルと一緒に GitHub からダウンロードできます。

パートナーの皆様には、パートナーセンター REST API を引き続き使用することをお勧めします。

REST 応答

成功した場合、応答には、デバイスのアップロード状態を 取得するために使用できる URI を持つ Location ヘッダーが含まれます。他の関連する REST API で使用するために、この URI を保存します。

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

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

応答の例

HTTP/1.1 202 Accepted
Content-Length: 0
Location: /customers/c7f3c849-129f-4b85-a96d-4f8e88b315a3/batchJobStatus/16c00110-e79a-433d-aa28-f69dd60df671
MS-CorrelationId: 772871a9-399b-4f3b-b8c7-38f550e4f22a
MS-RequestId: e286d69b-7f5f-4098-8999-21d3b54e4e47
MS-CV: OBkGN9pSN0a5xvua.0
MS-ServerId: 101112012
Date: Thu, 28 Sep 2017 20:08:46 GMT

Share via