v3

latestSwagger 2.02026-07-1333587.2 KB

Retrieves a list of products available in the marketplace catalog

get/products

Query parameters

api-versionstring required

The API version to use for this operation.

languagestring

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'. Default is "en"

locationsstring[]

Return products available in selected location. For more information on Azure datacenter regions see: https://azure.microsoft.com/regions/

marketstring

Product market value. The response will include only products that can be sold in the specified market. Based on ISO-3166 format. Possible values can be found at https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Example: 'US'

hideKeysstring[]

This key is utilized to retrieve preview products and is generated within the Partner Center during the offer publishing process

$selectstring

Selects which properties to include in the results. Example: $select=displayName

$filterstring

Filters the results, based on a Boolean condition. Example: $filter=productType eq 'VirtualMachine'. Note that not all fields support filtering. Fields that can be filtered by are:

  • displayName
  • productId
  • popularity
  • categoryIds
  • industryIds
  • publisherId
  • uniqueProductId
  • productType
  • operatingSystems
  • pricingTypes
  • publisherDisplayName
  • longSummary
  • summary
  • linkedAddinsTypes
  • description
  • supportedProducts
  • applicableProducts
  • lastModifiedDateTime
  • plan.planId
  • plan.displayName
  • plan.cspState
  • plan.altStackReference
  • plan.stackType
  • plan.categoryIds
  • plan.hasProtectedArtifacts
  • plan.pricingTypes
  • plan.summary
  • plan.description
  • plan.skuId
  • plan.displayRank
  • plan.isPrivate
$expandstring

Expands related entities inline. Example: $expand=startingPrice

$orderBystring

Ordering expression for the results using OData notation. Avoid using orderby unless essential as this may impact the latency of your request. Example: $orderby=displayName desc.This API only supports ordering by a single field. Fields that can be ordered by are:

  • lastModifiedDateTime
  • uniqueProductId
  • productType
  • displayName
  • publisherId
$searchstring

Optional search by display name, publisher display name, or keywords. Example $search=Microsoft

Response

The request has succeeded.

nextLinkstring

Link to the next page of results, if available

All 3 operations