Search (stable:2025-05-01)

2025/10/27 • 3 new methods

Facets (new)
Description :  Get counts of Marketplace public products with requested properties.
Reference :  Link ¶

⚼ Request

GET:  /facets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
facets:
{
Description: Array of facets to facet by, if none provided then no facets will return. Such as facets=PricingTypes,operatingSystems. - `SupportedProducts`: Supported Products. - `PublisherType`: Publisher Type. - `AzureBenefit`: Azure Benefit. - `ProductType`: Product Type. - `OperatingSystems`: Operating Systems. - `PricingTypes`: Pricing Types. - `VmImageGenerations`: Vm Image Generations. - `VmSecurityTypes`: Vm Security Types. - `VmArchitectureTypes`: Vm Architecture Types. - `RatingBuckets`: Rating Buckets. ,
Required: False ,
}
array ,
language:
{
Description: 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,id,zh-hans,zh-hant' ,
Required: True ,
}
string ,
market:
{
Description: Product sold market, Possible values - https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies or 'All' for all markets. Such as 'US' ,
Required: True ,
}
string ,
azureBenefit:
{
Description: Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. - `Eligible`: Eligible. - `NotEligible`: Not Eligible. ,
Required: False ,
}
string ,
badges:
{
Description: 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. ,
Required: False ,
}
array ,
hideKeys:
{
Description: Products that contains any of the given hideKeys for preview. Such as '22c6b3ae-1111-1111-1111-e7cbdc8569dd'. If no value provided, this filter is ignored. This filter is applied only when PublishingStage filter is set to Preview. ,
Required: False ,
}
array ,
industryCloud:
{
Description: Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. - `NotApplicable`: Not Applicable. - `True`: True. - `False`: False. ,
Required: False ,
}
string ,
operatingSystems:
{
Description: 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). ,
Required: False ,
}
array ,
pricingTypes:
{
Description: 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. ,
Required: False ,
}
array ,
productTypes:
{
Description: 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. ,
Required: False ,
}
array ,
publisherDisplayName:
{
Description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored. ,
Required: False ,
}
string ,
publisherIds:
{
Description: Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
publisherTypes:
{
Description: 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. ,
Required: False ,
}
array ,
publishingStage:
{
Description: Audience. Default: Public. - `Preview`: Preview. - `Public`: Public ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: 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 ,
Required: False ,
}
array ,
searchQuery:
{
Description: The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat ,
Required: False ,
}
string ,
supportedProducts:
{
Description: Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
vmArchitectureTypes:
{
Description: 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. ,
Required: False ,
}
array ,
vmSecurityTypes:
{
Description: 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 ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The facet items results ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details object ,
Required: True ,
}
{
code:
{
Description: The HTTP error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
}
,
}
Suggestions (new)
Description :  Make suggestions while user is typing a search query for products.
Reference :  Link ¶

⚼ Request

GET:  /suggestions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
language:
{
Description: 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,id,zh-hans,zh-hant' ,
Required: True ,
}
string ,
searchQuery:
{
Description: The search text. If no value is provided, this filter is ignored (e.g., searchQuery=red hat). The query must be at least 2 characters long; shorter values will not return results. ,
Required: True ,
}
string ,
suggestionTypes:
{
Description: Suggestion types. - `WordSearch`: WordSearch. - `Entity`: Entity. ,
Required: True ,
}
array ,
azureBenefit:
{
Description: Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. - `Eligible`: Eligible. - `NotEligible`: Not Eligible. ,
Required: False ,
}
string ,
badges:
{
Description: 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. ,
Required: False ,
}
array ,
industryCloud:
{
Description: Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. - `NotApplicable`: Not Applicable. - `True`: True. - `False`: False. ,
Required: False ,
}
string ,
operatingSystems:
{
Description: 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). ,
Required: False ,
}
array ,
pricingTypes:
{
Description: 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. ,
Required: False ,
}
array ,
productTypes:
{
Description: 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. ,
Required: False ,
}
array ,
publisherDisplayName:
{
Description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored. ,
Required: False ,
}
string ,
publisherIds:
{
Description: Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
publisherTypes:
{
Description: 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. ,
Required: False ,
}
array ,
ratingBuckets:
{
Description: 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 ,
Required: False ,
}
array ,
select:
{
Description: 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. ,
Required: False ,
}
array ,
supportedProducts:
{
Description: Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
top:
{
Description: Number of items to return. Minimum: 0, Maximum: 1000, Default: 20. ,
Format: int32 ,
Required: False ,
}
integer ,
vmArchitectureTypes:
{
Description: 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. ,
Required: False ,
}
array ,
vmSecurityTypes:
{
Description: 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 ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The search results ,
Required: True ,
}
[
{
displayText:
{
Description: The suggestion display text ,
Required: False ,
}
string ,
iconUrl:
{
Description: The suggestion icon url ,
Required: False ,
}
string ,
id:
{
Description: The suggestion item id ,
Required: False ,
}
string ,
linkedAddInsTypes:
{
Description: The suggestion linked add-in types ,
Required: False ,
}
object ,
productType:
{
Description: The suggestion supported product types ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
suggestionType:
{
Description: The search results ,
Enum:
{
WordSearch: No description available. ,
Entity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
totalCount:
{
Description: The total count of search results ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error details object ,
Required: True ,
}
{
code:
{
Description: The HTTP error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
}
,
}