デバイスの一覧をアップロードして指定された顧客の新しいバッチを作成する

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

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

デバイスに関する情報の一覧をアップロードして、指定した顧客の新しいバッチを作成する方法。これにより、ゼロタッチ展開での登録用のデバイスバッチが作成され、デバイスとデバイスバッチが指定された顧客に関連付けられます。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、アプリとユーザーの資格情報を使用した認証がサポートされます。パートナーセンター API で App+User 認証を使用する場合は、セキュリティで保護されたアプリモデルに従います。
顧客 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。
DeviceBatchCreationRequest オブジェクトをインスタンス化し、BatchId プロパティを選択した一意の名前に設定し 、Devices プロパティをアップロードするデバイスの一覧に設定します。
IAggregatePartner.Customers.ById メソッドを顧客識別子と共に呼び出して、指定した顧客に対する操作へのインターフェイスを取得して、デバイスバッチ作成要求を処理します。
デバイスバッチ作成要求を使用して DeviceBatches.Create または CreateAsync メソッドを呼び出して、バッチを作成します。

IAggregatePartner partnerOperations;
string selectedCustomerId;

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

DeviceBatchCreationRequest
    newDeviceBatch = new DeviceBatchCreationRequest
{
    BatchId = "SDKTestDeviceBatch",
    Devices = devicesToBeUploaded
};

var trackingLocation =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.Create(newDeviceBatch);

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

REST 要求

要求の構文

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

URI パラメーター

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

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

要求ヘッダー

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

要求本文

要求本文には、 DeviceBatchCreationRequest リソースが含まれている必要があります。

要求の例

POST https://api.partnercenter.microsoft.com/v1/customers/c7f3c849-129f-4b85-a96d-4f8e88b315a3/deviceBatches HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: c245d5f2-1de3-4ae0-9e42-95e38e3cb8ff
MS-CorrelationId: e3f26e6a-044f-4371-ad52-0d91ce4200be
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 340
Expect: 100-continue
Connection: Keep-Alive
{
    "BatchId": "SDKTestDeviceBatch",
    "Devices": [{
            "Id": null,
            "SerialNumber": "1R9-ZNP67",
            "ProductKey": "00329-00000-0003-AA606",
            "HardwareHash": "DummyHash123",
            "Policies": null,
            "CreatedBy": null,
            "UploadedDate": "0001-01-01T00:00:00",
            "AllowedOperations": null,
            "Attributes": {
                "ObjectType": "Device"
            }
        }
    ],
    "Attributes": {
        "ObjectType": "DeviceBatchCreationRequest"
    }
}

重要

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/beba2053-5401-46ff-9223-7e841ed78fbf
MS-CorrelationId: 772871a9-399b-4f3b-b8c7-38f550e4f22a
MS-RequestId: cb82f7d6-f0d9-44d4-82f9-f6eee6e68390
MS-CV: iqOqN0FnaE2y0HcD.0
MS-ServerId: 030020525
Date: Thu, 28 Sep 2017 20:35:35 GMT

Share via