サブスクリプション リソース

  • [アーティクル]

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

サブスクリプションを使用すると、顧客は一定期間サービスを使用できます。 すべてのフィールドがすべてのサブスクリプションに適用されるわけではありません。 多くのフィールドは、サブスクリプションが中断または取り消された場合など、ライフ サイクルの特定の時点でのみ適用されます。

サブスクリプション

Note

サブスクリプション リソースのレート制限は、テナント識別子あたり 1 分あたり 500 要求です。

サブスクリプション リソースは、サブスクリプションのライフ サイクルを表し、サブスクリプションのライフ サイクル全体の状態を定義するプロパティが含まれています。

プロパティ タイプ 内容
id string サブスクリプション識別子です。
offerId string オファーの識別子。
entitlementId string エンタイトルメント識別子 (Azure サブスクリプション ID)。
offerName string オファー名。
friendlyName string 曖昧さをなくすためにパートナーが定義したサブスクリプションのフレンドリ名。
数量 数値 数量。 このプロパティは、ライセンスベースの課金のライセンス数に設定されます。
unitType string サブスクリプションの数量を定義する単位: "ライセンス"、"使用量ベース"、または "特典"。
parentSubscriptionId string 親サブスクリプション識別子を取得または設定します。
creationDate string 作成日を日時形式で取得または設定します。
effectiveStartDate UTC 日時形式の文字列 このサブスクリプションの有効な開始日を日付と時刻の形式で取得または設定します。 このプロパティは、移行されたサブスクリプションをバックアップしたり、別のサブスクリプションに合わせたりするために使用されます。
commitmentEndDate UTC 日時形式の文字列 このサブスクリプションのコミットメント終了日 (日時形式)。 自動更新できないサブスクリプションの場合、このプロパティは将来の日付を表します。 新しいコマースの終了日は包括的です。つまり、期間の終了日は 1 日の終わりです。 従来の終了日は含まれません。
commitmentEndDateTime UTC 日時形式の文字列 このサブスクリプションのコミットメント終了日時 (日時形式)。 自動更新できないサブスクリプションの場合、このプロパティは将来の日付を表します。
status string サブスクリプションの状態: "none"、"active"、"pending"、"suspended"、"expired"、"disabled"、または "deleted"。
autoRenewEnabled boolean サブスクリプションが自動的に更新されるかどうかを示す値を取得します。
billingType string サブスクリプションの課金方法を指定します。"none"、"usage"、"license"、または "benefit" です。
billingCycle string この注文に対してパートナーに請求される頻度を示します。 サポートされる値は、BillingCycleType で検出されたメンバー名です。
hasPurchasableAddons boolean サブスクリプションに購入可能なアドオンがあるかどうかを示す値を取得または設定します。
isTrial boolean サブスクリプションが試用版であるかどうかを示す値。
isMicrosoftProduct boolean サブスクリプションが Microsoft 製品であるかどうかを示す値。
publisherName string 発行元の名前。
アクション 文字列の配列 許可されるアクションを取得または設定します。 指定できる値: "edit"、"cancel"
partnerId string 間接パートナー モデルで使用されるレコードのリセラーの PartnerID。
suspensionReasons 文字列の配列 読み取り専用です。 サブスクリプションが中断された場合は、その理由を示します。
contractType string 読み取り専用です。 コントラクトの種類: "subscription"、"productKey"、または "redemptionCode"。
refundOptions RefundOption リソースの配列 読み 取り 専用。 このサブスクリプションで使用できる払い戻しオプションのセット。
scheduledNextTermInstructions scheduledNextTermInstructions 次の用語の開始時に実行されるスケジュールされた命令を取得または設定します。
nextChargeInstructions nextChargeInstructions 現在の期間の終了時に保留中の支払いサイクル変更に関する次期請求手順の詳細を取得します。
リンク SubscriptionLinks サブスクリプション リンクを取得または設定します。
Orderid string サブスクリプションを開始するために発行された注文の ID。
termDuration string 期間の ISO 8601 表現。 現在サポートされている値は 、P1M (1 か月)、 P1Y (1 年)、 P3Y (3 年) です。
属性 ResourceAttributes サブスクリプションに対応するメタデータ属性。
renewalTermDuration string 期間の ISO 8601 表現。 現在サポートされている値は、 P1M (1 か月) と P1Y (1 年) です。
ProductType アイテムの種類 読み取り専用です。 サブスクリプションの対象となる製品の種類。
consumptionType 超過リソースの配列 特定の顧客の超過分を取得または設定します。
promotionId string サブスクリプションに適用される場合の販売促進識別子。 形式の例: "39NFJQT1PJQB:0001:39NFJQT1Q5KN"
CancellationAllowedUntilDate DateTime キャンセルの最終日。
BillingCycleEndDate DateTime このサブスクリプションの支払いサイクル終了日を日時形式で取得または設定します。
BillingCycleEndDateTime DateTime このサブスクリプション支払いサイクル終了日時を日時形式で取得します。
productOrderId string 特定の製品購入の識別子 (予約や Azure の節約プランなど)。
lineItems SubscriptionLineItem 品目には、特定のサブスクリプションの購入の詳細が含まれます。

SubscriptionLinks リソースは 、 サブスクリプション リソースにアタッチされているリンクのコレクションを記述します。

プロパティ タイプ 説明
offer リンク オファーを取得または設定します。
parentSubscription リンク 親サブスクリプションを取得または設定します。
product リンク サブスクリプションに関連付けられている製品を取得します。
sku リンク サブスクリプションに関連付けられている製品 SKU を取得します。
availability リンク サブスクリプションに関連付けられている製品 SKU の可用性を取得します。
activationLinks リンク サブスクリプションに関連付けられているアクティブ化リンクの一覧を取得します。
セルフ リンク 自己 URI。
next リンク アイテムの次のページ。
previous リンク アイテムの前のページ。

SubscriptionProvisioningStatus

SubscriptionProvisioningStatus リソースは、サブスクリプションのプロビジョニング状態に関する情報を提供します。

プロパティ タイプ 説明
skuId string 製品 SKU を識別する文字列。
status string プロビジョニングの状態を示します:"成功"、"保留中"、または "失敗"。
数量 数値 プロビジョニング後のサブスクリプション数量を提供します。
endDate UTC 日時形式の文字列 サブスクリプションの終了日。
属性 ResourceAttributes メタデータ属性。

scheduledNextTermInstructions

scheduledNextTermInstructions リソースは 、 サブスクリプションの次の期間の開始時に適用される命令を定義します。 スケジュールされた変更が設定されている場合、またはすべての試用版サブスクリプションに対してのみ存在します。

プロパティ タイプ 説明
product product 製品 SKU を識別する GUID 形式の文字列。
数量 数値 プロビジョニング後のサブスクリプション数量を提供します。
customTermEndDate UTC 日時形式の文字列 別のサブスクリプションの終了日に合わせたサブスクリプションのカスタム終了日

Product

scheduledNextTermInstructions.product リソースと、スケジュールされた変更の属性は、次の期間に適用されます。

プロパティ タイプ 説明
productId String 製品の ID。
skuId String プロビジョニング後のサブスクリプション数量を提供します。
availabilityId String この可用性の ID。 この ID は、親 製品 と SKU のコンテキスト内でのみ一意です。 注 : 可用性 ID は時間の経過と同時に変化する可能性があります。 パートナーは、取得後の短い期間内にのみこの値に依存する必要があります。
billingCycle String この注文に対してパートナーに請求される頻度を示します。 サポートされる値は、BillingCycleType で検出されたメンバー名です。
termDuration String 期間の ISO 8601 表現。 現在サポートされている値は、 P1M (1 か月) と P1Y (1 年) です。
promotionId String 次のスケジュールされた期間に適用される昇格識別子。 形式の例: "39NFJQT1PJQB:0001:39NFJQT1Q5KN"

nextChargeInstructions

nextChargeInstructions リソースは、サブスクリプションの次期の開始時に適用される支払いサイクル命令を定義します。 保留中の支払いサイクル変更が保留中の場合にのみ存在します。

プロパティ タイプ 説明
product product 製品 SKU を識別する GUID 形式の文字列。
数量 数値 プロビジョニング後のサブスクリプション数量を提供します。

SubscriptionRegistrationStatus

SubscriptionRegistrationStatus リソースは、サブスクリプション リソースにアタッチされているリンクのコレクションを記述します。

プロパティ タイプ 説明
subscriptionId string サブスクリプション識別子です。
status string 登録状態を示します。"registered"、"registering"、または "notregistered" です。

SupportContact

SupportContact リソースは、顧客のサブスクリプションのサポート連絡先を表します。

プロパティ タイプ 説明
supportTenantId string サポート連絡先のテナント識別子を示す GUID 形式の文字列。
supportMpnId string 連絡先のパートナー識別子。
name string サポート連絡先の名前。
リンク ResourceLinks サポート連絡先の関連リンク。
属性 ResourceAttributes メタデータ属性。 "objectType": "SupportContact" が含まれています。

超過分

超過分リソースは、サブスクリプションの超過分が割り当てられているかどうか、およびリセラーが割り当てられているかどうかに関係なく、消費サブスクリプションの超過分を表します。

プロパティ タイプ 説明
azureEntitlementId string 従量課金サブスクリプション識別子を示す GUID 形式の文字列。
partnerId string サブスクリプションに関連付けられているリセラーのパートナー識別子。
type string 超過分の種類は 、"電話Services" にすることができます。
超過 boolean 超過分が有効かどうかを示す値。
リンク ResourceLinks 超過分関連のリンク。
属性 ResourceAttributes メタデータ属性。 "objectType": "Overage" が含まれています。

RegisterSubscription

RegisterSubscription リソースは、サブスクリプションの登録状態のクエリに使用できるリンクを返します。 登録状態は、Azure サブスクリプションを登録するために正常に受け入れられた要求の応答本文で返されます。

プロパティ タイプ 説明
httpResponseMessage object 登録状態を照会するためのリンクを含む Location ヘッダーを含む HTTP 状態コード 202 "Accepted" を返します。 たとえば、"/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus" のように指定します。

RefundOption

RefundOption リソースは、サブスクリプションに対して可能な払い戻しオプションを表します。

プロパティ タイプ 説明
type string 払い戻しの種類。 サポートされている値は、"Partial" と "Full" です
expiresAfter UTC 日時形式の文字列 このオプションの有効期限が切れたときのタイムスタンプ。 null の場合、払い戻し操作に有効期限はありません。

AzureEntitlement

AzureEntitlement リソースは、サブスクリプションの Azure エンタイトルメントを表します。

プロパティ タイプ 内容
id string エンタイトルメント識別子
friendlyName string 権利のフレンドリ名。
status string 権利の状態。
subscriptionId string エンタイトルメントが属するサブスクリプション識別子。

SubscriptionLineItem

品目には、特定のサブスクリプションの購入の詳細が含まれます。

プロパティ Type 説明
id string サブスクリプションの品目識別子。
friendlyName string あいまいさを解消するためにパートナーによって定義されたサブスクリプションの品目のフレンドリ名。
scope スコープ スコープは、特典が適用される場所を示します。
autoRenewEnabled Boolean サブスクリプションが自動的に更新されるかどうかを示す値を取得します。
status string サブスクリプションの状態: "none"、"active"、"pending"、"suspended"、"expired"、"disabled"、または "deleted"。
purchaseCommitment 購入コミットメント コンピューティング サービスでコミットされた固定金額。

範囲

スコープは、特典が適用される場所を示します。

プロパティ Type 説明
type string 購入のスコープの種類: "Single"、"Shared"、"リソース グループ"、または "管理グループ"。
subscriptionId string 購入に使用される Azure プランの ID。 共有スコープに必要です。
entitlementId string 購入に使用される Azure サブスクリプションの ID。 単一スコープに必要です。
managementGroupId string 購入に使用される管理グループの ID。 このスコープは現在、Azure portal でのみ選択できますが、更新プログラムは PC に反映されます。
resourceGroupId string 購入に使用されるリソース グループの ID。 このスコープは現在、Azure portal でのみ選択できますが、更新プログラムは PC に反映されます。

購入コミットメント

コンピューティング サービスでコミットされた固定金額。

プロパティ Type 説明
金額 string 固定金額コミットメント。
穀物 string コミットメントの期間。
通貨 string コミットメントの通貨。