Changelog of Azure APIs

2025/11/03 • 3 updated methods

Facets (updated)

Description	: Get counts of Marketplace public products with requested properties.
Reference	: Link ¶

⚶ Changes

{
  "#id": "Facets",
  "$parameters": [
    {
      "#name": "language",
      "Description": {
        "new": "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'",
        "old": "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'"
      }
    },
    {
      "#name": "productTypes",
      "Description": {
        "new": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. Possible values include, but are not limited to:\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.",
        "old": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored.\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics."
      }
    }
  ]
}

⚼ 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,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. Possible values include, but are not limited to: - `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 ,

}

Search (updated)

Description	: Serves a user experience with search and filter results on Marketplace public products.
Reference	: Link ¶

⚶ Changes

{
  "#id": "Search",
  "$parameters": [
    {
      "#name": "language",
      "Description": {
        "new": "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'",
        "old": "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'"
      }
    },
    {
      "#name": "productTypes",
      "Description": {
        "new": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. Possible values include, but are not limited to:\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.",
        "old": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored.\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "productType",
              "Description": {
                "new": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
                "old": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET: /search

{

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,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 ,

select:

{

Description: Array of fields to return. Such as select=pricingTypes. - `All`: All fields. - `SupportedProducts`: Supported Products. - `PublisherId`: Publisher Id. - `DisplayName`: Display Name. - `AzureBenefit`: Azure Benefit. - `Badges`: Badges. - `SmallIconUri`: Small Icon Uri. - `PublisherType`: Publisher Type. - `PublishingState`: Publishing State. - `UniqueProductId`: Unique Product Id. - `ProductType`: Product Type. - `Plans`: Plans. - `OperatingSystems`: Operating Systems. - `PricingTypes`: Pricing Types. - `PublisherDisplayName`: Publisher Display Name. - `Summary`: Summary. - `Description`: Description. - `RatingBuckets`: Rating Buckets. - `RatingAverage`: Rating Average. - `LastModifiedDateTime`: Last Modified time. - `RatingCount`: Rating Count. - `LongSummary`: Long Summary. ,

Required: False ,

}

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:

{

Required: False ,

}

array ,

facets:

{

Required: False ,

}

array ,

hideKeys:

{

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:

{

Required: False ,

}

array ,

orderby:

{

Description: Array of sort by fields to order by and ordering type (asc\desc), If no value provided, ordered by search score. Default ordering type: asc. For example, orderby=RatingCount desc. - `RatingCount`: ratingCount (asc/desc). - `LastModifiedDateTime`: lastModifiedDateTime (asc/desc). - `RatingAverage`: RatingAverage (asc/desc). ,

Required: False ,

}

array ,

pricingTypes:

{

Required: False ,

}

array ,

productTypes:

{

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:

{

Required: False ,

}

array ,

publishingStage:

{

Description: Audience. Default: Public. - `Preview`: Preview. - `Public`: Public ,

Required: False ,

}

string ,

ratingBuckets:

{

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 ,

top:

{

Description: Number of items to return. Minimum: 0, Maximum: 1000, Default: 20. ,

Format: int32 ,

Required: False ,

}

integer ,

vmArchitectureTypes:

{

Required: False ,

}

array ,

vmSecurityTypes:

{

Required: False ,

}

array ,

}

⚐ Response (200)

{

facets:

{

Description: The search facets ,

Required: False ,

}

object ,

results:

{

Description: The search results ,

Required: True ,

}

[

{

displayName:

{

Description: Product display name ,

Required: False ,

}

string ,

publisherId:

{

Description: Publisher id ,

Required: False ,

}

string ,

azureBenefit:

{

Description: Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers. - `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits - `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs ,

Enum:

{

Eligible: No description available. ,

NotEligible: No description available. ,

}

Required: False ,

}

enum ,

badges:

{

Description: Displays certification and qualification badges earned by the product for marketplace visibility ,

Required: False ,

}

[

string ,

]

publisherType:

{

Description: Identifies the publisher relationship to Microsoft for support and partnership classification. - `Microsoft` - First-party Microsoft product with direct Microsoft support and development - `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance ,

Required: False ,

}

string ,

publishingStage:

{

Description: Indicates the product availability status and customer access level within Azure Marketplace. - `Preview` - Limited availability to selected customers for testing and early access evaluation - `Public` - General availability to all Azure Marketplace customers for production deployment ,

Required: False ,

}

string ,

uniqueProductId:

{

Description: Unique product identifier ,

Required: True ,

}

string ,

productType:

{

Description: Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to: - `None` - Unspecified product type, typically used for products without a defined deployment model - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,

Required: True ,

}

string ,

productSubType:

{

Description: Product sub type ,

Required: False ,

}

string ,

productFamily:

{

Description: Product Family ,

Required: False ,

}

string ,

operatingSystems:

{

Description: Operating system info for this product ,

Required: False ,

}

[

string ,

]

pricingTypes:

{

Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,

Required: False ,

}

[

string ,

]

publisherDisplayName:

{

Description: Publisher display name ,

Required: False ,

}

string ,

longSummary:

{

Description: Product long summary ,

Required: False ,

}

string ,

summary:

{

Description: Product summary ,

Required: False ,

}

string ,

linkedAddInsTypes:

{

Description: Linked add-in types ,

Required: False ,

}

object ,

smallIconUri:

{

Description: URI to the small product icon ,

Required: False ,

}

string ,

description:

{

Description: The product description text ,

Required: False ,

}

string ,

cspLegalTermsUri:

{

Description: The legal terms of the product for the CSP ,

Required: False ,

}

string ,

privacyPolicyUri:

{

Description: The privacy policy of the product ,

Required: False ,

}

string ,

ratingBuckets:

{

Description: Categorizes products by customer rating thresholds for marketplace filtering and discovery. - `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews - `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews - `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews - `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews ,

Required: False ,

}

[

string ,

]

ratingAverage:

{

Description: Average rating for the offer ,

Format: double ,

Required: False ,

}

number ,

ratingCount:

{

Description: Total number of ratings for the offer ,

Format: int32 ,

Required: False ,

}

integer ,

startingPrice:

{

Description: Retail price of the product's cheapest plan ,

Required: False ,

}

{

market:

{

Description: The market for which the starting price is calculated ,

Required: False ,

}

string ,

termUnits:

{

Description: The terms pricing model units ,

Required: False ,

}

string ,

meterUnits:

{

Description: The meters pricing model units ,

Required: False ,

}

string ,

minTermPrice:

{

Description: Starting (minimal) terms price ,

Format: float ,

Required: False ,

}

number ,

minMeterPrice:

{

Description: Starting (minimal) meters price ,

Format: float ,

Required: False ,

}

number ,

currency:

{

Description: Currency for price ,

Required: False ,

}

string ,

}

plans:

{

Description: Full set of plan/SKU attributes ,

Required: False ,

}

[

{

planId:

{

Description: Plan identifier ,

Required: False ,

}

string ,

uniquePlanId:

{

Description: Unique plan Id which is prefixed by combining uniqueProductId and PlanId with no separator in between ,

Required: False ,

}

string ,

displayName:

{

Description: Display name of the plan / sku ,

Required: False ,

}

string ,

vmArchitectureType:

{

Description: Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types. - `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support - `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support - `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads ,

Required: False ,

}

string ,

cspState:

{

Description: Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program. - `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers - `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels - `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment ,

Required: False ,

}

string ,

metadata:

{

Description: Expanded plan/SKU metadata ,

Required: False ,

}

{

generation:

{

Description: The VM image generation (applicable to Virtual Machine products only) ,

Required: False ,

}

string ,

altStackReference:

{

Description: Pointing to a planId which holds the alternative stack reference ,

Required: False ,

}

string ,

relatedSkus:

{

Description: Other plans that may be related to this plan ,

Required: False ,

}

[

{

sku:

{

Description: The related Sku ,

Required: False ,

}

{

name:

{

Description: The Sku name ,

Required: False ,

}

string ,

generation:

{

Description: The Sku generation ,

Required: False ,

}

string ,

identity:

{

Description: The Sku identity ,

Required: False ,

}

string ,

}

relationType:

{

Description: Relation Type ,

Required: False ,

}

string ,

}

]

}

altStackReference:

{

Description: Alternative stack reference ,

Required: False ,

}

string ,

stackType:

{

Description: Stack type : Classic, Gen1, Gen2 ,

Required: False ,

}

string ,

altArchitectureReference:

{

Description: The alternative architecture reference ,

Required: False ,

}

string ,

categoryIds:

{

Description: Plan CategoryIds ,

Required: False ,

}

[

string ,

]

hasProtectedArtifacts:

{

Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,

Required: False ,

}

boolean ,

pricingTypes:

{

Required: False ,

}

[

string ,

]

vmSecuritytypes:

{

Description: Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types. - `None` - Standard virtual machine security without additional protection features - `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities - `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads ,

Required: False ,

}

[

string ,

]

summary:

{

Description: The plan summary text ,

Required: False ,

}

string ,

description:

{

Description: Plan / sku description ,

Required: False ,

}

string ,

skuId:

{

Description: The SKU id ,

Required: False ,

}

string ,

planType:

{

Description: Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are: - `None` - Unspecified product type, typically used for products without a defined deployment model - `DevService` - Development-focused services and tools for software creation workflows - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,

Required: True ,

}

string ,

displayRank:

{

Description: The order the plan is displayed in the 'Plans' table. Note that lower numbers appear first. ,

Required: False ,

}

string ,

isPrivate:

{

Description: Indication that the plan is accessible to restricted audience only ,

Required: False ,

}

boolean ,

hasRi:

{

Description: Indication whether the SKU supports reservations ,

Required: False ,

}

boolean ,

}

]

supportedProducts:

{

Description: Maps to the list of compatible products ,

Required: False ,

}

[

string ,

]

applicableProducts:

{

Description: Product categories the offer belongs to ,

Required: False ,

}

[

string ,

]

lastModifiedDateTime:

{

Description: Latest update date of the product ,

Required: False ,

}

string ,

locations:

{

Description: List of locations which are available on the SKUs ,

Required: False ,

}

[

string ,

]

serviceFamily:

{

Description: The service family of the product, such as 'Compute' ,

Required: False ,

}

string ,

service:

{

Description: The service name of the product, such as 'Virtual Machines' ,

Required: False ,

}

string ,

productId:

{

Description: A unique commercial identifier used to reference a specific product in transactional operations such as purchases, invoicing, and metering. This Id services entitlement validation, and billing across systems ,

Required: False ,

}

string ,

hasRiPlans:

{

Description: Indication whether the product has plans with reservations ,

Required: False ,

}

boolean ,

hasMarketplaceFootprint:

{

Description: Indication of whether product appears in Azure Marketplace ,

Required: False ,

}

boolean ,

attributes:

{

Description: Set of products attributes ,

Required: False ,

}

[

{

key:

{

Description: The attribute key ,

Required: False ,

}

string ,

value:

{

Description: The attribute value ,

Required: False ,

}

string ,

}

]

activeDirectoryAppId:

{

Description: Used to map SaaS apps to their Azure AD appIds ,

Required: False ,

}

string ,

}

]

totalCount:

{

Description: The total count of search results ,

Format: int64 ,

Required: False ,

}

integer ,

showingResultsFor:

{

Description: The search query used ,

Required: False ,

}

string ,

nextLink:

{

Description: The next link for pagination, if available ,

Required: False ,

}

string ,

}

⚐ 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 (updated)

Description	: Make suggestions while user is typing a search query for products.
Reference	: Link ¶

⚶ Changes

{
  "#id": "Suggestions",
  "$parameters": [
    {
      "#name": "language",
      "Description": {
        "new": "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'",
        "old": "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'"
      }
    },
    {
      "#name": "productTypes",
      "Description": {
        "new": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. Possible values include, but are not limited to:\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.",
        "old": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored.\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics."
      }
    }
  ]
}

⚼ 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,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:

{

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:

{

Required: False ,

}

array ,

pricingTypes:

{

Required: False ,

}

array ,

productTypes:

{

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:

{

Required: False ,

}

array ,

ratingBuckets:

{

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:

{

Required: False ,

}

array ,

vmSecurityTypes:

{

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 ,

}

Search (stable:2025-05-01)

⚶ Changes

⚼ Request

⚐ Response (200)

⚐ Response (default)

⚶ Changes

⚼ Request

⚐ Response (200)

⚐ Response (default)

⚶ Changes

⚼ Request

⚐ Response (200)

⚐ Response (default)