订阅资源

适用于:合作伙伴中心 |由世纪互联运营的合作伙伴中心 |美国政府Microsoft云合作伙伴中心

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

订阅

注释

订阅资源每个租户标识符的速率限制为每分钟 500 个请求。

订阅资源表示订阅的生命周期,并包括定义整个订阅生命周期中的状态的属性。

资产 类型 DESCRIPTION
身份证件 字符串 订阅标识符。
报价编号 字符串 套餐标识符。
授权编号 字符串 权利标识符(Azure 订阅 ID)。
offer名称 字符串 产品/服务名称。
友好名称 字符串 由合作伙伴定义的订阅的友好名称,用于帮助消除歧义。
数量 数字 数量。 此属性设置为按许可证计费的许可证数量。
单位类型 字符串 定义订阅数量单位:“许可证”、“基于使用情况”或“权益”。
父订阅ID 字符串 获取或设置父订阅标识符。
创建日期 字符串 获取或设置创建日期,以日期时间格式表示。
生效开始日期 采用 UTC 日期/时间格式的字符串 获取或设置此订阅的有效开始日期(以日期时间格式)。 此属性用于备份已迁移的订阅或使其与其他订阅保持一致。
承诺结束日期 采用 UTC 日期/时间格式的字符串 此订阅的承诺结束日期,采用日期时间格式。 对于不可自动续订的订阅,此属性表示将来遥远的日期。 新的商务结束日期包括当日,这意味着期限的结束时间在一天的结束。 旧版结束日期不包含在内。
承诺结束日期时间 采用 UTC 日期/时间格式的字符串 此订阅承诺的截止日期和时间,采用日期和时间格式。 对于不可自动续订的订阅,此属性表示将来遥远的日期。
地位 字符串 订阅状态:“无”、“激活”、“待定”、“暂停”、“已过期”、“已禁用”或“已删除”。
autoRenew已启用 布尔 获取一个值,该值指示是否自动续订订阅。
计费类型 字符串 指定订阅计费方式:“无”、“使用量”、“许可证”或“福利”。
billingCycle 字符串 指示合作伙伴为此订单付费的频率。 支持的值是在 BillingCycleType 中找到的成员名称。
提供可购买的附加组件 布尔 获取或设置一个值,该值指示订阅是否具有可购买的加载项。
isTrial 布尔 一个值,该值指示订阅是否为试用版。
isMicrosoftProduct 布尔 一个值,该值指示订阅是否为Microsoft产品。
出版商名称 字符串 发布者名称。
行动 字符串数组 获取或设置允许的操作。 可能的值:“edit”、“cancel”
合作伙伴 ID 字符串 在间接合作伙伴模型中使用的记录经销商的 PartnerID。
暂停原因 字符串数组 只读。 如果订阅已暂停,则指示原因。
合同类型 字符串 只读。 合同类型:“订阅”、“产品密钥”或“兑换码”。
退款选项 RefundOption 资源的数组 只读。 此订阅可用的退款选项集。
下一学期课程安排说明 scheduledNextTerm说明 获取或设置在下一个阶段开始时执行的计划指令。
下次充电说明 nextChargeInstructions 获取当前结算周期结束时,挂起周期更改的下一结算周期计费说明的详细信息。
链接 SubscriptionLinks 获取或设置订阅链接。
订单编号 字符串 用于开始订阅的订单 ID。
期限持续时间 字符串 术语持续时间的 ISO 8601 表示形式。 当前支持的值为 P1M (1 个月) 、 P1Y (1 年) 和 P3Y (3 年) 。
termLifeCycleState 字符串 订阅条款生命周期状态的表示形式。 当前支持的值是 GA (正式发布)、 EndOfSaleEndOfSaleWithConversions (可以与它们进行交流)。
属性 资源属性 与订阅相关的元数据属性。
续订期限 字符串 术语持续时间的 ISO 8601 表示形式。 当前支持的值是 P1M (1 个月)和 P1Y (1 年)。
产品类型 项类型 只读。 订阅要用于的产品类型。
消费类型 超额资源的数组 获取或设置给定客户的超额。
promotionId 字符串 应用于订阅的促销标识符。 格式示例:“39NFJQT1PJQB:0001:39NFJQT1Q5KN”
允许取消截止日期 DateTime 取消的最后期限
账单周期结束日期 DateTime 获取或设置此订阅的计费周期结束日期(用日期时间格式)。
账单周期结束日期时间 DateTime 获取此订阅的计费周期结束日期时间(以日期时间格式)。
产品订单ID 字符串 特定产品购买的标识符(例如预留或 Azure 储蓄计划)。
lineItems SubscriptionLineItem 行项包含特定订阅的购买详细信息。

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

资产 类型 DESCRIPTION
提供 链接 获取或设置报价。
父级订阅 链接 获取或设置父订阅。
产品 链接 获取与订阅关联的产品。
SKU 链接 获取与订阅关联的产品 SKU。
可用性 链接 获取与订阅关联的产品 SKU 可用性。
激活链接 链接 获取与订阅关联的激活链接的列表。
自我 链接 self-URI.
下一步 链接 项的下一页。
以前 链接 项的上一页。

订阅配置状态

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

资产 类型 DESCRIPTION
skuId 的 字符串 标识产品 SKU 的字符串。
地位 字符串 指示配置状态:“成功”、“挂起”或“失败”。
数量 数字 预配后提供订阅数量。
结束日期 采用 UTC 日期/时间格式的字符串 订阅的结束日期。
属性 资源属性 metadata 属性。

下一学期课程安排说明

scheduledNextTermInstructions 资源定义订阅下一个周期开始时要应用的说明。 仅当计划更改已设置或者适用于所有试用订阅时才会出现。

资产 类型 DESCRIPTION
产品 产品 标识产品 SKU 的 GUID 格式字符串。
数量 数字 预配后提供订阅数量。
customTermEndDate (自定义术语结束日期) 采用 UTC 日期/时间格式的字符串 订阅的自定义结束日期,当与另一个订阅的结束日期对齐时。

产品

在下一个期限,计划更改将应用于 scheduledNextTermInstructions.product 资源和属性。

资产 类型 DESCRIPTION
productId 字符串 产品的 ID。
skuId 的 字符串 预配后提供订阅数量。
可用性ID 字符串 此可用性的 ID。 此 ID 仅在其父 产品和SKU 的上下文中是唯一的。 注意 可用性 ID 可能会随时间而变化。 合作伙伴在检索此值后,仅应在短时间内依赖于此值。
billingCycle 字符串 指示合作伙伴为此订单付费的频率。 支持的值是在 BillingCycleType 中找到的成员名称。
期限持续时间 字符串 术语持续时间的 ISO 8601 表示形式。 当前支持的值是 P1M (1 个月)和 P1Y (1 年)。
promotionId 字符串 要应用于下一个安排的期限的促销标识符。 格式示例:“39NFJQT1PJQB:0001:39NFJQT1Q5KN”。

下次充电说明

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

资产 类型 DESCRIPTION
产品 产品 标识产品 SKU 的 GUID 格式字符串。
数量 数字 预配后提供订阅数量。

订阅注册状态

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

资产 类型 DESCRIPTION
订阅编号 字符串 订阅标识符。
地位 字符串 指示注册状态:“已注册”、“正在注册”或“未注册”。

技术支持联系方式

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

资产 类型 DESCRIPTION
supportTenantId 字符串 用于指示支持联系人的租户标识符的 GUID 格式字符串。
supportMpnId 字符串 联系人的伙伴标识符。
姓名 字符串 支持联系人的名称。
链接 资源链接 支持部门联系相关链接。
属性 资源属性 metadata 属性。 包含“objectType”:“SupportContact”。”

超额

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

资产 类型 DESCRIPTION
azureEntitlementId 字符串 表示消耗订阅标识符的 GUID 格式字符串。
合作伙伴 ID 字符串 与订阅关联的经销商的合作伙伴标识符。
类型 字符串 超额类型可以是“PhoneServices”
超额 布尔 一个值,该值显示是否启用超额。
链接 资源链接 超额相关链接。
属性 资源属性 metadata 属性。 包含“objectType”:“超额”。

注册订阅

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

资产 类型 DESCRIPTION
HTTP响应消息 物体 返回 HTTP 状态代码 202“已接受”,其中包含用于查询注册状态的链接的位置标头。 例如: "/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus"

退款选项

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

资产 类型 DESCRIPTION
类型 字符串 退款类型。 支持的值有“Partial”和“Full”
到期后 采用 UTC 日期/时间格式的字符串 此选项过期时的时间戳。 如果为 null,则退款操作没有过期。

AzureEntitlement

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

资产 类型 DESCRIPTION
身份证件 字符串 权利标识符
友好名称 字符串 权利的友好名称。
地位 字符串 权益的状态。
订阅编号 字符串 权利所属的订阅标识符。

订阅项目行

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

财产 类型 说明
身份证件 字符串 订阅行项标识符。
友好名称 字符串 合作伙伴定义的订阅行项的友好名称,以帮助消除歧义。
范围 范围 范围指示权益适用位置。
autoRenew已启用 布尔型 获取一个值,该值指示是否自动续订订阅。
地位 字符串 订阅状态:“无”、“激活”、“待定”、“暂停”、“已过期”、“已禁用”或“已删除”。
购买承诺 购买承诺 在计算服务上提交的固定金额。

范围

范围指示权益适用位置。

财产 类型 说明
类型 字符串 用于采购的范围类型:“单一”、“共享”、“资源组”或“管理组”。
订阅编号 字符串 将用于购买的 Azure 计划的 ID。 共享范围是必需的。
授权编号 字符串 将用于购买的 Azure 订阅的 ID。 单个范围是必需的。
managementGroupId(管理组ID) 字符串 用于购买的管理组 ID。 目前只能通过 Azure 门户选择此范围,但更新会反映在个人电脑上。
资源组ID 字符串 用于购买的资源组的 ID。 目前只能通过 Azure 门户选择此范围,但更新会反映在个人电脑上。

购买承诺

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

财产 类型 说明
字符串 固定金额承诺。
粮食 字符串 承诺的期限。
货币 字符串 承诺的货币。