产品资源

项目
07/19/2022

表示可购买商品或服务的资源。包括用于描述产品类型和形状 (SKU) 的资源，以及检查库存中产品的可用性。

产品

表示可购买的好服务。产品本身不是可购买的项目。

属性	类型	说明
id	String	产品的 ID。
title	字符串	产品标题。
description	字符串	产品说明。
productType	ItemType	描述此产品的类型分类 () 的对象。
isMicrosoftProduct	Bool	指示产品是否为 Microsoft 产品。
publisherName	String	产品发布者的名称（如果可用）。
链接	ProductLinks	产品中包含的资源链接。

ItemType

表示产品的类型。

属性	类型	说明
id	String	类型标识符。
displayName	String	项类型的显示名称。
subType	ItemType	可选。描述项类型的子类型分类的对象。

ProductLinks

包含产品的链接列表。

属性	类型	说明
skus	链接	用于访问基础 SKU 的链接。
链接	ResourceLinks	资源中包含的资源链接。

SKU

表示产品的可购买库存单位 (SKU) 。

属性	类型	说明
id	String	SKU 的 ID。 ID 仅在其父产品的上下文中唯一。
title	字符串	SKU 的标题。
description	字符串	SKU 的说明。
productId	String	包含 SKU 的父产品的 ID。
minimumQuantity	int	允许购买的最低数量。
maximumQuantity	int	允许购买的最大数量。
isTrial	Bool	指示 SKU 是否为试用项。
supportedBillingCycles	字符串数组	SKU 支持的计费周期列表。支持的值是在 BillingCycleType 中找到的成员名称。
purchasePrerequisites	字符串数组	购买项目之前所需的先决条件步骤或操作的列表。支持的值包括： “InventoryCheck”- 指示在尝试购买商品之前应评估项目的库存。 “AzureSubscriptionRegistration” - 指示需要 Azure 订阅，并且必须在尝试购买项目之前进行注册。
inventoryVariables	字符串数组	对项执行清单检查所需的变量列表。支持的值包括： “CustomerId”- 购买要用于的客户 ID。 “AzureSubscriptionId” - 将用于 Azure 预留购买的 Azure 订阅的 ID。 “ArmRegionName”- 要验证清单的区域。此值必须与 SKU 的 DynamicAttributes 中的“ArmRegionName”匹配。
provisioningVariables	字符串数组	在购买项目时，必须提供给购物车行项的预配上下文中的变量列表。支持的值包括：范围 - Azure 预留购买的范围：“Single”、“Shared”。 “SubscriptionId” - 将用于 Azure 预留购买的 Azure 订阅的 ID。 “Duration”- Azure 预留的持续时间：“1Year”、“3Year”。
dynamicAttributes	键/值对	应用于项的动态属性字典。字典中的属性是动态的，无需通知即可更改。合作伙伴应避免在属性值中存在的特定键上创建强依赖项。
链接	ResourceLinks	SKU 中包含的资源链接。
AttestationProperties	AttestationProperties	SKU 的证明属性。
consumptionType	String	仅当 SKU 支持消耗（如超额）时才可用。
specializedOfferProperties	specializedOfferProperties 列表	仅当产品是 SpecializedOffer 的子类型时，才可用。

动态 SKU 属性

与新的基于商业许可证的产品和服务相关的显著属性。

注意

基于许可证的服务的新商业体验涵盖许多新功能，可供所有云解决方案提供商 (CSP) 使用。有关详细信息，请参阅新商务体验概述。

属性	类型	描述
hasConstraints	布尔	描述 SKU 是否包含 assetContraints
isAddon	布尔	描述 SKU 是否为加载项
prerequisiteSkus	字符串数组	介绍加载项可以使用的产品和 SKU
upgradeTargetOffers	字符串数组	项目可以升级到的产品和 SKU 列表
conversionInstructions	conversionInstructions 列表	适用于转换操作的说明列表

specializedOfferProperties

注意

基于许可证的服务的新商业体验涵盖许多新功能，可供所有云解决方案提供商 (CSP) 使用。有关详细信息，请参阅新商务体验概述。

仅适用于产品子类型“SpecializedOffers”

属性	类型	描述
startDate	String	适用于说明的术语 ID
endDate	String	定义续订的选项
pricingPolicies	pricingPolicies 列表	定义促销折扣类型和值的策略列表。

PricingPolicies

描述促销折扣类型和值。

属性	类型	说明
type	String	描述折扣是基于百分比还是平面费率折扣。
value	字符串	定义应用的折扣金额。

可用性

表示 SKU 可用于购买 (（如国家/地区、货币和行业细分) ）的配置。

属性	类型	说明
id	String	此可用性的 ID。此 ID 仅在其父产品和 SKU 的上下文中是唯一的。注意可用性 ID 可能会随时间变化。合作伙伴在检索此值后，仅应在短时间内依赖于此值。
productId	String	包含此可用性的产品的 ID。
skuId	String	包含此可用性的 SKU 的 ID。
catalogItemId	String	目录中此项的唯一标识符。购买父 SKU 时，必须将此 ID 填充到 OrderLineItem.OfferId 或 CartLineItem.CatalogItemId 属性中。注意此 ID 可能会随时间变化。在检索此值后，仅应在短时间内依赖此值。只能在购买时访问和使用它。
defaultCurrency	String	此可用性支持的默认货币。
段	String	此可用性的行业细分市场。支持的值包括：商业、教育、政府、NonProfit。
country	字符串	采用 ISO 国家/地区代码格式的国家或地区 () ，在此可用性适用的情况下。
isPurchasable	Bool	指示此可用性是否可购买。
isRenewable	Bool	指示此可用性是否可续订。
RenewalInstructions	RenewalInstruction	表示给定可用性的续订说明。
product	Product	此可用性对应于的产品。
sku	Sku	此可用性对应于的 SKU。
terms	术语资源数组	适用于此可用性的条款集合。
链接	ResourceLinks	可用性中包含的资源链接。

续订说明

注意

基于许可证的服务的新商业体验涵盖许多新功能，可供所有云解决方案提供商 (CSP) 使用。有关详细信息，请参阅新商务体验概述。

表示给定可用性的续订说明。

属性	类型	描述
applicableTermIds	字符串数组	适用于说明的术语 ID
RenewalOptions	RenewalOption 数组	定义续订的选项

RenewalOption

注意

基于许可证的服务的新商业体验涵盖许多新功能，可供所有云解决方案提供商 (CSP) 使用。有关详细信息，请参阅新商务体验概述。

表示给定可用性的续订说明。

属性	类型	描述
renewToId	String	表示要续订到的产品和 SKU
isAutoRenewable	Bool	是否可自动续订可用性

术语

表示可为其购买可用性的术语。

属性	类型	说明
duration	String	术语持续时间的 ISO 8601 表示形式。当前支持的值为 P1M (一个月) 、P1Y (一年) 和 P3Y (三年) 。
description	字符串	术语的说明。

InventoryCheckRequest

表示针对某些目录项检查清单的请求。

属性	类型	说明
targetItems	InventoryItem 数组	清单检查将评估的目录项的列表。
inventoryContext	键/值对	执行清单检查 () 所需的上下文值的字典。如果执行此操作需要任何) ，产品的每个 SKU 将定义哪些值 (。
链接	ResourceLinks	清单检查请求中包含的资源链接。

InventoryItem

表示清单检查操作中的单个项。此资源用于在输入请求中指定目标项，还用于表示清单检查操作的输出结果。

属性	类型	说明
productId	String	(必需) 产品的 ID。
skuId	String	SKU 的 ID。将此资源用作清单请求的输入时，此值是可选的。如果未提供此值，则产品下的所有 SKU 都将被视为清单检查操作的目标项。
isRestricted	Bool	指示是否已找到此项目具有受限清单。
限制	InventoryRestriction 数组	此项目找到的任何限制的详细信息。仅当 isRestricted = “true”时，才会填充此属性。

InventoryRestriction

表示清单限制的详细信息。这些详细信息仅适用于清单检查输出结果，不适用于输入请求。

属性	类型	说明
reasonCode	String	标识限制原因的代码。
description	字符串	清单限制的说明。
properties	键/值对	可能提供有关限制的更多详细信息的属性字典。

BillingCycleType

一个 [Enum/dotnet/api/system.enum) ，其值指示计费周期的类型。

值	位置	说明
Unknown	0	枚举初始值设定项。
每月一次	1	指示合作伙伴将按月收费。
每年	2	指示合作伙伴将按年收费。
无	3	指示不会向合作伙伴收费。此值可用于试用项目。
一次性	4	指示合作伙伴将一次性收费。
三年	5	指示合作伙伴每三年收取一次费用。

AttestationProperties

表示证明类型，如果需要购买。

属性	类型	说明
attestationType	String	指示证明类型。 Windows 365 产品将具有 Windows365 的值。 Windows 365 证明文本是“我知道，每个人使用 Windows 365 商业版和 Windows 混合权益的人也需要在其主工作设备上安装 Windows 10/11 专业版的有效副本。
enforceAttestation	布尔	指示是否需要证明才能购买。