Share via


新しいコマース移行のクエリを実行する

適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター

顧客 ID、現在のサブスクリプション ID、または外部参照 ID に基づいて移行されたサブスクリプションを照会する方法

対象ロール: グローバル管理者|管理者代理人|販売代理人

前提条件

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

この API は、パートナーが選択したクエリ文字列に基づいてフィルター処理できます。 選択したクエリ文字列には、次の 3 つのオプションのいずれかを指定できます。

  • CustomerTenantId。 顧客の ID がわからない場合は、[顧客] ワークスペースを選択し、顧客の一覧から顧客を選択し、[アカウント] を選択して、パートナー センター検索できます。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID をします。 Microsoft ID は、顧客 ID と同じです。

  • CurrentSubscriptionId (移行されたサブスクリプションのレガシ ID)

  • ExternalReferenceId (パートナー センター SDK 経由でダウンロードできる Batch 移行ツールによって返されるバッチ ID)

REST 要求

要求の構文

認証方法 要求 URI
GET {baseURL}/v1/migrations/newcommerce HTTP/1.1

クエリ文字列

次の表に、新しいコマース移行のフィルター処理と取得に必要なクエリ文字列を示します。 移行のクエリを正常に実行するには、3 つの ID のうち少なくとも 1 つが必要です。 クエリに複数の ID を入力することは受け入れられますが、必須ではありません。

名前 説明
CustomerTenantId 顧客を識別する GUID 形式の文字列。
CurrentSubscriptionId 移行されたレガシ サブスクリプションを識別する GUID 形式の文字列。
ExternalReferenceId 移行バッチを識別する GUID 形式の文字列。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。 API の応答は、最大 300 個のページ レコードを返します。 入力されたクエリで 300 を超えるレコードが返された場合は、応答ヘッダーに継続トークンが提供されます。 継続トークンは、クエリされた追加のページ レコードを返すために、次の要求のヘッダーに入力できます。

要求本文

なし。

REST 応答

成功した場合、このメソッドは、応答本文で 移行されたサブスクリプション (移行オブジェクト) の詳細を返します。 これには、移行 ID が含まれます。

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

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

要求 URL の例

baseurl/v1/migrations/newcommerce?CustomerTenantId=83c51838-fed5-44a4-a275-afa201d53699&CurrentSubscriptionId=6CCC6A93-93E4-4382-AF1F-E51237232833&ExternalReferenceId=9ab61899-0b2b-4320-bd6d-8196c53607d6
baseurl/v1/migrations/newcommerce?CurrentSubscriptionId=6CCC6A93-93E4-4382-AF1F-E51237232833

応答例

[
{
"addOnMigrations": [],
"id": "8ce7115e-0324-41b1-8ca3-7c7ae3b64f75",
"startedTime": "2022-02-24T23:50:30.4384819Z",
"completedTime": "2022-02-24T23:53:14.0813711Z",
"currentSubscriptionId": "9E289691-2FF3-419D-B39B-26B3E5A817FB",
"status": "Completed",
"customerTenantId": "ce6fcc21-c276-447b-9605-874decb9024b",
"catalogItemId": "CFQ7TTC0LF8Q:0001:CFQ7TTC0KQDF",
"newCommerceSubscriptionId": "f2d6534b-9e30-4cf5-c7b0-5d6393dbf12d",
"newCommerceOrderId": "09714c93092a",
"subscriptionEndDate": "2023-02-14T00:00:00Z",
"quantity": 2,
"termDuration": "P1Y",
"billingCycle": "Monthly",
"purchaseFullTerm": false,
"externalReferenceId": "771317a4-275d-47d9-9724-3eefa4a168ad"
}
]