v4

latestSwagger 2.02026-07-1331871.3 KB

Serves a user experience with search and filter results on Marketplace public products.

get/search

Query parameters

api-versionstring required

The API version to use for this operation.

languagestring required

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'

marketstring required

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'

selectstring[]

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.
azureBenefit'Eligible' | 'NotEligible'

Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null.

  • Eligible: Eligible.
  • NotEligible: Not Eligible.
badgesstring[]

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.
facetsstring[]

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.
hideKeysstring[]

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.

industryCloud'NotApplicable' | 'True' | 'False'

Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable.

  • NotApplicable: Not Applicable.
  • True: True.
  • False: False.
operatingSystemsstring[]

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).
orderbystring[]

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).
pricingTypesstring[]

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.
productTypesstring[]

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.
publisherDisplayNamestring

The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored.

publisherIdsstring[]

Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored.

publisherTypesstring[]

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.
publishingStage'Preview' | 'Public'

Audience. Default: Public.

  • Preview: Preview.
  • Public: Public
ratingBucketsstring[]

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
searchQuerystring

The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat

supportedProductsstring[]

Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored.

topinteger

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

vmArchitectureTypesstring[]

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.
vmSecurityTypesstring[]

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

Response

The request has succeeded.

facetsobject

The search facets

totalCountinteger

The total count of search results

showingResultsForstring

The search query used

nextLinkstring

The next link for pagination, if available