订阅资源

项目
01/11/2024

适用于：合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心

订阅允许客户在特定时间段内使用服务。并非所有字段都应用于所有订阅。许多字段仅在生命周期中的某些点应用，例如订阅暂停或取消。

properties	类型	描述
ID	string	订阅标识符。
offerId	string	套餐标识符。
entitlementId	string	权利标识符（Azure 订阅 ID）。
offerName	string	产品/服务名称。
friendlyName	string	合作伙伴定义的订阅的友好名称，以帮助消除歧义。
quantity	数字	数量。此属性设置为基于许可证的计费的许可证计数。
unitType	string	定义订阅数量单位：“许可证”、“基于使用情况”或“权益”。
parentSubscriptionId	string	获取或设置父订阅标识符。
creationDate	string	获取或设置创建日期（以日期时间格式）。
effectiveStartDate	采用 UTC 日期/时间格式的字符串	获取或设置此订阅的有效开始日期（以日期时间格式）。此属性用于备份已迁移的订阅或使其与其他订阅保持一致。
commitmentEndDate	采用 UTC 日期/时间格式的字符串	此订阅的承诺结束日期，采用日期时间格式。对于不可自动续订的订阅，此属性表示将来遥远的日期。新的商业结束日期是包容性的，这意味着术语的结束时间在全天结束。旧版结束日期不包含在内。
commitmentEndDateTime	采用 UTC 日期/时间格式的字符串	此订阅的承诺结束日期和时间，采用日期时间格式。对于不可自动续订的订阅，此属性表示将来遥远的日期。
状态	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	发布者名称。
actions	字符串数组	获取或设置允许的操作。可能的值：“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 年）。
attributes	ResourceAttributes	对应于订阅的元数据属性。
renewalTermDuration	string	术语持续时间的 ISO 8601 表示形式。当前支持的值是 P1M （1 个月）和 P1Y （1 年）。
ProductType	ItemType	只读。订阅要用于的产品类型。
consumptionType	超额资源的数组	获取或设置给定客户的超额。
promotionId	string	应用于订阅的促销标识符。格式示例：“39NFJQT1PJQB：0001：39NFJQT1Q5KN”
CancellationAllowedUntilDate	DateTime	取消的最后一个日期。
BillingCycleEndDate	DateTime	获取或设置此订阅的计费周期结束日期（以日期时间格式）。
BillingCycleEndDateTime	DateTime	获取此订阅的计费周期结束日期时间（采用日期时间格式）。
productOrderId	string	特定产品购买的标识符（例如预留或 Azure 储蓄计划）。
lineItems	SubscriptionLineItem	行项包含特定订阅的购买详细信息。

SubscriptionLinks

SubscriptionLinks 资源描述附加到订阅资源的链接集合。

properties	类型	描述
offer	链接	获取或设置产品/服务。
parentSubscription	链接。	获取或设置父订阅。
product	链接	获取与订阅关联的产品。
sku	链接	获取与订阅关联的产品 SKU。
availability	链接。	获取与订阅关联的产品 SKU 可用性。
activationLinks	链接。	获取与订阅关联的激活链接的列表。
self	链接。	自 URI。
下一步	链接。	项的下一页。
previous	链接	项的上一页。

SubscriptionProvisioningStatus

SubscriptionProvisioningStatus 资源提供有关订阅的预配状态的信息。

properties	类型	描述
skuId	string	标识产品 SKU 的字符串。
状态	string	指示预配状态：“成功”、“挂起”或“失败”。
quantity	数字	预配后提供订阅数量。
endDate	采用 UTC 日期/时间格式的字符串	订阅的结束日期。
attributes	ResourceAttributes	元数据属性。

scheduledNextTermInstructions

scheduledNextTermInstructions 资源定义要在订阅下一个任期开始时应用的说明。仅当已设置计划更改或针对所有试用订阅时，才会存在。

properties	类型	说明
product	product	标识产品 SKU 的 GUID 格式字符串。
quantity	数字	预配后提供订阅数量。
customTermEndDate	采用 UTC 日期/时间格式的字符串	与另一个订阅的结束日期保持一致时，订阅的自定义结束日期

产品

计划更改将在下一个术语中应用 scheduledNextTermInstructions.product 资源和属性。

properties	类型	描述
productId	字符串	产品的 ID。
skuId	字符串	预配后提供订阅数量。
availabilityId	字符串	此可用性的 ID。此 ID 仅在其父产品和 SKU 的上下文中是唯一的。请注意，可用性 ID 可能会随时间而变化。合作伙伴在检索此值后，仅应在短时间内依赖于此值。
billingCycle	字符串	指示合作伙伴为此订单计费的频率。支持的值是在 BillingCycleType 中找到的成员名称。
termDuration	字符串	术语持续时间的 ISO 8601 表示形式。当前支持的值是 P1M （1 个月）和 P1Y （1 年）。
promotionId	字符串	要应用于下一个计划术语的升级标识符。格式示例：“39NFJQT1PJQB：0001：39NFJQT1Q5KN”。

nextChargeInstructions

nextChargeInstructions 资源定义在订阅下一个学期开始时应用的计费周期说明。仅在挂起计费周期更改挂起时才存在。

properties	类型	说明
product	product	标识产品 SKU 的 GUID 格式字符串。
quantity	数字	预配后提供订阅数量。

SubscriptionRegistrationStatus

SubscriptionRegistrationStatus 资源描述附加到订阅资源的链接集合。

properties	类型	说明
subscriptionId	string	订阅标识符。
状态	string	指示注册状态：“registered”、“registering”或“notregistered”。

SupportContact

SupportContact 资源表示客户的订阅的支持联系人。

properties	类型	描述
supportTenantId	string	指示支持联系人的租户标识符的 GUID 格式字符串。
supportMpnId	string	联系人的合作伙伴标识符。
name	string	支持联系人的名称。
链接	ResourceLinks	支持部门联系相关链接。
attributes	ResourceAttributes	元数据属性。包含“objectType”：“SupportContact”。”

超额

超额资源表示是否分配消耗订阅超额，以及是否分配了经销商。

properties	类型	描述
azureEntitlementId	string	指示消耗订阅标识符的 GUID 格式字符串。
partnerId	string	与订阅关联的经销商的合作伙伴标识符。
type	string	超额类型可以是“电话Services”
超龄	boolean	一个值，该值指示是否启用超额。
链接	ResourceLinks	超额相关链接。
attributes	ResourceAttributes	元数据属性。包含“objectType”：“Overage”。

RegisterSubscription

RegisterSubscription 资源返回可用于查询订阅注册状态的链接。注册状态在成功接受的请求的响应正文中返回，以注册 Azure 订阅。

properties	类型	描述
httpResponseMessage	object	返回 HTTP 状态代码 202“已接受”，其中包含用于查询注册状态的链接的位置标头。例如： `"/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus"`

RefundOption

RefundOption 资源表示订阅的可能退款选项。

properties	类型	说明
type	string	退款类型。支持的值为“Partial”和“Full”
expiresAfter	采用 UTC 日期/时间格式的字符串	此选项过期时的时间戳。如果为 null，则退款操作没有过期。

AzureEntitlement

AzureEntitlement 资源表示订阅的 Azure 权利。

properties	类型	描述
ID	string	权利标识符
friendlyName	string	权利的友好名称。
状态	string	权利的状态。
subscriptionId	string	权利所属的订阅标识符。

SubscriptionLineItem

行项包含特定订阅的购买详细信息。

属性	类型	描述
ID	string	订阅行项标识符。
friendlyName	string	合作伙伴定义的订阅行项的友好名称，以帮助消除歧义。
scope	范围	范围指示权益适用位置。
autoRenewEnabled	布尔	获取一个值，该值指示是否自动续订订阅。
状态	string	订阅状态：“none”、“active”、“pending”、“suspended”、“expired”、“disabled”或“deleted”。
purchaseCommitment	购买承诺	在计算服务上提交的固定金额。

范围

范围指示权益适用位置。

属性	类型	说明
type	string	购买的范围类型：“Single”、“Shared”、“Resource group”或“Management group”。
subscriptionId	string	将用于购买的 Azure 计划的 ID。共享范围是必需的。
entitlementId	string	将用于购买的 Azure 订阅的 ID。单个范围是必需的。
managementGroupId	string	将用于购买的管理组的 ID。此范围只能通过当前Azure 门户进行选择，但更新会反映在电脑中。
resourceGroupId	string	将用于购买的资源组的 ID。此范围只能通过当前Azure 门户进行选择，但更新会反映在电脑中。

购买承诺

在计算服务上提交的固定金额。

属性	类型	描述
amount	string	固定金额承诺。
粮食	string	承诺的期限。
currency	string	承诺的货币。