你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Search - Get

服务:: Marketplace Catalog

API 版本:: 2023-01-01-preview

通过在 Marketplace 公共产品上搜索和筛选结果来提供用户体验。

GET https://catalogapi.azure.com/search?api-version=2023-01-01-preview&language={language}&select={select}&market={market}

具有可选参数:

GET https://catalogapi.azure.com/search?api-version=2023-01-01-preview&searchQuery={searchQuery}&publisherDisplayName={publisherDisplayName}&azureBenefit={azureBenefit}&publisherTypes={publisherTypes}&badges={badges}&industryCloud={industryCloud}&language={language}&select={select}&orderBy={orderBy}&productTypes={productTypes}&pricingTypes={pricingTypes}&operatingSystems={operatingSystems}&hideKeys={hideKeys}&market={market}&supportedProducts={supportedProducts}&publisherIds={publisherIds}&ratingBuckets={ratingBuckets}&vmArchitectureTypes={vmArchitectureTypes}&vmSecurityTypes={vmSecurityTypes}&publishingStage={publishingStage}&facets={facets}&skip={skip}&top={top}

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string	用于请求的 REST API 的版本。
language	query	True	string	要搜索的语言，ISO 639-1 双字母代码，可能的值为“en，cs，de，es，fr，胡，it，ja，ko，nl，pl，pt-br，pt-pt，ru，sv，tr，zh-hans，zh-hant'
market	query	True	string	产品销售市场、可能的值 - 为所有市场 https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies 或“全部”。例如“US”
select	query	True	SearchFieldName[]	要返回的字段数组。例如 select=pricingTypes。 `All`：所有字段。 `SupportedProducts`：支持的产品。 `PublisherId`：发布者 ID。 `DisplayName`：显示名称。 `AzureBenefit`：Azure 权益。 `Badges`：徽章。 `SmallIconUri`：小图标 URI。 `PublisherType`：发布服务器类型。 `PublishingState`：发布状态。 `UniqueProductId`：唯一的产品 ID。 `ProductType`：产品类型。 `Plans`：计划。 `OperatingSystems`：作系统。 `PricingTypes`：定价类型。 `PublisherDisplayName`：发布服务器显示名称。 `Summary`：摘要。 `Description`：说明。 `RatingBuckets`：评级存储桶。 `RatingAverage`：评级平均值。 `LastModifiedDateTime`：上次修改时间。 `RatingCount`：分级计数。 `LongSummary`：长摘要。
azureBenefit	query		AzureBenefit	定义仅搜索符合 Azure 权益的产品/服务（如果未提供任何值，则忽略此筛选器）。默认值：NULL。 `Eligible`：符合条件。 `NotEligible`：不符合条件。
badges	query		Badge[]	包含任何给定锁屏提醒的产品。如果未提供任何值，则忽略此筛选器。以下产品锁屏提醒可用： `PreferredSolution`：首选解决方案。 `PowerBICertified`：Power BI 认证。 `AdditionalPurchaseRequirement`：其他购买要求。
facets	query		SearchFieldName[]	数组方面到分面，如果未提供，则不会返回任何分面。例如 facets=PricingTypes，operatingSystems。 `SupportedProducts`：支持的产品。 `PublisherType`：发布服务器类型。 `AzureBenefit`：Azure 权益。 `ProductType`：产品类型。 `OperatingSystems`：作系统。 `PricingTypes`：定价类型。 `VmImageGenerations`：Vm 映像代系。 `VmSecurityTypes`：Vm 安全类型。 `VmArchitectureTypes`：Vm 体系结构类型。 `RatingBuckets`：评级存储桶。
hideKeys	query		string[]	包含任何用于预览的给定 hideKeys 的产品。例如“22c6b3ae-1111-1111-1111-e7cbdc8569ddd”。如果未提供任何值，则忽略此筛选器。仅当 PublishingStage 筛选器设置为预览时，才应用此筛选器。
industryCloud	query		IndustryCloud	定义对 IndustryCloud 产品/服务的搜索。如果未提供任何值，则忽略此筛选器。默认值：NotApplicable。 `NotApplicable`：不适用。 `True`：True。 `False`：False。
operatingSystems	query		string[]	包含任何给定作系统的产品，例如 operatingSystems=windows，linux。如果未提供任何值，则忽略此筛选器。此筛选器仅适用于虚拟机产品类型。 `windows.windowsserver2019`：Windows Server 2019。 `windows.windowsserver2019`：Windows Server 2019。 `windows.windowsserver2016`：Windows Server 2016。 `windows.windowsserver2012r2`：Windows Server 2012 R2。 `windows.windowsserver2012`：Windows Server 2012。 `windows.windowsserver2008r2`：Windows Server 2008 R2。 `windows.others`：其他（窗口）。 `windows.windowsserver2022`：Windows Server 2022。 `linux.centos`：Cent OS。 `linux.debian`：Debian。 `linux.redhat`：Red Hat。 `linux.suse`：SUSE。 `linux.ubuntu`：Ubuntu。 `linux.others`：其他（Linux）。
orderBy	query		string[]	按按要排序的字段的数组和排序类型（asc\desc），如果未提供值，则按搜索分数排序。默认排序类型：asc。例如，orderby=RatingCount desc。 `RatingCount`：ratingCount （asc/desc）。 `LastModifiedDateTime`：lastModifiedDateTime （asc/desc）。 `RatingAverage`：RatingAverage （asc/desc）。
pricingTypes	query		PricingType[]	包含任何给定定价类型的产品。如果未提供任何值，则忽略此筛选器。 `Byol`：该产品至少有一个自带许可证的计划。 `Free`：该产品至少有一个免费计划。 `FreeTrial`：该产品至少有一个计划是免费试用的。 `Payg`：该产品至少有一个计划是即用即付，基于使用情况的计费模型。 `RI`：该产品至少有一个计划是预留实例计费模型。
productTypes	query		ProductType[]	包含任何给定产品类型的产品，例如“VirtualMachine”。如果未提供任何值，则忽略此筛选器。 `AADApps`：Azure Active Directory 应用。 `AzureApplication`：Azure 应用程序。 `AzureServices`：Azure 服务。 `ConsultingServices`：咨询服务。 `Container`：容器。 `ContainerApps`：容器应用。 `CoreVirtualMachine`：核心虚拟机。 `CosellOnly`：仅限 Cosell。 `DevService`：开发服务。 `DynamicsBC`：Dynamics BC。 `DynamicsCE`：Dynamics CE。 `DynamicsOps`：Dynamics Ops。 `IotEdgeModules`：Iot Edge 模块。 `ManagedApplication`：托管应用程序。 `ManagedServices`：托管服务。 `Office365`：Office365。 `PowerBI`：PowerBI。 `PowerBIVisuals`：PowerBI 视觉对象。 `SaaS`：SaaS。 `SolutionTemplate`：解决方案模板。 `VirtualMachine`：虚拟机。 `VisualStudioExtension`：Visual Studio 扩展。 `AppService`：应用服务。 `LogAnalytics`：Log Analytics。
publisherDisplayName	query		string	搜索发布者名称。例如 publisherDisplayName=red hat。如果未提供任何值，则忽略此筛选器。
publisherIds	query		string[]	包含任何给定发布者 ID 的产品。例如“Microsoft”。如果未提供任何值，则忽略此筛选器。
publisherTypes	query		PublisherType[]	包含任何给定发布者类型的产品（如果未提供任何值，则忽略此筛选器）。可能的值：Microsoft，ThirdParty。默认值：Microsoft。 `Microsoft`：Microsoft。 `ThirdParty`：第三方。
publishingStage	query		PublishingStage	Audience。默认值：公共。 `Preview`：预览版。 `Public`：公共
ratingBuckets	query		RatingBucket[]	包含任何给定分级存储桶的产品。例如“Above1”。如果未提供任何值，则忽略此筛选器。 `AboveOne`：上一个。 `AboveTwo`：两个以上。 `AboveThree`：三以上。 `AboveFour`：四以上
searchQuery	query		string	搜索文本（如果未提供任何值）将被忽略。例如 searchQuery=red hat
skip	query		integer (int32)	要跳过的项数。最小值：0，最大值：100000，默认值：0。
supportedProducts	query		string[]	包含任何给定受支持产品的产品。例如“CRM”。如果未提供任何值，则忽略此筛选器。
top	query		integer (int32)	要返回的项数。最小值：0，最大值：1000，默认值：20。
vmArchitectureTypes	query		VmArchitectureType[]	要搜索的虚拟机映像体系结构类型的数组，如果未提供任何值，则忽略此筛选器。请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2： `X64Gen1`：X64 第 1 代。 `X64Gen2`：X64 第 2 代。 `Arm64`：Arm64 映像体系结构。
vmSecurityTypes	query		VmSecurityType[]	包含任何给定 VM 安全类型的产品。例如“受信任”。如果未提供任何值，则忽略此筛选器。 `None`：无。 `Trusted`：受信任。 `Confidential`：机密

请求头

名称	必需	类型	说明
X-API-Key	True	string	使用市场目录团队提供的 API 密钥作为标头中提供的参数

响应

名称	类型	说明
200 OK	SearchResponse	返回 Azure 市场目录产品/服务列表以及总计计数和方面
Other Status Codes	ErrorResponse	错误响应： 400 - 以防请求格式不正确。 401 - 如果 API 密钥标头缺失或无效 500 - 出现内部错误。标头 x-ms-error-code: string

名称

类型

说明

200 OK

SearchResponse

返回 Azure 市场目录产品/服务列表以及总计计数和方面

Other Status Codes

ErrorResponse

错误响应：

400 - 以防请求格式不正确。
401 - 如果 API 密钥标头缺失或无效
500 - 出现内部错误。

标头

x-ms-error-code: string

安全性

X-API-Key

使用市场目录团队提供的 API 密钥作为标头中提供的参数

类型: apiKey
在: header

示例

Search_Get

示例请求

HTTP

GET https://catalogapi.azure.com/search?api-version=2023-01-01-preview&searchQuery=check&azureBenefit={azureBenefit}&language=en&select=DisplayName,PublisherId,AzureBenefit,Badges,PublisherType,UniqueProductId,ProductType,OperatingSystems,PricingTypes,PublisherDisplayName,Description,RatingBuckets,RatingAverage,RatingCount&orderBy=RatingAverage desc,RatingCount desc&pricingTypes=Payg&market=US&publishingStage=Public&facets=PricingTypes&top=2

示例响应

状态代码:: 200

{
  "facets": {
    "PricingTypes": {
      "facetValues": {
        "Payg": {
          "count": 307
        },
        "Free": {
          "count": 62
        },
        "FreeTrial": {
          "count": 56
        },
        "Byol": {
          "count": 34
        },
        "Ri": {
          "count": 20
        }
      }
    }
  },
  "results": [
    {
      "displayName": "Territory, Field Service - Bing Map MappyField 365",
      "publisherId": "biztechcs",
      "azureBenefit": "NotEligible",
      "badges": [
        "PreferredSolution"
      ],
      "publisherType": "ThirdParty",
      "uniqueProductId": "biztechcs.quick-maps",
      "productType": "DynamicsCE",
      "operatingSystems": [],
      "pricingTypes": [
        "Payg"
      ],
      "publisherDisplayName": "Biztech Consulting & Solutions",
      "description": "<h3><b>Dynamics 365 Map: Expand your business with location intelligence</b></h3><p>MappyField 365 is a powerful geo mapping plugin to boost your business productivity and scale it geographically for Dynamics 365. Explore power features like Live tracking, CRM data visualization on map, proximity search, auto scheduling, auto check-ins, territory management, heat maps, follow-ups, dashboards, and more.</p><p></p><h2><b>Accelerate your business with MappyField 365 + Dynamics CRM</b></h2><p>If your field business requires next-generation productivity tools to manage multiple aspects of your business then MappyField 365 is the right choice for you.</p><p></p><b>Data visualization on map</b><p></p><ul><li>Visualize, filter, and geocode your CRM data on the map, create heatmaps with different junction possibilities and ease business decisions.</li></ul><b>Build more pipelines and drive revenue</b><p></p><ul><li>With custom territory management and proximity search feature, build segmented pipelines for your sales, marketing, or field service teams.<br></li></ul><b>Smart routing: save time &amp; materials</b><p></p><ul><li>Create, optimize, manage and share routes for field reps, keep an eye on their progress and locations through map. Save more with less time and fuel consumption!</li></ul><b>Appointments automation </b><ul><li>Automate visit scheduling of reps, proximity based auto check-ins, meeting notes, direct appointment booking, and activity planning, seamlessly!</li></ul><h2><b>MappyField 365: An alternative to Maplytics, worth experiencing</b></h2>MappyField 365 for Dynamics 365 can be a game changer for teams using location intelligence. MappyField 365 can especially help businesses with:<br><ul><li><p>Data loading speed for huge data</p></li><li><p>Productivity enhancer automation tools</p></li><li><p>Better deals, support, customer service</p></li></ul><h2><b>Make your on-field and off-field teams more productive</b></h2>Enable your team with a powerful field service tool.<p></p><p></p><b>Sales team</b><ul><li>Level up your field sales team with better tools and reduce their operational overheads to focus more on conversions.</li></ul><b>Marketing team</b><ul><li>Let your marketing team plan niche campaigns with localizations and generate fruitful pipelines for sales teams with MappyField.</li></ul><b>Field service team</b><ul><li>Expand your door-to-door services, be it cleaning, repairing, and deliveries, more effectively with MappyField 365.</li></ul><b>Delivery team</b><ul><li>Enable your delivery team with optimized routes and reduce order-to-delivery turnaround to serve customers faster!</li></ul><b>Managers from office</b><ul><li>Enable your managerial level to visualize operations progress, monitor teams effectively and make more informed decisions with analytics.</li></ul><b>Partners, suppliers &amp; distributors</b><ul><li>Make your distribution channels more efficient by identifying nearby partners and suppliers within the territories to grow your business.</li></ul><h2><b>MappyField 365 and Industries</b></h2><ol><li><p>Real-estate</p></li><li><p>Healthcare &amp; Pharma</p></li><li><p>Professional services</p></li><li><p>Manufacturing</p></li><li><p>And more.</p></li></ol><p></p><h2><b>MappyField 365 and its compatibility</b></h2><p><b>Any device, any language</b></p><ul><li>MappyField 365, our Dynamics 365 map solution, is available in multiple languages and compatible from mobile to large desktops.</li></ul><b>Dynamics CRM and its versions</b><ul><li>Support for Dynamics CRM version from 8.2 onwards, Online &amp; On-Premise.</li></ul><b>Support for Dataverse</b><ul><li>MappyField 365 has support for PowerApps and Dataverse.</li></ul><h1><b>Powerful features of MappyField 365</b></h1><p></p><h4><b>Scheduling and tracking</b></h4><p></p><ul><li>Visit planner</li><li>Live tracking</li><li>Mobile app for field reps</li><li>Automatic check-in and check-out </li></ul><p></p><h4><b>Optimized route plotting</b></h4><ul><li>Share route via email</li><li>Open Route in Google or Apple Maps</li><li>Point of Interest (POI)</li></ul><h4><b>Proximity search</b></h4><ul><li>Through location</li><li>With distance</li><li>By time</li></ul><h4><b>Sales pipeline</b></h4><ul><li>Territory management</li><li>Heat maps</li><li>Geo-analytical dashboards</li></ul><h4><b>Map CRM data in different ways</b></h4><ul><li>Filters like region, drawing, territory or by user</li><li>DataGrid and summary card</li><li>Geocode any record(s)</li></ul><h4><b>Configurations</b></h4><ul><li>Global &amp; user level configurations</li><li>Security templates</li><li>Multi-language</li></ul><h4><b>Quick actions directly from the map</b></h4><ul><li>Add to marketing list</li><li>Follow-up activities</li><li>Save your preferences</li></ul><p></p><p><b>Note: </b>For Offline (On-Premise) Integration, visit <a href=\"https://www.appjetty.com/dynamics365-mappyfield-365.htm\" target=\"_blank\">AppJetty</a> (a Biztech venture) for trial.</p>",
      "ratingBuckets": [
        "AboveOne",
        "AboveTwo",
        "AboveThree",
        "AboveFour"
      ],
      "ratingAverage": 5,
      "ratingCount": 16
    },
    {
      "displayName": "Drill Down Combo PRO by ZoomCharts",
      "publisherId": "zoomcharts622107102",
      "azureBenefit": "NotEligible",
      "badges": [
        "PowerBICertified"
      ],
      "publisherType": "ThirdParty",
      "uniqueProductId": "WA104381944",
      "productType": "PowerBIVisuals",
      "operatingSystems": [],
      "pricingTypes": [
        "Payg"
      ],
      "publisherDisplayName": "ZoomCharts",
      "description": "<p>Discover the power of Drill Down Combo PRO for <b>exceptional data visualizations</b>. With multiple chart types to choose from, including <b>line, area, and column charts</b>, it's easy to create impactful reports. <b>Used by 80% of Fortune 200 companies</b>, Drill Down Combo PRO simplifies report exploration for all Power BI users and lets you uncover insights effortlessly with <b>interactive drill downs and on-chart interactions</b> that accompany your line, area, and column charts.</p><p>MAIN FEATURES:</p><ul><li>On-chart interactions – click, pan, zoom-in/out to explore multiple drill-down levels for column, line, and area charts</li></ul><ul><li>Multiple chart types – choose between column, line, and area chart for each series</li></ul><ul><li>Stacking and clustering – stack or cluster series, chose between series specific or cumulative (total) values</li></ul><ul><li>Static and dynamic thresholds – set up to 3 thresholds to demonstrate targets or benchmarks on your column, line, and area charts</li></ul><ul><li>Full customization – customize X and Y axes, legends, stacks, tooltip, fill settings, outlines</li></ul><ul><li>Cross-chart filtering – select data points on multiple charts instead of using slicers</li></ul><ul><li>Multi-touch device friendly – get equal experience on any device</li></ul><p>MOST POPULAR USE CASES:</p><ul><li>Sales & Marketing – sales strategies, sales results and campaign-by-campaign marketing metrics</li></ul><ul><li>Human Resources – hiring, overtimes, and efficiency ratios by department or office</li></ul><ul><li>Accounting and Finance – financial performance by region, office or business line</li></ul><ul><li>Manufacturing – production efficiencies and quality metrics by product line</li></ul><p>This visual offers in-app purchases and comes with 30 days free access to the paid features.</p><p>Get Drill Down Combo PRO as part of the ZoomCharts Visual Bundle and create cutting-edge and interactive report using all Drill Down Visuals.</p><p>Explore the ZoomCharts Visual Bundle here: https://bit.ly/3NmF8li</p><p>Find free sample reports, documentation, and other free resources check out ZoomCharts video tutorials: https://bit.ly/3IZV5eY</p><p>In case of any inquiries, contact our support team: https://bit.ly/43qHxBc</p><p>************************</p><p>ZoomCharts Drill Down Visuals are known for their interactive drilldowns, rich customization options, and on-chart interactions that help you filter large amounts of data with just a simple click. They are mobile friendly and support: interactions, selections, custom and native tooltips, filtering, bookmarks, and context menu.</p><p>Use Drill Down Visuals to create Drill Down Reports that business users absolutely love – visually appealing, with intuitive, quick and easy data exploration experience on every device.</p><p>For a free demo, book a meeting: https://bit.ly/43tMPvD</p><p>************************</p>",
      "ratingBuckets": [
        "AboveOne",
        "AboveTwo",
        "AboveThree",
        "AboveFour"
      ],
      "ratingAverage": 5,
      "ratingCount": 10
    }
  ],
  "totalCount": 307
}

定义

名称	说明
AzureBenefit	Azure 消耗承诺权益的资格（https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit）
Badge	锁屏提醒类型
CspState	显示计划是否可通过 CSP 渠道购买的值。有关详细信息，请参阅 https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
Error	搜索错误响应详细信息
ErrorDetails	搜索错误响应详细信息对象
ErrorResponse	搜索错误响应对象
FacetsItem	Facets 项
FacetValue	Facet 值
IndustryCloud	行业云
Metadata	其他计划元数据
PlanSkuRelation	相关计划信息
PlanSummary	计划的摘要说明
PlanType	托管应用程序或解决方案模板计划类型（仅适用于 Azure 应用程序产品）。可能的值： `SolutionTemplate` - 解决方案模板计划类型（仅适用于 Azure 应用程序） `ManagedApplication` - 托管应用程序计划类型（仅适用于 Azure 应用程序）
PricingType	定价类型
ProductSummary	产品的摘要说明
ProductType	传递方法或部署模型
PublisherType	一个值，该值指示这是Microsoft还是第三方产品
PublishingStage	产品发布阶段。可能的值包括：预览版、公共值
RatingBucket	评级存储桶
SearchFieldName	搜索字段名称
SearchResponse	搜索响应对象
Sku	The Sku
StartingPrice	产品最便宜的计划的零售价格
VmArchitectureType	VM 体系结构类型
VmSecurityType	VM 安全类型

AzureBenefit

枚举

Azure 消耗承诺权益的资格（https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit）

值	说明
Eligible	该产品符合 Azure 消耗承诺权益的条件
NotEligible	该产品不符合 Azure 消耗承诺权益的条件

Badge

枚举

锁屏提醒类型

值	说明
AdditionalPurchaseRequirement
PowerBICertified
PreferredSolution

CspState

枚举

显示计划是否可通过 CSP 渠道购买的值。有关详细信息，请参阅 https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers

值	说明
OptIn	计划为 CSP 计划中的任何合作伙伴配置 CSP 计划选择加入
OptOut	计划配置的 CSP 计划选择退出
SelectiveOptIn	为 CSP 计划 ISV 选择的特定合作伙伴配置了 CSP 计划选择

Error

Object

搜索错误响应详细信息

名称	类型	说明
code	string	错误代码说明。例如 code=InternalError
details	ErrorDetails[]	错误响应详细信息列表
message	string	错误消息。例如消息=内部服务器错误

ErrorDetails

Object

搜索错误响应详细信息对象

名称	类型	说明
code	string	错误代码说明。例如 code=InternalError
details	ErrorDetails[]	错误响应详细信息列表
message	string	错误消息。例如消息=内部服务器错误

ErrorResponse

Object

搜索错误响应对象

名称	类型	说明
error	Error	搜索错误响应详细信息

FacetsItem

Object

Facets 项

名称	类型	说明
facetValues	<string, FacetValue>	分面值

FacetValue

Object

Facet 值

名称	类型	说明
count	integer (int64)	Facet 计数

IndustryCloud

枚举

行业云

值	说明
False	假
NotApplicable	不適用
True	真实

Metadata

Object

其他计划元数据

名称	类型	说明
altStackReference	string	指向保存备用堆栈引用的 planId
generation	string	VM 映像生成（仅适用于虚拟机产品）。请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2
relatedSkus	PlanSkuRelation[]	指向与此计划相关的计划的 planId

PlanSkuRelation

Object

名称	类型	说明
relationType	string	关系类型
sku	Sku	The Sku

PlanSummary

Object

计划的摘要说明

名称	类型	说明
altArchitectureReference	string	备用体系结构参考
altStackReference	string	替代堆栈参考
categoryIds	string[]	计划 CategoryIds
cspState	CspState	一个值，该值指示产品是否可通过 CSP 渠道购买
description	string	计划说明
displayName	string	计划的显示名称
displayRank	string	计划的顺序显示在“计划”表中（由发布者配置）
hasProtectedArtifacts	boolean	如果计划具有要为未经身份验证的用户隐藏的项目，则设置为 true
isPrivate	boolean	指示只有受限受众才能访问该计划
metadata	Metadata	其他计划元数据
planId	string	计划 ID
planType	PlanType	托管应用程序或解决方案模板计划类型（仅适用于 Azure 应用程序产品）。可能的值： `SolutionTemplate` - 解决方案模板计划类型（仅适用于 Azure 应用程序） `ManagedApplication` - 托管应用程序计划类型（仅适用于 Azure 应用程序）
pricingTypes	PricingType[]	指定此计划的定价类型的列表（可能的值与产品级别相同）
skuId	string	SKU ID
stackType	string	堆栈类型：经典、Gen1、Gen2
summary	string	计划摘要文本
uniquePlanId	string	唯一计划 ID，其前缀是将 uniqueProductId 和 PlanId 与两者之间没有分隔符的组合
vmArchitectureType	VmArchitectureType	VM 体系结构类型。仅适用于虚拟机产品。 PossibleValues： `Arm64` - 计划的 VM 映像体系结构为 Arm64 `X64Gen1` - 计划的 VM 映像体系结构为 X64 Generation1 `X64Gen2` - 计划的 VM 映像体系结构为 X64 Generation2
vmSecurityTypes	VmSecurityType[]	VM 安全类型。仅适用于虚拟机产品。可能的值： `None` `Trusted` - 使用安全启动和虚拟受信任的平台模块（vTPM）等可配置功能防止 Gen2 虚拟机上的持久性和高级攻击 `Confidential` - 基于受信任的启动，机密虚拟机提供更高的机密性和完整性，通过基于硬件的受信任执行环境保证

PlanType

Object

托管应用程序或解决方案模板计划类型（仅适用于 Azure 应用程序产品）。可能的值：

SolutionTemplate - 解决方案模板计划类型（仅适用于 Azure 应用程序）
ManagedApplication - 托管应用程序计划类型（仅适用于 Azure 应用程序）

PricingType

枚举

定价类型

值	说明
Byol
Free
FreeTrial
Payg
Ri

ProductSummary

Object

产品的摘要说明

名称	类型	说明
azureBenefit	AzureBenefit	Azure 消耗承诺权益的资格（https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit）。可能的值： `Eligible` - 产品符合 Azure 消耗承诺权益的条件 `NotEligible` - 产品不符合 Azure 消耗承诺权益的条件
badges	Badge[]	以下产品锁屏提醒可用：preferredSolution、powerBICertified、AdditionalPurchaseRequirement
description	string	产品说明文本
displayName	string	产品显示名称
lastModifiedDateTime	string (date-time)	产品的最新更新日期
linkedAddInsTypes	object	链接的外接程序类型
longSummary	string	产品长摘要
operatingSystems	string[]	此产品的作系统信息
plans	PlanSummary[]	此产品可用的计划列表
pricingTypes	PricingType[]	指定此套餐的定价类型的列表。可能的值： `Free` - 产品至少有一个免费计划。 `FreeTrial` - 产品至少有一个免费试用版计划。 `Byol` - 产品至少有一个自带许可证的计划。 `Payg` - 产品至少有一个计划是即用即付，基于使用情况的计费模型。 `Ri` - 产品至少有一个计划是预留实例计费模型。
productType	ProductType	传递方法或部署模型。可能的值： `SaaS` - 该产品是从云服务提供商以即用即付方式购买的软件解决方案 `VirtualMachine` - 产品是具有基于使用情况的定价的映像服务实例 `AzureApplication` - 发布为解决方案模板（ST）或 Azure 托管应用（AMA）的产品，用于将 Azure 资源部署到客户租户 `DynamicsCE` - DynamicsBC 和 DynamicsOps 以外的所有 Dynamics 产品 `DynamicsBC` - Dynamics 365 业务中心 `Container` - 产品作为容器交付 `DynamicsOps` - Dynamics 365 Operations 应用程序 `None` - 为 Azure 服务、容器扩展和 VM 扩展返回的产品类型 `IotEdgeModules` - 资源作为 IoT Edge 模块传送 `ContainerApps` - 资源作为容器应用传送 `ConsultingServices` 咨询服务（仅在 Azure 市场中作为列表产品/服务提供） `ManagedServices` - 产品作为托管服务交付 `PowerBI` - Power BI 产品 `CosellOnly` - 仅在 Co-Sell 计划中提供的产品 `PowerBIVisuals` - Power BI 视觉对象产品 `Office365` - Office 365 产品 `DevService` - 开发服务 `AADApps` - Azure Active Directory 应用程序 `VisualStudioExtension` - Visual Studio 扩展
publisherDisplayName	string	发布者显示名称
publisherId	string	发布者 ID
publisherType	PublisherType	一个值，该值指示这是Microsoft还是第三方产品。可能的值： `Microsoft` - 产品由Microsoft发布（第一方产品） `Third Party` - 产品由第三方供应商发布
publishingStage	PublishingStage	产品发布阶段。可能的值： `Preview` - 产品可供受限受众使用 `Public` - 产品在市场中公开发布
ratingAverage	number (double)	产品/服务的平均评级
ratingBuckets	RatingBucket[]	评级存储桶，高于 1、Above2、Above3、Above4
ratingCount	integer (int32)	产品/服务评级总数
smallIconUri	string	小产品图标的 URI
startingPrice	StartingPrice	产品最便宜的计划的零售价格
summary	string	产品摘要
supportedProducts	string[]	映射到发布者提供的兼容产品列表
uniqueProductId	string	唯一的产品标识符

ProductType

枚举

传递方法或部署模型

值	说明
AADApps	Azure Active Directory 应用程序
AppService	用于托管 Web 应用程序、REST API 和移动后端的基于 HTTP 的服务
AzureApplication	发布为解决方案模板（ST）或 Azure 托管应用（AMA）计划的产品，用于将 Azure 资源部署到客户租户。
AzureServices	本机 Azure 服务，例如 Azure Open AI 服务、Azure 存储帐户等。
ConsultingServices	咨询服务（仅在 Azure 市场中作为列表产品/服务提供）
Container	产品作为容器交付
ContainerApps	资源作为容器应用传送
CoreVirtualMachine	具有 Windows 或认可的 Linux OS 映像的虚拟机
CosellOnly	仅在 Co-Sell 计划中提供的产品
DevService	开发服务
DynamicsBC	Dynamics 365 业务中心
DynamicsCE	DynamicsBC 和 DynamicsOps 以外的所有 Dynamics 产品
DynamicsOps	Dynamics 365 Operations 应用程序
IotEdgeModules	资源作为 IoT Edge 模块传送
LogAnalytics	记录来自 Azure Monitor 和其他 Azure 服务的数据的 Log Analytics 服务
ManagedApplication	托管应用程序计划类型（仅适用于 Azure 应用程序）
ManagedServices	产品作为托管服务交付
None	为 Azure 服务、容器扩展和 VM 扩展返回的产品类型
Office365	Office 365 产品
PowerBI	Power BI 产品
PowerBIVisuals	Power BI 视觉对象产品
SaaS	该产品是从云服务提供商以即用即付方式购买的软件解决方案
SolutionTemplate	解决方案模板计划类型（仅适用于 Azure 应用程序）
VirtualMachine	产品是具有基于使用情况的定价的映像服务实例
VisualStudioExtension	Visual Studio 扩展

PublisherType

枚举

一个值，该值指示这是Microsoft还是第三方产品

值	说明
Microsoft	产品由Microsoft发布（第一方产品）
ThirdParty	产品由第三方供应商发布

PublishingStage

枚举

产品发布阶段。可能的值包括：预览版、公共值

值	说明
Preview	产品可供受限受众使用
Public	产品在市场中公开发布

RatingBucket

枚举

评级存储桶

值	说明
AboveFour
AboveOne
AboveThree
AboveTwo

SearchFieldName

枚举

搜索字段名称

值	说明
All
AzureBenefit
Badges
Description
DisplayName
HideKeys
IndustryCloud
Language
LastModifiedDateTime
LongSummary
Market
OperatingSystems
Plans
PricingTypes
ProductType
PublisherDisplayName
PublisherId
PublisherType
PublishingState
RatingAverage
RatingBuckets
RatingCount
SmallIconUri
Summary
SupportedProducts
UniqueProductId
VmArchitectureTypes
VmImageGenerations
VmSecurityTypes

SearchResponse

Object

搜索响应对象

名称	类型	说明
facets	<string, FacetsItem>	搜索方面
nextLink	string	用于获取 API 搜索的下一页的 URL
results	ProductSummary[]	结果
showingResultsFor	string	显示结果
totalCount	integer (int64)	总计数

Sku

Object

The Sku

名称	类型	说明
generation	string	生成
identity	string	标识
name	string	名称

StartingPrice

Object

产品最便宜的计划的零售价格

名称	类型	说明
currency	string	价格货币
market	string	计算起始价的市场
meterUnits	string	计量定价模型单位
minMeterPrice	number	起始（最小）米价格
minTermPrice	number	起始（最小）条款价格
termUnits	string	术语定价模型单位

VmArchitectureType

枚举

VM 体系结构类型

值	说明
Arm64	计划的 VM 映像体系结构为 Arm64
X64Gen1	计划的 VM 映像体系结构为 X64 Generation1
X64Gen2	计划的 VM 映像体系结构为 X64 Generation2

VmSecurityType

枚举

VM 安全类型

值	说明
Confidential
None
Trusted