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 2 文字コード、使用可能な値 - 'en,cs,de,es,fr,hu,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-e7cbdc8569dd' など。値が指定されていない場合、このフィルターは無視されます。このフィルターは、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`: 製品には、ライセンスを持ち込むプランが少なくとも 1 つ含まれています。 `Free`: 製品には、無料のプランが少なくとも 1 つ含まれています。 `FreeTrial`: 製品には、無料試用版のプランが少なくとも 1 つ含まれています。 `Payg`: 製品には、従量課金制である使用量ベースの課金モデルが少なくとも 1 つ含まれています。 `RI`: 製品には、予約インスタンスの課金モデルであるプランが少なくとも 1 つ含まれています。
productTypes	query		ProductType[]	指定された製品の種類 ("VirtualMachine" など) を含む製品。値が指定されていない場合、このフィルターは無視されます。 `AADApps`: Azure Active Directory アプリ。 `AzureApplication`: Azure アプリケーション。 `AzureServices`: Azure サービス。 `ConsultingServices`: コンサルティングサービス `Container`: コンテナー。 `ContainerApps`: コンテナーアプリ。 `CoreVirtualMachine`: コア仮想マシン。 `CosellOnly`: 共同販売のみ。 `DevService`: Dev Service。 `DynamicsBC`:ダイナミクス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`: App Service。 `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	対象。既定値: パブリック。 `Preview`: プレビュー。 `Public`: パブリック
ratingBuckets	query		RatingBucket[]	特定の評価バケットのいずれかを含む製品。 "Above1" など。値が指定されていない場合、このフィルターは無視されます。 `AboveOne`: 1 つ上。 `AboveTwo`: 2 の上。 `AboveThree`: 3 より上。 `AboveFour`: 4 つ以上
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 Generation 2。 `Arm64`: Arm64 イメージアーキテクチャ。
vmSecurityTypes	query		VmSecurityType[]	指定された VM セキュリティの種類のいずれかを含む製品。 "信頼済み" など。値が指定されていない場合、このフィルターは無視されます。 `None`: なし。 `Trusted`: 信頼済み。 `Confidential`: 社外秘

要求ヘッダー

名前	必須	型	説明
X-API-Key	True	string	Marketplace カタログチームによって提供される API キーをヘッダーに指定されたパラメーターとして使用する

応答

名前	型	説明
200 OK	SearchResponse	Azure Marketplace カタログオファーと合計カウントとファセットの一覧を返します。
Other Status Codes	ErrorResponse	エラー応答: 400 - 要求の形式が正しくない場合。 401 - API キーヘッダーが見つからないか無効な場合 500 - 内部エラーが発生した場合。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

SearchResponse

Azure Marketplace カタログオファーと合計カウントとファセットの一覧を返します。

Other Status Codes

ErrorResponse

エラー応答:

400 - 要求の形式が正しくない場合。
401 - API キーヘッダーが見つからないか無効な場合
500 - 内部エラーが発生した場合。

ヘッダー

x-ms-error-code: string

セキュリティ

X-API-Key

Marketplace カタログチームによって提供される 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	ファセット項目
FacetValue	ファセット値
IndustryCloud	インダストリークラウド
Metadata	追加のプランメタデータ
PlanSkuRelation	関連プラン情報
PlanSummary	プランの概要の説明
PlanType	マネージドアプリケーションまたはソリューションテンプレートプランの種類 (Azure Applications 製品にのみ適用されます)。使用できる値: `SolutionTemplate` - ソリューションテンプレートプランの種類 (Azure アプリケーションにのみ適用) `ManagedApplication` - マネージドアプリケーションプランの種類 (Azure アプリケーションにのみ適用)
PricingType	価格の種類
ProductSummary	製品の概要の説明
ProductType	配信方法またはデプロイモデル
PublisherType	これが Microsoft 製品かサードパーティ製品かを示す値
PublishingStage	製品発行ステージ。使用可能な値: プレビュー、パブリック
RatingBucket	評価バケット
SearchFieldName	検索フィールド名
SearchResponse	検索応答オブジェクト
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	エラーメッセージ。 message=Internal サーバーエラーなど

ErrorDetails

Object

検索エラー応答の詳細オブジェクト

名前	型	説明
code	string	エラーコードの説明。 code=InternalError など
details	ErrorDetails[]	エラー応答の詳細の一覧
message	string	エラーメッセージ。 message=Internal サーバーエラーなど

ErrorResponse

Object

検索エラー応答オブジェクト

名前	型	説明
error	Error	検索エラー応答の詳細

FacetsItem

Object

ファセット項目

名前	型	説明
facetValues	<string, FacetValue>	ファセット値

FacetValue

Object

ファセット値

名前	型	説明
count	integer (int64)	ファセット数

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	スクウ

PlanSummary

Object

プランの概要の説明

名前	型	説明
altArchitectureReference	string	代替アーキテクチャリファレンス
altStackReference	string	代替スタックリファレンス
categoryIds	string[]	プランカテゴリ ID
cspState	CspState	CSP チャネルを通じて製品を購入できるかどうかを示す値
description	string	プランの説明
displayName	string	プランの表示名
displayRank	string	プランが "Plans" テーブルに表示される順序 (発行元によって構成されている)
hasProtectedArtifacts	boolean	認証されていないユーザーに対して非表示にする成果物がプランにある場合は true に設定します
isPrivate	boolean	制限付き対象ユーザーのみがプランにアクセス可能であることを示す
metadata	Metadata	追加のプランメタデータ
planId	string	プラン ID
planType	PlanType	マネージドアプリケーションまたはソリューションテンプレートプランの種類 (Azure Applications 製品にのみ適用されます)。使用できる値: `SolutionTemplate` - ソリューションテンプレートプランの種類 (Azure アプリケーションにのみ適用) `ManagedApplication` - マネージドアプリケーションプランの種類 (Azure アプリケーションにのみ適用)
pricingTypes	PricingType[]	このプランが指定されている価格の種類の一覧 (使用可能な値は製品レベルと同じです)
skuId	string	SKU ID
stackType	string	スタックの種類: クラシック、Gen1、Gen2
summary	string	プランの概要テキスト
uniquePlanId	string	uniqueProductId と PlanId を組み合わせて先頭に区切り記号がない一意のプラン ID
vmArchitectureType	VmArchitectureType	VM アーキテクチャの種類。仮想マシン製品にのみ適用されます。可能な値: `Arm64` - プランの VM イメージアーキテクチャは Arm64 です `X64Gen1` - プランの VM イメージアーキテクチャは X64 Generation1 です `X64Gen2` - プランの VM イメージアーキテクチャは X64 Generation2 です
vmSecurityTypes	VmSecurityType[]	VM のセキュリティの種類。仮想マシン製品にのみ適用されます。使用可能な値: `None` `Trusted` - セキュリティブートや仮想トラステッドプラットフォームモジュール (vTPM) などの構成可能な機能を使用して、Gen2 仮想マシンに対する永続的かつ高度な攻撃から保護します `Confidential` - 信頼された起動に加え、機密仮想マシンは、ハードウェアベースの信頼された実行環境で保証された高い機密性と整合性を提供します

PlanType

Object

マネージドアプリケーションまたはソリューションテンプレートプランの種類 (Azure Applications 製品にのみ適用されます)。使用できる値:

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` - 製品には、無料のプランが少なくとも 1 つ用意されています。 `FreeTrial` - 製品には、無料試用版であるプランが少なくとも 1 つ用意されています。 `Byol` - 製品には、ライセンスを持ち込むプランが少なくとも 1 つ用意されています。 `Payg` - 製品には、従量課金制である使用量ベースの課金モデルが少なくとも 1 つ含まれます。 `Ri` - 製品には、予約インスタンスの課金モデルであるプランが少なくとも 1 つ含まれます。
productType	ProductType	配信方法またはデプロイモデル。使用可能な値: `SaaS` - 製品は、クラウドサービスプロバイダーから従量課金制で購入されたソフトウェアソリューションです `VirtualMachine` - 製品は、使用量ベースの価格を持つイメージサービスインスタンスです `AzureApplication` - 顧客テナントに Azure リソースをデプロイするソリューションテンプレート (ST) または Azure Managed Apps (AMA) プランとして公開された製品 `DynamicsCE` - DynamicsBC および DynamicsOps を除くすべての Dynamics 製品 `DynamicsBC` - Dynamics 365 Business Central `Container` - 製品はコンテナーとして配信されます `DynamicsOps` - Dynamics 365 Operations アプリ `None` - Azure サービス、コンテナー拡張機能、VM 拡張機能に対して返される製品の種類 `IotEdgeModules` - リソースは IoT Edge モジュールとして配信されます `ContainerApps` - リソースはコンテナーアプリとして配信されます `ConsultingServices` コンサルティングサービス (リストオファーとして Azure Marketplace でのみ利用可能) `ManagedServices` - 製品はマネージドサービスとして配信されます `PowerBI` - Power BI 製品 `CosellOnly` - Co-Sell プログラムの範囲でのみ利用可能な製品 `PowerBIVisuals` - Power BI ビジュアル製品 `Office365` - Office 365 製品 `DevService` - Devサービス `AADApps` - Azure Active Directory アプリケーション `VisualStudioExtension` - Visual Studio 拡張機能
publisherDisplayName	string	発行元の表示名
publisherId	string	パブリッシャー ID
publisherType	PublisherType	これが Microsoft 製品かサードパーティ製品かを示す値。使用可能な値: `Microsoft` - 製品は Microsoft (ファーストパーティ製品) によって公開されています `Third Party` - 製品はサードパーティベンダーによって公開されています
publishingStage	PublishingStage	製品発行ステージ。使用可能な値: `Preview` - 制限付き対象ユーザーが製品を利用できる `Public` - 製品は Marketplace で一般公開されています
ratingAverage	number (double)	オファーの平均評価
ratingBuckets	RatingBucket[]	評価バケット、Above1、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	顧客テナントに Azure リソースをデプロイするソリューションテンプレート (ST) または Azure Managed Apps (AMA) プランとして発行された製品。
AzureServices	Azure Open AI サービス、Azure Storage アカウントなどのネイティブ Azure サービス。
ConsultingServices	コンサルティングサービス (リストオファーとして Azure Marketplace でのみ利用可能)
Container	製品がコンテナーとして配信される
ContainerApps	リソースがコンテナーアプリとして配信される
CoreVirtualMachine	Windows または動作保証済みの Linux OS イメージを使用する仮想マシン
CosellOnly	Co-Sell プログラムの範囲でのみ利用可能な製品
DevService	Dev サービス
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	製品は Marketplace で一般公開されています

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

スクウ

名前	型	説明
generation	string	生成
identity	string	ID
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

次の方法で共有

Search - Get

URI パラメーター

要求ヘッダー

応答

セキュリティ

X-API-Key

例

Search_Get

要求のサンプル

応答のサンプル

定義

AzureBenefit

Badge

CspState

Error

ErrorDetails

ErrorResponse

FacetsItem

FacetValue

IndustryCloud

Metadata

PlanSkuRelation

PlanSummary

PlanType

PricingType

ProductSummary

ProductType

PublisherType

PublishingStage

RatingBucket

SearchFieldName

SearchResponse

Sku

StartingPrice

VmArchitectureType

VmSecurityType