Share via

新しいコマース移行スケジュールを取得する

  • [アーティクル]

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

この記事では、新しいコマース移行スケジュールを取得する方法について説明します。

重要

この API は現在、サンドボックス テナントでのみ使用できます。

前提条件

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

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

  • 現在のサブスクリプション ID

REST 要求

パートナーがクエリを実行するには、2 つの異なる方法があります。

  • 特定のスケジュールに対してクエリを実行するには
  • 特定の条件のスケジュールの一覧を取得する

要求の構文

方法 要求 URI
GET {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID}

URI パラメーター

次の表に、新しいコマース移行を作成するために必要なクエリ パラメーターを示します。

名前 Type 必須 説明
customer-tenant-id string はい 顧客を識別する GUID 形式の文字列。
方法 要求 URI
GET {baseURL}/v1/migrations/newcommerce/schedules?CustomerTenantId={customer-tenant-id}

URI パラメーター

次の表に、新しいコマース移行を作成するために必要なクエリ パラメーターを示します。 クエリ パラメーターは誰でも使用できます。

名前 Type 説明
customerTenantId string 顧客を識別する GUID 形式の文字列。
currentSubscriptionID string 現在のサブスクリプション ID を識別する GUID 形式の文字列
externalReferenceID string 移行バッチを識別する GUID 形式の文字列

要求ヘッダー

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

応答本文

次の表では、応答の サブスクリプション のプロパティについて説明します。

Property Type 必須 説明
currentSubscriptionId string はい 移行に検証が必要なサブスクリプションを示すサブスクリプション識別子。
termDuration string いいえ 期間は、移行時に変更するように指定できます。
billingCycle string いいえ 課金サイクルは、移行時に変更するように指定できます。
purchaseFullTerm bool いいえ 移行時に NCE で新しい用語を開始できます。
数量 int いいえ サブスクリプションのライセンス数は、移行時に増減できます。
customTermEndDate DATETIME いいえ 終了日は、既存の試用版以外の OnlineServicesNCE サブスクリプションまたはカレンダー月に合わせて設定できます。 サブスクリプションの終了日の調整の詳細については、パートナー センターでのサブスクリプションの終了日の調整に関するページを参照してください。
targetDate DATETIME いいえ 移行をスケジュールする日付をターゲットにします。
migrateOnRenewal bool いいえ 更新時にスケジュールを行う必要があるかどうかを示します
status string いいえ 移行スケジュールの状態
createdTime DATETIME いいえ スケジュールが作成されたとき
lastModifiedTime DATETIME いいえ スケジュールが最後に変更された日時

REST 応答

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

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

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

応答例

[
{
"id": "f016c025-a873-47af-8b52-2516fbef4c65",
"currentSubscriptionId": "c6105a9c-36cb-4f88-92ea-9573040725c4",
"subscriptionEndDate": "2023-07-19T00:00:00Z",
"status": "Created",
"customerTenantId": "6f297517-16e6-4313-8c6d-4e10496d2871",
"quantity": 25,
"termDuration": "P1Y",
"billingCycle": "Monthly",
"purchaseFullTerm": false,
"targetDate": "2022-10-30T00:00:00",
"createdTime": "2022-10-18T21:20:50.9668605+00:00",
"lastModifiedTime": "2022-10-18T21:29:32.8992819+00:00"
}
]

関連項目