新しいコマース移行スケジュールを取得する
適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター
この記事では、新しいコマース移行スケジュールを取得する方法について説明します。
重要
この API は現在、サンドボックス テナントでのみ使用できます。
前提条件
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
顧客 ID です (
customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 お客様のアカウント ページで、[顧客のアカウント情報] セクションの Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。現在のサブスクリプション ID
REST 要求
パートナーがクエリを実行する方法は 2 つあります。
- パートナーはクエリを実行して特定のスケジュールを取得できます
- パートナーはクエリを実行して、特定の条件のスケジュールの一覧を取得できます
要求の構文
| Method | 要求 URI |
|---|---|
| GET | {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID} |
URI パラメーター
次の表に、新しいコマース移行を作成するために必要なクエリ パラメーターを示します。
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| customer-tenant-id | string | はい | 顧客を識別する GUID 形式の文字列。 |
| Method | 要求 URI |
|---|---|
| GET | {baseURL}/v1/migrations/newcommerce/schedules?CustomerTenantId={customer-tenant-id} |
URI パラメーター
次の表に、新しいコマース移行を作成するために必要なクエリ パラメーターを示します。 クエリ パラメーターは誰でも使用できます。
| 名前 | タイプ | 説明 |
|---|---|---|
| customerTenantId | string | 顧客を識別する GUID 形式の文字列。 |
| currentSubscriptionID | string | 現在のサブスクリプション ID を識別する GUID 形式の文字列 |
| externalReferenceID | string | 移行バッチを識別する GUID 形式の文字列 |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
応答の本文
次の表では、応答の サブスクリプション プロパティについて説明します。
| プロパティ | Type | 必須 | 説明 |
|---|---|---|---|
| currentSubscriptionId | string | はい | 移行に検証が必要なサブスクリプションを示すサブスクリプション識別子。 |
| termDuration | string | いいえ | 移行に適用される期間。 |
| billingCycle | string | いいえ | 移行に適用される課金サイクル。 |
| purchaseFullTerm | [bool] | いいえ | 移行が新しい用語を開始するかどうか。 |
| quantity | 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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"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"
}
]