Suggestions - Get Products

Service:: Marketplace Catalog

API Version:: 2023-01-01-preview

Make suggestions while user is typing a search query for products.

GET https://catalogapi.azure.com/suggestions/products?api-version=2023-01-01-preview&searchQuery={searchQuery}&language={language}&suggestionTypes={suggestionTypes}

With optional parameters:

GET https://catalogapi.azure.com/suggestions/products?api-version=2023-01-01-preview&searchQuery={searchQuery}&publisherDisplayName={publisherDisplayName}&azureBenefit={azureBenefit}&publisherTypes={publisherTypes}&badges={badges}&industryCloud={industryCloud}&language={language}&productTypes={productTypes}&pricingTypes={pricingTypes}&operatingSystems={operatingSystems}&supportedProducts={supportedProducts}&publisherIds={publisherIds}&ratingBuckets={ratingBuckets}&vmArchitectureTypes={vmArchitectureTypes}&vmSecurityTypes={vmSecurityTypes}&suggestionTypes={suggestionTypes}&top={top}&select={select}

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version of the REST API used for the request.
language	query	True	string	Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'
searchQuery	query	True	string	The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat
suggestionTypes	query	True	SuggestionType[]	Suggestion types. `WordSearch`: WordSearch. `Entity`: Entity.
azureBenefit	query		AzureBenefit	Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. `Eligible`: Eligible. `NotEligible`: Not Eligible.
badges	query		Badge[]	Products that contains any of the given badges. If no value provided, this filter is ignored. The following product badges are available: `PreferredSolution`: Preferred Solution. `PowerBICertified`: power BI Certified. `AdditionalPurchaseRequirement`: Additional Purchase Requirement.
industryCloud	query		IndustryCloud	Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. `NotApplicable`: Not Applicable. `True`: True. `False`: False.
operatingSystems	query		string[]	Products that contains any of the given operating systems, Such as operatingSystems=windows,linux. If no value provided, this filter is ignored. This filter is relevant for Virtual Machine product type only. `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`: Others (windows). `windows.windowsserver2022`: Windows Server 2022. `linux.centos`: Cent OS. `linux.debian`: Debian. `linux.redhat`: Red Hat. `linux.suse`: SUSE. `linux.ubuntu`: Ubuntu. `linux.others`: Others (Linux).
pricingTypes	query		PricingType[]	Products that contains any of the given pricing types. If no value provided, this filter is ignored. `Byol`: The product has at least one plan that is bring your own license. `Free`: The product has at least one plan that is free of charge. `FreeTrial`: The product has at least one plan that is free trial. `Payg`: The product has at least one plan that is Pay as you go, usage based billing model. `RI`: The product has at least one plan that is Reserved Instance billing model.
productTypes	query		ProductType[]	Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. `AADApps`: Azure Active Directory Apps. `AzureApplication`: Azure Application. `AzureServices`: Azure Services. `ConsultingServices`: Consulting Services. `Container`: Container. `ContainerApps`: Container Apps. `CoreVirtualMachine`: Core Virtual Machine. `CosellOnly`: Cosell Only. `DevService`: Dev Service. `DynamicsBC`: Dynamics BC. `DynamicsCE`: Dynamics CE. `DynamicsOps`: Dynamics Ops. `IotEdgeModules`: Iot Edge Modules. `ManagedApplication`: Managed Application. `ManagedServices`: Managed Services. `Office365`: Office365. `PowerBI`: PowerBI. `PowerBIVisuals`: PowerBI Visuals. `SaaS`: SaaS. `SolutionTemplate`: Solution Template. `VirtualMachine`: Virtual Machine. `VisualStudioExtension`: Visual Studio Extension. `AppService`: App Service. `LogAnalytics`: Log Analytics.
publisherDisplayName	query		string	The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored.
publisherIds	query		string[]	Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored.
publisherTypes	query		PublisherType[]	Products that contains any of the given publisher types, If no value provided, this filter is ignored. Possible values: Microsoft, ThirdParty. Default: Microsoft. `Microsoft`: Microsoft. `ThirdParty`: Third Party.
ratingBuckets	query		RatingBucket[]	Products that contains any of the given rating buckets. Such as 'Above1'. If no value provided, this filter is ignored. `AboveOne`: Above One. `AboveTwo`: Above Two. `AboveThree`: Above Three. `AboveFour`: Above Four
select	query		SuggestionsFieldName[]	Array of fields to return. Such as 'displayText'. If no value provided, return fields as follows. if suggestionsType=Entity, return: suggestionType, displayText, id. if suggestionType=WordSearch, return suggestionType and displayText. `DisplayText`: Display text. `Id`: Id. `IconUrl`: Icon Url. `ProductType`: Product type. `LinkedAddInsTypes`: Linked AddIns types.
supportedProducts	query		string[]	Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored.
top	query		integer (int32)	Number of items per SuggestionType to return. Minimum: 1, Maximum: 40, Default: 20.
vmArchitectureTypes	query		VmArchitectureType[]	Array of Virtual Machine image architecture types to search by, If no value provided, this filter is ignored. see https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2: `X64Gen1`: X64 Generation 1. `X64Gen2`: X64 Generation 2. `Arm64`: Arm64 image architecture.
vmSecurityTypes	query		VmSecurityType[]	Products that contains any of the given vm security types. Such as 'Trusted'. If no value provided, this filter is ignored. `None`: None. `Trusted`: Trusted. `Confidential`: Confidential

Request Header

Name	Required	Type	Description
X-API-Key	True	string	Use Api key provided by Marketplace Catalog Team as a parameter provided in the header

Responses

Name	Type	Description
200 OK	SuggestionsResponse	Returns a list of azure marketplace products suggestions and count
Other Status Codes	ErrorResponse	Error Responses: 400 - In case request malformed. 401 - In case of a missing or invalid api key header 500 - In case internal error. Headers x-ms-error-code: string

Name

Type

Description

200 OK

SuggestionsResponse

Returns a list of azure marketplace products suggestions and count

Other Status Codes

ErrorResponse

Error Responses:

400 - In case request malformed.
401 - In case of a missing or invalid api key header
500 - In case internal error.

Headers

x-ms-error-code: string

Security

X-API-Key

Use Api key provided by Marketplace Catalog Team as a parameter provided in the header

Type: apiKey
In: header

Examples

SuggestionsProducts_Get

Sample request

HTTP

GET https://catalogapi.azure.com/suggestions/products?api-version=2023-01-01-preview&searchQuery=chec&azureBenefit={azureBenefit}&language=en&productTypes=ConsultingServices&suggestionTypes=WordSearch,Entity&top=2

Sample response

Status code:: 200

{
  "value": [
    {
      "suggestionType": "WordSearch",
      "displayText": "check"
    },
    {
      "suggestionType": "WordSearch",
      "displayText": "checklist"
    },
    {
      "suggestionType": "Entity",
      "displayText": "SQL Server: Server Health Check - 8h Assessment",
      "id": "datamazesrl1608285157396.hcsr1",
      "iconUrl": "https://store-images.s-microsoft.com/image/apps.7625.f95e1f9c-fa83-47f3-8b4f-ba3446fc54ec.be999560-f0a6-4819-8aa0-7233334d7981.3c51ad8d-44d3-4039-b1ba-b27e7b1d1132",
      "productType": "ConsultingServices"
    },
    {
      "suggestionType": "Entity",
      "displayText": "SQL Server: Database Health Check - 4h Assessment",
      "id": "datamazesrl1608285157396.hcdb1",
      "iconUrl": "https://store-images.s-microsoft.com/image/apps.7625.2bb59018-1124-460e-a797-3cf19400dd45.acdba8b9-449f-457e-b44b-02e324f47191.886f0f35-340f-4f2a-b70c-7532a3868c2f",
      "productType": "ConsultingServices"
    }
  ],
  "totalCount": 4
}

Definitions

Name	Description
AzureBenefit	Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)
Badge	Badge type
Error	The search error response details
ErrorDetails	The search error response details object
ErrorResponse	The search error response object
IndustryCloud	Industry Cloud
PricingType	Pricing type
ProductType	The delivery method or deployment model
PublisherType	A value indicating whether this is a Microsoft or third party product
RatingBucket	Rating Bucket
SuggestionsFieldName	The suggestions field name
SuggestionsItem	The suggestion item
SuggestionsResponse	The suggestion response
SuggestionType	The type of the suggestion
VmArchitectureType	VM Architecture Type
VmSecurityType	VM Security type

AzureBenefit

Enumeration

Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)

Value	Description
Eligible	the product is eligible for Azure consumption commitment benefit
NotEligible	the product is not eligible for Azure consumption commitment benefit

Badge

Enumeration

Badge type

Value	Description
PreferredSolution
PowerBICertified
AdditionalPurchaseRequirement

Error

Object

The search error response details

Name	Type	Description
code	string	The error code description. Such as code=InternalError
details	ErrorDetails[]	List of error response details
message	string	The error message. Such as message=Internal server error

ErrorDetails

Object

The search error response details object

Name	Type	Description
code	string	The error code description. Such as code=InternalError
details	ErrorDetails[]	List of error response details
message	string	The error message. Such as message=Internal server error

ErrorResponse

Object

The search error response object

Name	Type	Description
error	Error	The search error response details

IndustryCloud

Enumeration

Industry Cloud

Value	Description
NotApplicable	Not Applicable
True	True
False	False

PricingType

Enumeration

Pricing type

Value	Description
Free
FreeTrial
Byol
Payg
Ri

ProductType

Enumeration

The delivery method or deployment model

Value	Description
None	product type returned for Azure Services, Container Extensions and VM extensions
DevService	Dev Service
ManagedApplication	Managed Application plan type (applicable to Azure Applications only)
VirtualMachine	the product is Image service instances with usage-based pricing
AzureApplication	products published as Solution Templates (ST) or Azure Managed Apps (AMA) plans that deploy Azure resources to the customer tenant.
Container	the product is delivered as Container
SaaS	the product is a Software solution purchased on pay-as-you-go basis from a cloud service provider
SolutionTemplate	Solution Template plan type (applicable to Azure Applications only)
IotEdgeModules	resource is delivered as IoT Edge Module
ManagedServices	the product is delivered as Managed Service
ContainerApps	resource is delivered as Container App
VisualStudioExtension	Visual Studio Extensions
DynamicsOps	Dynamics 365 Operations Apps
DynamicsCE	All Dynamics products except for DynamicsBC and DynamicsOps
DynamicsBC	Dynamics 365 Business Central
PowerBI	Power BI products
ConsultingServices	Consulting Services (available only in Azure Marketplace as listing offers)
CosellOnly	Products available in scope of Co-Sell program only
CoreVirtualMachine	Virtual Machine with Windows or endorsed Linux OS image
PowerBIVisuals	Power BI Visuals products
Office365	Office 365 products
AADApps	Azure Active Directory Applications
AzureServices	Native Azure Services such as Azure Open AI service, Azure Storage Account, etc.
AppService	HTTP-based service for hosting web applications, REST APIs, and mobile back ends
LogAnalytics	Log Analytics services that log data from Azure Monitor and other Azure services

PublisherType

Enumeration

A value indicating whether this is a Microsoft or third party product

Value	Description
Microsoft	Product is published by Microsoft (1st party product)
ThirdParty	Product is published by Third Party Vendor

RatingBucket

Enumeration

Rating Bucket

Value	Description
AboveOne
AboveTwo
AboveThree
AboveFour

SuggestionsFieldName

Enumeration

The suggestions field name

Value	Description
DisplayText
Id
IconUrl
ProductType
LinkedAddInsTypes

SuggestionsItem

Object

The suggestion item

Name	Type	Description
displayText	string	The suggestion display text
iconUrl	string	The suggestion icon url
id	string	The suggestion item id
linkedAddInsTypes	object	The suggestion linked add-in types
productType	ProductType	The suggestion supported product types
suggestionType	SuggestionType	The suggestion type

SuggestionsResponse

Object

The suggestion response

Name	Type	Description
totalCount	integer (int64)	The suggestion count
value	SuggestionsItem[]	The suggestion items results

SuggestionType

Enumeration

The type of the suggestion

Value	Description
WordSearch
Entity

VmArchitectureType

Enumeration

VM Architecture Type

Value	Description
X64Gen1	The VM image architecture of the plan is X64 Generation1
X64Gen2	The VM image architecture of the plan is X64 Generation2
Arm64	The VM image architecture of the plan is Arm64

VmSecurityType

Enumeration

VM Security type

Value	Description
None
Trusted
Confidential

Share via

Suggestions - Get Products

URI Parameters

Request Header

Responses

Security

X-API-Key

Examples

SuggestionsProducts_Get

Sample request

Sample response

Definitions

AzureBenefit

Badge

Error

ErrorDetails

ErrorResponse

IndustryCloud

PricingType

ProductType

PublisherType

RatingBucket

SuggestionsFieldName

SuggestionsItem

SuggestionsResponse

SuggestionType

VmArchitectureType

VmSecurityType