適用対象: パートナー センター |21Vianet が運営するパートナー センター |Microsoft Cloud for US Government のパートナー センター
サブスクリプションを使用すると、顧客は一定期間サービスを使用できます。 すべてのフィールドがすべてのサブスクリプションに適用されるわけではありません。 多くのフィールドは、サブスクリプションが中断または取り消された場合など、ライフ サイクルの特定の時点でのみ適用されます。
サブスクリプション
注
サブスクリプション リソースのレート制限は、テナント識別子あたり 1 分あたり 500 要求です。
サブスクリプション リソースは、サブスクリプションのライフ サイクルを表し、サブスクリプションのライフ サイクル全体の状態を定義するプロパティが含まれています。
| プロパティ | タイプ | 説明 |
|---|---|---|
| ID | 文字列 | サブスクリプション識別子です。 |
| offerId | 文字列 | オファーの識別子。 |
| 権利ID | 文字列 | エンタイトルメント識別子 (Azure サブスクリプション ID)。 |
| オファー名 | 文字列 | オファー名。 |
| フレンドリーネーム | 文字列 | あいまいさを解消するためにパートナーによって定義されたサブスクリプションのフレンドリ名。 |
| 量 | 数 | 数量。 このプロパティは、ライセンスベースの請求におけるライセンス数に設定されます。 |
| ユニットタイプ | 文字列 | サブスクリプションの数量を定義する単位: "ライセンス"、"使用量ベース"、または "特典"。 |
| 親サブスクリプションID | 文字列 | 親サブスクリプション識別子を取得または設定します。 |
| 作成日 | 文字列 | 作成日を日時形式で取得または設定します。 |
| 有効開始日 | UTC 日時形式の文字列 | このサブスクリプションの有効な開始日を日付と時刻の形式で取得または設定します。 このプロパティは、移行されたサブスクリプションをバックアップしたり、別のサブスクリプションに合わせたりするために使用されます。 |
| コミットメント終了日 | UTC 日時形式の文字列 | このサブスクリプションのコミットメント終了日 (日時形式)。 自動更新できないサブスクリプションの場合、このプロパティは将来の日付を表します。 新しいコマースの終了日は包括的です。つまり、期間の終了日は 1 日の終わりです。 従来の終了日は含まれません。 |
| コミットメント終了日時 | UTC 日時形式の文字列 | このサブスクリプションのコミットメント終了日時 (日時形式)。 自動更新できないサブスクリプションの場合、このプロパティは将来の日付を表します。 |
| 状態 | 文字列 | サブスクリプションの状態: 「なし」、「有効」、「保留中」、「一時停止」、「期限切れ」、「無効」または「削除済み」。 |
| オートリニュー有効 | ブーリアン | サブスクリプションが自動的に更新されるかどうかを示す値を取得します。 |
| 請求タイプ | 文字列 | サブスクリプションの課金方法を指定します。"none"、"usage"、"license"、または "benefit" です。 |
| billingCycle | 文字列 | この注文に対してパートナーに請求される頻度を示します。 サポートされている値は、 BillingCycleType で見つかったメンバー名です。 |
| 購入可能なアドオンがあります | ブーリアン | サブスクリプションに購入可能なアドオンがあるかどうかを示す値を取得または設定します。 |
| isTrial | ブーリアン | サブスクリプションが試用版かどうかを示す値。 |
| isMicrosoftProduct | ブーリアン | サブスクリプションが Microsoft 製品かどうかを示す値。 |
| 出版社名 | 文字列 | 発行元名。 |
| アクション | 文字列の配列 | 許可されるアクションを取得または設定します。 指定できる値: "edit"、"cancel" |
| パートナーID | 文字列 | 間接パートナー モデルで使用されるレコードのリセラーの PartnerID。 |
| 追加パートナーID (additionalPartnerIds) | 文字列の配列 | EU/EFTA makets のディストリビューターのみが使用する PartnerID の収集。 |
| 停止理由 | 文字列の配列 | 読み取り専用。 サブスクリプションが中断された場合は、その理由を示します。 |
| 契約タイプ | 文字列 | 読み取り専用。 コントラクトの種類: "subscription"、"productKey"、または "redemptionCode"。 |
| 返金オプション | RefundOption リソースの配列 | 読み取り専用です。 このサブスクリプションで使用できる払い戻しオプションのセット。 |
| 次回の予定に関する指示 | scheduledNextTermInstructions (スケジュール済み次の用語の指示) | 次のタームが始まるときに実行されるスケジュールされた命令を取得と設定を行います。 |
| 次の充電指示 | nextChargeInstructions | 現在の期間の終了時に保留中の請求サイクルの変更に関する次期請求手順の詳細を取得します。 |
| リンク | SubscriptionLinks | サブスクリプション リンクを取得または設定します。 |
| 注文ID | 文字列 | サブスクリプションを開始するための注文ID。 |
| termDuration (期間) | 文字列 | 用語の期間を ISO 8601 で表したもの。 現在サポートされている値は、 P1M (1 か月)、 P1Y (1 年)、 P3Y (3 年) です。 |
| termLifeCycleState | 文字列 | サブスクリプションの契約期間のライフサイクル状態を表します。 現在サポートされている値は GA (一般提供)、EndOfSale、および EndOfSaleWithConversions (変換可能) です。 |
| 属性 | ResourceAttributes | サブスクリプションに対応するメタデータ属性。 |
| 更新期間 | 文字列 | 用語の期間を ISO 8601 で表したもの。 現在サポートされている値は 、P1M (1 か月) と P1Y (1 年) です。 |
| 製品タイプ | アイテムタイプ | 読み取り専用。 サブスクリプションの対象となる製品の種類。 |
| 消費タイプ | 超過リソースの配列 | 特定の顧客の超過分を取得または設定します。 |
| promotionId | 文字列 | サブスクリプションに適用されている場合の昇格識別子。 形式の例: "39NFJQT1PJQB:0001:39NFJQT1Q5KN" |
| キャンセル許可期限日 | 日付と時間 | 取り消しの最後の日付。 |
| 請求サイクル終了日 | 日付と時間 | このサブスクリプションの請求サイクルの終了日を日付/時刻形式で取得または設定します。 |
| 請求サイクル終了日時 | 日付と時間 | このサブスクリプションの請求サイクルの終了日時を日時形式で取得します。 |
| productOrderId(製品注文ID) | 文字列 | 特定の製品購入の識別子 (予約や Azure の節約プランなど)。 |
| lineItems | サブスクリプションラインアイテム | 品目には、特定のサブスクリプションの購入の詳細が含まれます。 |
サブスクリプションリンク
SubscriptionLinks リソースは、サブスクリプション リソースにアタッチされているリンクのコレクションを記述します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| オファー | リンク | オファーを取得または設定します。 |
| 親サブスクリプション | リンク | 親サブスクリプションを取得または設定します。 |
| 製品 | リンク | サブスクリプションに関連付けられている製品を取得します。 |
| エスケーユー | リンク | サブスクリプションに関連付けられている製品 SKU を取得します。 |
| 可用性 | リンク | サブスクリプションに関連付けられている製品 SKU の可用性を取得します。 |
| アクティベーションリンク | リンク | サブスクリプションに関連付けられているアクティブ化リンクの一覧を取得します。 |
| 自己 | リンク | セルフ URI。 |
| 次に | リンク | アイテムの次のページ。 |
| 前の | リンク | アイテムの前のページ。 |
サブスクリプションプロビジョニングステータス
SubscriptionProvisioningStatus リソースは、サブスクリプションのプロビジョニング状態に関する情報を提供します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| スクイド | 文字列 | 製品 SKU を識別する文字列。 |
| 状態 | 文字列 | プロビジョニングの状態を示します:"成功"、"保留中"、または "失敗"。 |
| 量 | 数 | プロビジョニング後のサブスクリプション数量を提供します。 |
| 終了日 | UTC 日時形式の文字列 | サブスクリプションの終了日。 |
| 属性 | ResourceAttributes | メタデータ属性。 |
次回の予定に関する指示
scheduledNextTermInstructions リソースは、サブスクリプションの次の期間の開始時に適用される命令を定義します。 スケジュールされた変更が設定されている場合、またはすべての試用版サブスクリプションに対してのみ存在します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 製品 | 製品 | 製品 SKU を識別する GUID 形式の文字列。 |
| 量 | 数 | プロビジョニング後のサブスクリプション数量を提供します。 |
| カスタム期間終了日 | UTC 日時形式の文字列 | 別のサブスクリプションの終了日に合わせたサブスクリプションのカスタム終了日 |
プロダクト
scheduledNextTermInstructions.product リソースと、スケジュールされた変更の属性は、次の期間に適用されます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| productId | 糸 | 製品の ID。 |
| スクイド | 糸 | プロビジョニング後のサブスクリプション数量を提供します。 |
| 可用性ID | 糸 | この可用性の ID。 この ID は、親 製品 と SKU のコンテキスト内でのみ一意です。 手記 可用性 ID は、時間の経過と同時に変化する可能性があります。 パートナーは、取得後の短い期間内にのみこの値に依存する必要があります。 |
| billingCycle | 糸 | この注文に対してパートナーに請求される頻度を示します。 サポートされている値は、 BillingCycleType で見つかったメンバー名です。 |
| termDuration (期間) | 糸 | 用語の期間を ISO 8601 で表したもの。 現在サポートされている値は 、P1M (1 か月) と P1Y (1 年) です。 |
| promotionId | 糸 | 次のスケジュールされた期間に適用される昇格識別子。 形式の例: "39NFJQT1PJQB:0001:39NFJQT1Q5KN" |
次の充電指示
nextChargeInstructions リソースは、サブスクリプションの次の期間の開始時に適用される課金サイクル命令を定義します。 保留中の請求サイクルの変更がある場合にのみ存在します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 製品 | 製品 | 製品 SKU を識別する GUID 形式の文字列。 |
| 量 | 数 | プロビジョニング後のサブスクリプション数量を提供します。 |
サブスクリプション登録ステータス
SubscriptionRegistrationStatus リソースは、サブスクリプション リソースにアタッチされているリンクのコレクションを記述します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| サブスクリプションID | 文字列 | サブスクリプション識別子です。 |
| 状態 | 文字列 | 登録状態を示します。"registered"、"registering"、または "notregistered" です。 |
サポート連絡先
SupportContact リソースは、顧客のサブスクリプションのサポート連絡先を表します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| supportTenantId | 文字列 | サポート連絡先のテナント識別子を示す GUID 形式の文字列。 |
| supportMpnId | 文字列 | 連絡先のパートナー識別子。 |
| 名前 | 文字列 | サポート連絡先の名前。 |
| リンク | リソースリンク | サポート連絡先の関連リンク。 |
| 属性 | ResourceAttributes | メタデータ属性。 "objectType": "SupportContact" が含まれています。 |
超過分
超過分リソースは、超過分が消費サブスクリプションに割り当てられているかどうか、そしてさらにはリセラーに割り当てられているかどうかを表します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| azureEntitlementId（Azureの権利付与ID） | 文字列 | 従量課金サブスクリプション識別子を示す GUID 形式の文字列。 |
| パートナーID | 文字列 | サブスクリプションに関連付けられているリセラーのパートナー識別子。 |
| 型 | 文字列 | 超過分の種類は "PhoneServices" にすることができます |
| 超過分 | ブーリアン | 超過分が有効かどうかを示す値。 |
| リンク | リソースリンク | 超過分関連のリンク。 |
| 属性 | ResourceAttributes | メタデータ属性。 "objectType": "Overage" が含まれています。 |
登録サブスクリプション
RegisterSubscription リソースは、サブスクリプションの登録状態のクエリに使用できるリンクを返します。 登録状態は、Azure サブスクリプションを登録するために正常に受け入れられた要求の応答本文で返されます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| httpResponseMessage | オブジェクト | 登録状態を照会するためのリンクを含む Location ヘッダーを含む HTTP 状態コード 202 "Accepted" を返します。 たとえば、"/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus" のように指定します。 |
返金オプション
RefundOption リソースは、サブスクリプションに対して可能な払い戻しオプションを表します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 型 | 文字列 | 払い戻しの種類。 サポートされている値は、"Partial" と "Full" です |
| 有効期限後 | UTC 日時形式の文字列 | このオプションの有効期限が切れたときのタイムスタンプ。 null の場合、払い戻し操作に有効期限はありません。 |
Azureエンタイトルメント
AzureEntitlement リソースは、サブスクリプションの Azure エンタイトルメントを表します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| ID | 文字列 | 権利識別子 |
| フレンドリーネーム | 文字列 | 権利のフレンドリ名。 |
| 状態 | 文字列 | 権利の状況。 |
| サブスクリプションID | 文字列 | エンタイトルメントが属するサブスクリプション識別子。 |
サブスクリプションラインアイテム
品目には、特定のサブスクリプションの購入の詳細が含まれます。
| 財産 | タイプ | 説明 |
|---|---|---|
| ID | 文字列 | サブスクリプションの品目識別子。 |
| フレンドリーネーム | 文字列 | あいまいさを解消するためにパートナーによって定義されたサブスクリプションの品目のフレンドリ名。 |
| スコープ | スコープ | スコープは、特典が適用される場所を示します。 |
| オートリニュー有効 | ブール値 | サブスクリプションが自動的に更新されるかどうかを示す値を取得します。 |
| 状態 | 文字列 | サブスクリプションの状態: 「なし」、「有効」、「保留中」、「一時停止」、「期限切れ」、「無効」または「削除済み」。 |
| 購入契約 | 購入コミットメント | コンピューティング サービスでコミットされた固定金額。 |
Scope
スコープは、特典が適用される場所を示します。
| 財産 | タイプ | 説明 |
|---|---|---|
| 型 | 文字列 | 購入のスコープの種類: "Single"、"Shared"、"リソース グループ"、または "管理グループ"。 |
| サブスクリプションID | 文字列 | 購入に使用される Azure プランの ID。 共有スコープに必要です。 |
| 権利ID | 文字列 | 購入に使用される Azure サブスクリプションの ID。 単一スコープに必要です。 |
| 管理グループID | 文字列 | 購入に使用される管理グループの ID。 このスコープは現在、Azure portal でのみ選択できますが、更新プログラムは PC に反映されます。 |
| リソースグループID | 文字列 | 購入に使用されるリソース グループの ID。 このスコープは現在、Azure portal でのみ選択できますが、更新プログラムは PC に反映されます。 |
購入コミットメント
コンピューティング サービスでコミットされた固定金額。
| 財産 | タイプ | 説明 |
|---|---|---|
| 金額 | 文字列 | 固定金額コミットメント。 |
| グレイン | 文字列 | コミットメントの期間。 |
| 通貨 | 文字列 | コミットメントの通貨。 |