カスタム期間の終了日の設定

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

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

パートナーは、顧客向けに購入している NCE ライセンスベースのサブスクリプションに対して許可されているカスタム期間の終了日を表示できます。パートナーは、カレンダー月の終了日に合わせた終了日、または既存の顧客サブスクリプションとの共同期間を表示できます。

API では、新しいサブスクリプションの購入に関するカスタム期間の終了日の計算のみがサポートされ、既存のサブスクリプションの更新はサポートされません。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、スタンドアロンの App と App+User の両方の資格情報を使用した認証がサポートされています。
CustomerTenantId。顧客の ID がわからない場合は、[顧客] ワークスペースを選択し、顧客の一覧から顧客を選択し、[アカウント] を選択して、パートナーセンターで検索できます。顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID と同じです。

REST 要求

要求の構文

認証方法	要求 URI
GET	{baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates

クエリ文字列

次の表に、カスタム用語の終了日をフィルター処理して取得するために必要なクエリ文字列を示します。

Name:	必須:	説明:
term_duration	はい	期間の ISO 8601 表現。現在サポートされている値は、P1M (1 か月)、 P1Y (1 年)、 P3Y (3 年) です。
term_start_date	いいえ	購入予定日。これは過去にはできません。
target_coterm_subscription_id	いいえ	共同使用するサブスクリプションを識別する GUID 形式の文字列。

要求ヘッダー

詳細については、「パートナーセンター 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"
    }
 }

Share via