適用対象: パートナー センター |21Vianet が運営するパートナー センター |Microsoft Cloud for US Government のパートナー センター
パートナーは、顧客向けに購入している NCE ライセンスベースのサブスクリプションの許可されたカスタム期間の終了日を表示できます。 パートナーは、暦月の終わりと一致する終了日、または既存の顧客サブスクリプションと同じ期間の終了日を表示できます。
API は、新しいサブスクリプションの購入に関するカスタム期間の終了日の計算のみをサポートし、既存のサブスクリプションの更新についてはサポートしません。
[前提条件]
パートナー センター認証で説明されている資格証明。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
CustomerTenantId。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は顧客 ID と同じです。
REST 要求
リクエスト構文
| メソッド | URI リクエスト |
|---|---|
| 取得 | {baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates |
クエリ文字列
次の表に、カスタム用語の終了日をフィルター処理して取得するために必要なクエリ文字列を示します。
| 名前: | 必須: | 説明: |
|---|---|---|
| term_duration | イエス | 用語の期間を ISO 8601 で表したもの。 現在サポートされている値は、 P1M (1 か月)、 P1Y (1 年)、 P3Y (3 年) です。 |
| term_start_date | いいえ | 購入予定日。 これは過去のことではありません。 |
| target_coterm_subscription_id | いいえ | コタームのサブスクリプションを識別する GUID 形式の文字列。 |
注
API に渡される P1M または月額の期間は、契約期間の整合性に使用できない共同契約の結果を返す可能性があります。 月の最後の日でない限り、月の 28 日、29 日、または 30 日に終了するサブスクリプションでは、月単位の配置を使用できません。
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。 API の応答は、最大 300 ページ レコードを返します。 入力されたクエリで 300 を超えるレコードが返された場合、応答ヘッダーに継続トークンが提供されます。 継続トークンは、次の要求のヘッダーに入力して、クエリされた追加のページレコードを返すことができます。
リクエストの本文
なし。
REST 応答
成功した場合、このメソッドは、移行された サブスクリプション (移行オブジェクト) の詳細を応答本文で返します。 これには、移行 ID が含まれます。
応答の成功とエラー コード
各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、パートナー センターの REST エラー コード 参照してください。
リクエストURLの例
baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M
応答例
{
"totalCount": 2,
"items": [
{
"allowedCustomTermEndDateType": "calendarMonthAligned",
"allowedCustomTermEndDate": "2023-07-31T00:00:00"
},
{
"allowedCustomTermEndDateType": "subscriptionAligned",
"cotermSubscriptionIds": [
"5fcf618b-1daa-4604-da99-cc3e1c9ee422",
"d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
],
"allowedCustomTermEndDate": "2023-08-01T00:00:00"
}
],
"links": {
"self": {
"uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}