Product List - List By Subscription
列出要订阅的产品。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language={language}&excludePublicOffersAndPublicPlans={excludePublicOffersAndPublicPlans}&$filter={$filter}&$select={$select}&$expand={$expand}&$orderBy={$orderBy}&$search={$search}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
目标订阅的 ID。 该值必须是 UUID。 |
|
api-version
|
query | True |
string minLength: 1 |
要用于此操作的 API 版本。 |
|
$expand
|
query |
string |
内联扩展相关实体 |
|
|
$filter
|
query |
string |
根据布尔条件筛选结果。 示例：$filter=productType eq 'VirtualMachine'。 可以筛选的字段包括：
|
|
|
$order
|
query |
string |
使用 OData 表示法对结果进行排序表达式。 除非必要，否则请避免使用 orderby，因为这可能会影响请求的延迟。 示例：$orderby=displayName desc。此 API 仅支持按单个字段排序。 可以排序的字段包括：
|
|
|
$search
|
query |
string |
可选按显示名称、发布者显示名称或关键字进行搜索。 示例 $search=Microsoft |
|
|
$select
|
query |
string |
选择要包含在结果中的属性。 示例：$select=displayName |
|
|
exclude
|
query |
boolean |
是否从响应中排除公开优惠和公共计划。 默认值为 false，这意味着响应中包含公共产品/服务和公共计划。 如果设置为 true，则仅返回私有计划。 |
|
|
language
|
query |
string |
要搜索的语言，ISO 639-1 双字母代码，可能的值 - 'en，cs，de，es，fr，胡，it，ja，ko，nl，pl，pt-br，pt-pt，ru，sv，tr，id，zh-hans，zh-hant'。 默认值为“en” |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求已成功。 |
|
| Other Status Codes |
意外的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
ProductList_ListBySubscription
示例请求
GET https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$filter=productType eq 'SaaS'&$select=displayName,uniqueProductId,productType,publisherDisplayName
示例响应
{
"value": [
{
"uniqueProductId": "microsoft.managedinstance_standard",
"displayName": "Azure SQL Managed Instance",
"publisherDisplayName": "Microsoft",
"productType": "SaaS"
}
],
"nextLink": "https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$select=displayName,uniqueProductId,productType,publisherDisplayName&$filter=productType eq 'SaaS'&$skiptoken=W3sid..."
}定义
| 名称 | 说明 |
|---|---|
| Attribute |
表示 SKU 属性，该属性由键和值组成。 不同服务的属性可能有所不同。 |
|
Discovery |
DiscoveryErrorPayload 中返回的错误详细信息 |
|
Discovery |
市场发现 API 返回的错误有效负载 |
|
Plan |
其他元数据 |
|
Plan |
返回计划属性的子集 |
|
Product |
返回产品属性的子集 |
|
Product |
列表作的自定义响应。 |
Attribute
表示 SKU 属性，该属性由键和值组成。 不同服务的属性可能有所不同。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
属性键 |
| value |
string |
属性值 |
DiscoveryErrorDetails
DiscoveryErrorPayload 中返回的错误详细信息
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
HTTP 错误代码 |
| message |
string |
错误消息 |
DiscoveryErrorPayload
市场发现 API 返回的错误有效负载
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误详细信息对象 |
PlanMetadata
其他元数据
| 名称 | 类型 | 说明 |
|---|---|---|
| altStackReference |
string |
指向保存备用堆栈引用的 planId |
| generation |
string |
虚拟机映像生成（仅适用于虚拟机产品） |
PlanSummary
返回计划属性的子集
| 名称 | 类型 | 说明 |
|---|---|---|
| altArchitectureReference |
string |
替代架构参考 |
| altStackReference |
string |
替代堆栈引用 |
| categoryIds |
string[] |
计划 CategoryIds |
| cspState |
string |
控制 Microsoft 云解决方案提供商 （CSP） 计划中的计划可用性和合作伙伴访问权限。
|
| description |
string |
计划/SKU 说明 |
| displayName |
string |
计划/SKU 的显示名称 |
| displayRank |
string |
计划在“计划”表中的显示顺序 |
| hasProtectedArtifacts |
boolean |
如果计划具有要为未经身份验证的用户隐藏的项目，则设置为 true |
| hasRi |
boolean |
指示 SKU 是否支持预留 |
| isPrivate |
boolean |
指示该计划仅对受限受众开放 |
| metadata |
扩展的计划/SKU 元数据。 |
|
| planId |
string |
计划标识符 |
| planType |
string |
指定市场产品的主要部署模型和托管体系结构。 当前支持的值包括：
|
| pricingTypes |
string[] |
指示可用于计划的计费模型和成本结构。
|
| skuId |
string |
SKU ID |
| stackType |
string |
堆栈类型 ： 经典、第 1 代、第 2 代 |
| summary |
string |
计划摘要文本 |
| uniquePlanId |
string |
唯一的计划标识符，通过组合 uniqueProductId 和 PlanId 来添加前缀，中间没有分隔符 |
| vmArchitectureType |
string |
指定虚拟机处理器体系结构和代数。 仅适用于虚拟机产品类型。
|
| vmSecuritytypes |
string[] |
定义虚拟机部署的安全增强级别。 仅适用于虚拟机产品类型。
|
ProductSummary
返回产品属性的子集
| 名称 | 类型 | 说明 |
|---|---|---|
| applicableProducts |
string[] |
产品/服务所属的产品类别 |
| attributes |
产品属性集 |
|
| azureBenefit |
string |
指示产品购买是否计入企业客户的 Azure 消耗承诺权益。
|
| badges |
string[] |
显示产品获得的认证和资格徽章，以实现市场可见性。
|
| categoryIds |
string[] |
产品类别的阵列 |
| cspLegalTermsUri |
string |
CSP 产品的法律条款 |
| description |
string |
产品说明文字 |
| displayName |
string |
产品显示名称 |
| hasMarketplaceFootprint |
boolean |
指示产品是否在市场上有代表 |
| hasRiPlans |
boolean |
指示产品是否有预留计划 |
| industryIds |
string[] |
项目所属的行业 ID 列表 |
| lastModifiedDateTime |
string |
产品的最新更新日期 |
| locations |
string[] |
SKU 上可用的位置列表 |
| longSummary |
string |
产品长总结 |
| operatingSystems |
string[] |
本产品的作系统信息 |
| plans |
全套计划/SKU 属性 |
|
| popularity |
number (double) |
产品受欢迎程度 |
| pricingTypes |
string[] |
指示可用于计划的计费模型和成本结构。
|
| privacyPolicyUri |
string |
产品隐私政策 |
| productFamily |
string |
产品系列 |
| productId |
string |
产品的唯一 ID |
| productSubType |
string |
产品子类型 |
| productType |
string |
指定存储在市场目录中的市场产品的主要部署模型和托管体系结构。
|
| publisherDisplayName |
string |
发布者显示名称 |
| publisherId |
string |
发布者 ID |
| publisherType |
string |
标识发布者与 Microsoft 的支持和合作伙伴关系分类。
|
| publishingStage |
string |
指示 Azure 市场中的产品可用性状态和客户访问级别。
|
| ratingAverage |
number (double) |
优惠的平均评分 |
| ratingBuckets |
string[] |
按客户评级阈值对产品进行分类，以便进行市场筛选和发现。
|
| ratingCount |
integer (int32) |
产品/服务的评分总数 |
| service |
string |
产品的服务名称，例如“虚拟机” |
| serviceFamily |
string |
产品的服务系列，例如“计算” |
| smallIconUri |
string |
URI 添加到小产品图标 |
| summary |
string |
产品概要 |
| supportedProducts |
string[] |
映射到兼容产品列表 |
| uniqueProductId |
string |
唯一的产品标识符 |
ProductSummaryListResult
列表作的自定义响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| nextLink |
string |
指向下一页项的链接 |
| value |
本页的项目 |