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

適用対象:Applies to:

  • パートナー センターPartner Center
  • 21Vianet が運営するパートナー センターPartner Center operated by 21Vianet
  • Microsoft Cloud ドイツのパートナー センターPartner Center for Microsoft Cloud Germany
  • 米国政府機関向け Microsoft Cloud のパートナー センターPartner Center for Microsoft Cloud for US Government

サブスクリプションにより、顧客は一定期間、サービスを使用できます。A subscription lets a customer use a service for a certain period of time. すべてのフィールドがすべてのサブスクリプションに適用されるわけではありません。Not all fields will apply to all subscriptions. 多くのフィールドは、サブスクリプションが中断されたり取り消されたりした場合など、ライフサイクルの特定の時点でのみ適用されます。Many fields only apply at certain points in the life cycle, such as if a subscription is suspended or cancelled.

サブスクリプションSubscription

注意

サブスクリプションリソースには、テナント識別子ごとに1分あたり500の要求のレート制限があります。The Subscription resource has a rate limit of 500 requests per minute per tenant identifier.

サブスクリプションリソースは、サブスクリプションのライフサイクルを表します。サブスクリプションのライフサイクル全体にわたって状態を定義するプロパティが含まれています。The Subscription resource represents the life cycle of a subscription and includes properties that define the states throughout the subscription life cycle.

プロパティProperty TypeType 説明Description
idid stringstring サブスクリプションの識別子です。The subscription identifier.
offerIdofferId stringstring プラン ID。The offer identifier.
entitlementIdentitlementId stringstring 権利識別子 (Azure サブスクリプション ID)。The entitlement identifier (an Azure subscription ID).
offerNameofferName stringstring プラン名。The offer name.
friendlyNamefriendlyName stringstring 明確に区別するためにパートナーによって定義されたサブスクリプションのフレンドリ名。The friendly name for the subscription defined by the partner to help disambiguate.
数量quantity numbernumber 数量。The quantity. たとえば、ライセンスベースの課金の場合、このプロパティはライセンス数に設定されます。For example, in case of license-based billing, this property is set to the license count.
unitTypeunitType stringstring サブスクリプションの数量を定義する単位です。The units defining quantity for the subscription.
parentSubscriptionIdparentSubscriptionId stringstring 親サブスクリプションの識別子を取得します。値の設定もできます。Gets or sets the parent subscription identifier.
creationDatecreationDate stringstring 日付/時刻形式で作成日を取得または設定します。Gets or sets the creation date, in date-time format.
effectiveStartDateeffectiveStartDate UTC 日時形式の文字列string in UTC date time format このサブスクリプションの有効な開始日を日付/時刻形式で取得または設定します。Gets or sets the effective start date for this subscription, in date-time format. 移行されたサブスクリプションの日付をバックアップする場合、または別のサブスクリプションに合わせる場合に使用します。It is used to back date a migrated subscription or to align it with another.
Commitの EnddatecommitmentEndDate UTC 日時形式の文字列string in UTC date time format このサブスクリプションのコミットメント終了日 (日付/時刻形式)。The commitment end date for this subscription, in date-time format. 自動更新できないサブスクリプションの場合、これはそれまでの日付を表します。For subscriptions which are not auto-renewable, this represents a date far, far away in the future.
状態status stringstring サブスクリプションの状態: "なし"、"アクティブ"、"保留中"、"中断"、または "削除済み"。The subscription status: "none", "active", "pending", "suspended", or "deleted".
autoRenewEnabledautoRenewEnabled booleanboolean サブスクリプションが自動的に更新されるかどうかを示す値を取得します。Gets a value indicating whether the subscription is renewed automatically.
種類billingType stringstring サブスクリプションの課金方法を指定します。 "none"、"usage"、"license" です。Specifies how the subscription is billed: "none", "usage", or "license".
billingCyclebillingCycle stringstring パートナーがこの注文に対して課金される頻度を示します。Indicates the frequency with which the partner is billed for this order. サポートされている値は、 BillingCycleTypeで見つかったメンバー名です。Supported values are the member names found in BillingCycleType.
hasPurchasableAddonshasPurchasableAddons booleanboolean サブスクリプションに購入可能なアドオンがあるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the subscription has purchasable add-ons.
isTrialisTrial booleanboolean 評価版サブスクリプションであるかどうかを示す値です。A value indicating whether this is a trial subscription.
Ismicrosoft 製品isMicrosoftProduct booleanboolean このが Microsoft 製品であるかどうかを示す値。A value indicating whether this is a Microsoft product.
publisherNamepublisherName stringstring 発行元の名前。The publisher name.
actionsactions 文字列の配列array of strings 許可されるアクションを取得または設定します。Gets or sets the actions that are allowed. 有効な値: "edit"、"cancel"Possible values: "edit", "cancel"
パートナーpartnerId stringstring 間接パートナーモデルで使用される、レコードの再販業者の MPN ID。The MPN ID of the reseller of record, used in the indirect partner model.
suspensionReasonssuspensionReasons 文字列の配列array of strings 読み取り専用です。Read-only. サブスクリプションが中断された場合は、その理由を示します。If the subscription was suspended, indicates why.
contractTypecontractType stringstring 読み取り専用です。Read-only. コントラクトの種類: "subscription"、"productKey"、または "redemptionCode"。The type of contract: "subscription", "productKey", or "redemptionCode".
refundOptionsrefundOptions RefundOptionリソースの配列array of RefundOption resources 読み取り専用。Read-Only. このサブスクリプションで使用できる返金オプションのセット。The set of refund options available for this subscription.
リンクlinks SubscriptionLinksSubscriptionLinks サブスクリプションリンクを取得または設定します。Gets or sets the subscription links.
orderIdorderId stringstring サブスクリプションを開始するために配置された注文の ID。The ID of the order that was placed to begin the subscription.
termDurationtermDuration stringstring 用語の期間の ISO 8601 表現。An ISO 8601 representation of the term's duration. 現在サポートされている値は、 P1M (1 か月)、 P1Y (1 年)、およびP3Y (3 年) です。The current supported values are P1M (1 month), P1Y (1 year) and P3Y (3 years).
属性attributes ResourceAttributesResourceAttributes サブスクリプションに対応するメタデータ属性。The metadata attributes corresponding to the subscription.
renewalTermDurationrenewalTermDuration stringstring 用語の期間の ISO 8601 表現。An ISO 8601 representation of the term's duration. 現在サポートされている値は、 P1M (1 か月) とP1Y (1 年) です。The current supported values are P1M (1 month) and P1Y (1 year).

Subscriptionlinksリソースには、サブスクリプションリソースにアタッチされたリンクのコレクションが記述されています。The SubscriptionLinks resource describes the collection of links attached to a subscription resource.

プロパティProperty TypeType 説明Description
offeroffer リンクLink オファーを取得または設定します。Gets or sets the offer.
parentSubscriptionparentSubscription リンクLink 親サブスクリプションを取得します。値の設定もできます。Gets or sets the parent subscription.
productproduct リンクLink サブスクリプションに関連付けられている製品を取得します。Gets the product associated with the subscription.
skusku リンクLink サブスクリプションに関連付けられている製品 sku を取得します。Gets the product sku associated with the subscription.
availabilityavailability リンクLink サブスクリプションに関連付けられている製品 sku の可用性を取得します。Gets the product sku availability associated with the subscription.
activationLinksactivationLinks リンクLink サブスクリプションに関連付けられているアクティベーションリンクの一覧を取得します。Gets the list of activation links associated with the subscription.
selfself リンクLink 自己 URI。The self URI.
[次へ]next リンクLink 項目の次のページ。The next page of items.
previousprevious リンクLink 項目の前のページ。The previous page of items.

SubscriptionのプロビジョニングステータスSubscriptionProvisioningStatus

Subscriptionprovisioning statusリソースは、サブスクリプションのプロビジョニング状態に関する情報を提供します。The SubscriptionProvisioningStatus resource provides information about the provisioning status of a subscription.

プロパティProperty TypeType 説明Description
skuIdskuId stringstring 製品 SKU を識別する GUID 形式の文字列。A GUID formatted string that identifies the product SKU.
状態status stringstring プロビジョニングの状態を示します。 "成功"、"保留中"、または "失敗" です。Indicates the provisioning status: "success", "pending" or "failed".
数量quantity numbernumber プロビジョニング後のサブスクリプション数を提供します。Provides the subscription quantity after provisioning.
endDateendDate UTC 日時形式の文字列string in UTC date time format サブスクリプションの終了日。The end date of the subscription.
属性attributes ResourceAttributesResourceAttributes メタデータ属性。The metadata attributes.

SubscriptionRegistrationStatusSubscriptionRegistrationStatus

Subscriptionregistrationstatusリソースには、サブスクリプションリソースにアタッチされたリンクのコレクションが記述されています。The SubscriptionRegistrationStatus resource describes the collection of links attached to a subscription resource.

プロパティProperty TypeType 説明Description
subscriptionIdsubscriptionId stringstring サブスクリプションの識別子です。The subscription identifier.
状態status stringstring 登録状態を示します。 "登録済み"、"登録中"、または "notregistered" です。Indicates the registration status: "registered", "registering" or "notregistered".

サポート連絡先SupportContact

Supportcontactリソースは、お客様のサブスクリプションのサポート連絡先を表します。The SupportContact resource represents a support contact for a customer's subscription.

プロパティProperty TypeType 説明Description
supportTenantIdsupportTenantId stringstring サポート連絡先のテナント識別子を示す GUID 形式の文字列。A GUID formatted string that indicates the support contact's tenant identifier.
supportMpnIdsupportMpnId stringstring 連絡先の Microsoft Partner Network (MPN) 識別子。The contact's Microsoft Partner Network (MPN) identifier.
namename stringstring サポート連絡先の名前。The name of the support contact.
リンクlinks ResourceLinksResourceLinks サポート連絡先関連のリンク。The support contact related links.
属性attributes ResourceAttributesResourceAttributes メタデータ属性。The metadata attributes. "ObjectType": "SupportContact" が含まれています。Contains "objectType": " SupportContact".

RegisterSubscriptionRegisterSubscription

Registersubscriptionリソースは、サブスクリプションの登録状態を照会するために使用できるリンクを返します。The RegisterSubscription resource returns a link that can be used to query the registration status of a subscription. 登録状態は、Azure サブスクリプションを登録するために正常に受け入れられた要求の応答本文で返されます。The registration status is returned in the response body of a successfully accepted request to register an Azure subscription.

プロパティProperty 種類Type 説明Description
httpResponseMessagehttpResponseMessage objectobject HTTP 状態コード 202 "accept" を返します。場所ヘッダーには、登録ステータスをクエリするためのリンクが含まれています。Returns HTTP Status Code 202 "Accepted", with a Location header containing a link to query the registration status. たとえば、"/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus"For example, "/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus"

RefundOptionRefundOption

RefundOptionリソースは、サブスクリプションの返金オプションを表します。The RefundOption resource represents a possible refund option for the subscription.

プロパティProperty 種類Type [説明]Description
typetype stringstring 返金の種類。The type of refund. サポートされている値は、"Partial" と "Full" です。The supported values are "Partial" and "Full"
expiresAfterexpiresAfter UTC 日時形式の文字列string in UTC date time format このオプションが有効期限切れになったときのタイムスタンプ。The timestamp when this option expires. Null の場合は、有効期限がないことを意味します。If null, this means it has no expiration.

AzureEntitlementAzureEntitlement

Azureentitlementリソースは、サブスクリプションの Azure の権利を表します。The AzureEntitlement resource represents the Azure entitlements for the subscription.

プロパティProperty 種類Type 説明Description
idid stringstring 権利識別子The entitlement identifier
friendlyNamefriendlyName stringstring 権利のフレンドリ名。The friendly name of the entitlement.
状態status stringstring 権利の状態。The status of entitlement.
subscriptionIdsubscriptionId stringstring 権利が属しているサブスクリプション識別子。The subscription identifier the entitlement belongs to.