Product List - List By Subscription

Serviço:

Marketplace Catalog

Versão da API:

2025-05-01

Lista produtos para assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language={language}&excludePublicOffersAndPublicPlans={excludePublicOffersAndPublicPlans}&$filter={$filter}&$select={$select}&$expand={$expand}&$orderBy={$orderBy}&$search={$search}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$expand	query		string	Expande entidades relacionadas em linha
$filter	query		string	Filtra os resultados, com base em uma condição booleana. Exemplo: $filter=productType eq 'VirtualMachine'. Os campos que podem ser filtrados são: 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
$orderBy	query		string	Ordenando a expressão para os resultados usando a notação OData. Evite usar orderby, a menos que seja essencial, pois isso pode afetar a latência da sua solicitação. Exemplo: $orderby=displayName desc. Esta API suporta apenas a ordenação por um único campo. Os campos que podem ser ordenados são: lastModifiedDateTime uniqueProductId productType displayName publisherId'
$search	query		string	Pesquisa opcional por nome de exibição, nome de exibição do editor ou palavras-chave. Exemplo $search=Microsoft
$select	query		string	Seleciona quais propriedades incluir nos resultados. Exemplo: $select=displayName
excludePublicOffersAndPublicPlans	query		boolean	Se deve excluir ofertas públicas e planos públicos da resposta. O padrão é falso, o que significa que ofertas públicas e planos públicos são incluídos na resposta. Se definido como true, apenas os planos privados serão devolvidos.
language	query		string	Língua a pesquisar, código ISO 639-1 de duas letras, valores possíveis - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. O padrão é "en"

Respostas

Name	Tipo	Description
200 OK	ProductSummaryListResult	O pedido foi bem-sucedido.
Other Status Codes	DiscoveryErrorPayload	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ProductList_ListBySubscription

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$filter=productType eq 'SaaS'&$select=displayName,uniqueProductId,productType,publisherDisplayName

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "uniqueProductId": "microsoft.managedinstance_standard",
      "displayName": "Azure SQL Managed Instance",
      "publisherDisplayName": "Microsoft",
      "productType": "SaaS"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$select=displayName,uniqueProductId,productType,publisherDisplayName&$filter=productType eq 'SaaS'&$skiptoken=W3sid..."
}

Definições

Name	Description
Attribute	Representa um atributo SKU, que consiste em uma chave e um valor. Os atributos podem diferir entre vários serviços.
DiscoveryErrorDetails	Detalhes do erro retornados em DiscoveryErrorPayload
DiscoveryErrorPayload	Carga útil de erro retornada pelas APIs de descoberta do Marketplace
PlanMetadata	Metadados adicionais
PlanSummary	Retorna um subconjunto de atributos Plan
ProductSummary	Devolve um subconjunto de atributos de Produto
ProductSummaryListResult	A resposta personalizada de uma operação de lista.

Attribute

Object

Representa um atributo SKU, que consiste em uma chave e um valor. Os atributos podem diferir entre vários serviços.

Name	Tipo	Description
key	string	A chave de atributo
value	string	O valor do atributo

DiscoveryErrorDetails

Object

Detalhes do erro retornados em DiscoveryErrorPayload

Name	Tipo	Description
code	string	O código de erro HTTP
message	string	A mensagem de erro

DiscoveryErrorPayload

Object

Carga útil de erro retornada pelas APIs de descoberta do Marketplace

Name	Tipo	Description
error	DiscoveryErrorDetails	O objeto de detalhes do erro

PlanMetadata

Object

Metadados adicionais

Name	Tipo	Description
altStackReference	string	Apontando para um planId que contém a referência de pilha alternativa
generation	string	A geração de imagem de VM (aplicável apenas a produtos de Máquina Virtual)

PlanSummary

Object

Retorna um subconjunto de atributos Plan

Name	Tipo	Description
altArchitectureReference	string	A referência da arquitetura alternativa
altStackReference	string	Referência de pilha alternativa
categoryIds	string[]	Planejar CategoryIds
cspState	string	Controla a disponibilidade do plano e o acesso do parceiro no programa Microsoft Cloud Solution Provider (CSP). OptIn - Permite que todos os parceiros autorizados do Provedor de Soluções na Nuvem revendam e implantem o produto para os clientes OptOut - Excluído do programa Cloud Solution Provider, disponível apenas através de canais diretos SelectiveOptIn - Disponível apenas para parceiros selecionados do Provedor de Soluções na Nuvem para revenda e implantação de clientes
description	string	Descrição do plano / sku
displayName	string	Nome para exibição do plano / sku
displayRank	string	A ordem em que o plano é exibido na tabela 'Planos'
hasProtectedArtifacts	boolean	Defina como true se o plano tiver artefatos que devem ser ocultos para usuários não autenticados
hasRi	boolean	Indicação se o SKU suporta reservas
isPrivate	boolean	Indicação de que o plano é acessível apenas a público restrito
metadata	PlanMetadata	Metadados de plano/SKU expandidos.
planId	string	Identificador do plano
planType	string	Especifica o modelo de implantação principal e a arquitetura de hospedagem para o produto do marketplace. Os valores atualmente suportados são: None - Tipo de produto não especificado, normalmente usado para produtos sem um modelo de implantação definido DevService - Serviços e ferramentas focados no desenvolvimento para fluxos de trabalho de criação de software ManagedApplication - Aplicativos gerenciados do Azure que implantam e gerenciam recursos em assinaturas de clientes VirtualMachine - Imagens de máquina virtual pré-configuradas implantáveis na infraestrutura de computação do Azure AzureApplication - Aplicativos nativos do Azure aproveitando serviços de plataforma e APIs Container - Aplicações em contentores implementadas através de Instâncias de Contentor do Azure ou serviços semelhantes SaaS - Soluções de Software as a Service hospedadas e gerenciadas pela editora SolutionTemplate - Modelos do Azure Resource Manager que provisionam vários recursos do Azure IotEdgeModules - Módulos projetados para implantação em ambientes de tempo de execução do Azure IoT Edge ManagedServices - Serviços totalmente gerenciados onde o editor lida com infraestrutura e operações ContainerApps - Aplicativos criados para a plataforma de contêiner sem servidor Azure Container Apps VisualStudioExtension - Extensões que se integram com a funcionalidade IDE do Visual Studio DynamicsOps - Aplicativos e extensões do Microsoft Dynamics 365 Finance and Operations DynamicsCE - Aplicativos e personalizações do Microsoft Dynamics 365 Customer Engagement DynamicsBC - Aplicativos e complementos do Microsoft Dynamics 365 Business Central PowerBI - Relatórios, painéis e componentes de visualização de dados do Microsoft Power BI ConsultingServices - Ofertas de serviços profissionais, incluindo implementação e serviços de consultoria CosellOnly - Produtos disponíveis exclusivamente através de programas de parceiros de co-venda da Microsoft CoreVirtualMachine - Principais ofertas de máquinas virtuais com recursos de computação do Azure de linha de base PowerBIVisuals - Visualizações personalizadas para a plataforma de relatórios Microsoft Power BI Office365 - Aplicações, suplementos e integrações Microsoft 365 e Office 365 AADApps - Aplicações integradas do Azure Ative Directory que suportam a identidade organizacional AzureServices - Serviços da plataforma Azure nativa e provedores de recursos AppService - Aplicações Web alojadas na plataforma Azure App Service LogAnalytics - Soluções do Azure Monitor Log Analytics e configurações de espaço de trabalho MicrosoftProduct - Produtos Microsoft primários disponíveis através de canais de mercado
pricingTypes	string[]	Indica os modelos de faturamento e as estruturas de custos disponíveis para o plano. Free - Sem custos para o uso do plano, normalmente para edições da comunidade ou níveis de serviço básicos FreeTrial - Período de acesso gratuito limitado no tempo antes da transição para o modelo de faturação paga Byol - Traga seu próprio modelo de licença onde os clientes fornecem licenças de software existentes Payg - Faturação baseada no consumo Pay As You Go calculada com base na utilização real dos recursos Ri - Faturamento de instâncias reservadas com compromisso inicial para preços de longo prazo com desconto
skuId	string	O ID do SKU
stackType	string	Tipo de pilha: Classic, Gen1, Gen2
summary	string	O texto de resumo do plano
uniquePlanId	string	Identificador de plano exclusivo que é prefixado pela combinação uniqueProductId e PlanId sem separador entre
vmArchitectureType	string	Especifica a arquitetura e a geração do processador da máquina virtual. Aplica-se exclusivamente a tipos de produtos de Máquina Virtual. X64Gen1 - Arquitetura de processador x64 com firmware de máquina virtual de 1ª geração e suporte a BIOS X64Gen2 - Arquitetura de processador x64 com firmware de máquina virtual de 2ª geração e suporte UEFI Arm64 - Arquitetura de processador ARM de 64 bits otimizada para eficiência energética e cargas de trabalho nativas da nuvem
vmSecuritytypes	string[]	Define o nível de aprimoramento de segurança para implantações de máquinas virtuais. Aplica-se exclusivamente a tipos de produtos de Máquina Virtual. None - Segurança de máquina virtual padrão sem recursos de proteção adicionais Trusted - Segurança de lançamento confiável com inicialização segura e recursos virtuais do Trusted Platform Module Confidential - Computação confidencial com criptografia de memória e atestado para cargas de trabalho sensíveis

ProductSummary

Object

Devolve um subconjunto de atributos de Produto

Name	Tipo	Description
applicableProducts	string[]	Categorias de produtos a que a oferta pertence
attributes	Attribute[]	Conjunto de atributos de produtos
azureBenefit	string	Indica se as compras de produtos contam para os benefícios do compromisso de consumo do Azure para clientes corporativos. Eligible - Os custos do produto aplicam-se ao compromisso de consumo do Azure, cálculos de benefícios e créditos NotEligible - Os custos do produto não se qualificam para os programas de benefícios de compromisso de consumo do Azure
badges	string[]	Exibe os selos de certificação e qualificação obtidos pelo produto para visibilidade no mercado. PreferredSolution - Solução reconhecida pela Microsoft atendendo a critérios específicos de qualidade e parceria PowerBICertified - Compatibilidade e integração certificadas com a plataforma Microsoft Power BI AdditionalPurchaseRequirement - O produto requer compras ou subscrições adicionais para uma funcionalidade completa
categoryIds	string[]	Variedade de categorias de produtos
cspLegalTermsUri	string	Os termos legais do produto para o CSP
description	string	O texto da descrição do produto
displayName	string	Nome de exibição do produto
hasMarketplaceFootprint	boolean	Indicação se o produto tem representação no mercado
hasRiPlans	boolean	Indicação se o produto tem planos com reservas
industryIds	string[]	Lista de IDs de indústria a que o item pertence
lastModifiedDateTime	string	Data da última atualização do produto
locations	string[]	Lista de locais que estão disponíveis nos SKUs
longSummary	string	Resumo longo do produto
operatingSystems	string[]	Informações do sistema operacional para este produto
plans	PlanSummary[]	Conjunto completo de atributos de plano/SKU
popularity	number (double)	Popularidade do produto
pricingTypes	string[]	Indica os modelos de faturamento e as estruturas de custos disponíveis para o plano. Free - Sem custos para o uso do plano, normalmente para edições da comunidade ou níveis de serviço básicos FreeTrial - Período de acesso gratuito limitado no tempo antes da transição para o modelo de faturação paga Byol - Traga seu próprio modelo de licença onde os clientes fornecem licenças de software existentes Payg - Faturação baseada no consumo Pay As You Go calculada com base na utilização real dos recursos Ri - Faturamento de instâncias reservadas com compromisso inicial para preços de longo prazo com desconto
privacyPolicyUri	string	A política de privacidade do produto
productFamily	string	Família de Produtos
productId	string	A identificação única do produto
productSubType	string	Subtipo de produto
productType	string	Especifica o modelo de implantação principal e a arquitetura de hospedagem para o produto do marketplace armazenado no Catálogo do Marketplace. None - Tipo de produto não especificado, normalmente usado para produtos sem um modelo de implantação definido ManagedApplication - Aplicativos gerenciados do Azure que implantam e gerenciam recursos em assinaturas de clientes VirtualMachine - Imagens de máquina virtual pré-configuradas implantáveis na infraestrutura de computação do Azure AzureApplication - Aplicativos nativos do Azure aproveitando serviços de plataforma e APIs Container - Aplicações em contentores implementadas através de Instâncias de Contentor do Azure ou serviços semelhantes SaaS - Soluções de Software as a Service hospedadas e gerenciadas pela editora SolutionTemplate - Modelos do Azure Resource Manager que provisionam vários recursos do Azure IotEdgeModules - Módulos projetados para implantação em ambientes de tempo de execução do Azure IoT Edge ManagedServices - Serviços totalmente gerenciados onde o editor lida com infraestrutura e operações ContainerApps - Aplicativos criados para a plataforma de contêiner sem servidor Azure Container Apps DynamicsOps - Aplicativos e extensões do Microsoft Dynamics 365 Finance and Operations DynamicsCE - Aplicativos e personalizações do Microsoft Dynamics 365 Customer Engagement DynamicsBC - Aplicativos e complementos do Microsoft Dynamics 365 Business Central PowerBI - Relatórios, painéis e componentes de visualização de dados do Microsoft Power BI ConsultingServices - Ofertas de serviços profissionais, incluindo implementação e serviços de consultoria CosellOnly - Produtos disponíveis exclusivamente através de programas de parceiros de co-venda da Microsoft CoreVirtualMachine - Principais ofertas de máquinas virtuais com recursos de computação do Azure de linha de base PowerBIVisuals - Visualizações personalizadas para a plataforma de relatórios Microsoft Power BI Office365 - Aplicações, suplementos e integrações Microsoft 365 e Office 365 AADApps - Aplicações integradas do Azure Ative Directory que suportam a identidade organizacional AzureServices - Serviços da plataforma Azure nativa e provedores de recursos AppService - Aplicações Web alojadas na plataforma Azure App Service LogAnalytics - Soluções do Azure Monitor Log Analytics e configurações de espaço de trabalho MicrosoftProduct - Produtos Microsoft primários disponíveis através de canais de mercado
publisherDisplayName	string	Nome de exibição do editor
publisherId	string	ID do editor
publisherType	string	Identifica a relação do editor com a Microsoft para classificação de suporte e parceria. Microsoft - Produto Microsoft primário com suporte e desenvolvimento direto da Microsoft ThirdParty - Produto de fornecedor de software independente com suporte e manutenção fornecidos pelo editor
publishingStage	string	Indica o status de disponibilidade do produto e o nível de acesso do cliente no Azure Marketplace. Preview - Disponibilidade limitada para clientes selecionados para testes e avaliação de acesso antecipado Public - Disponibilidade geral para todos os clientes do Azure Marketplace para implantação de produção
ratingAverage	number (double)	Avaliação média da oferta
ratingBuckets	string[]	Categoriza os produtos por limites de classificação do cliente para filtragem e descoberta do mercado. AboveOne - Produtos com classificações de clientes superiores a 1,0 estrelas com base em avaliações do mercado AboveTwo - Produtos com classificações de clientes superiores a 2,0 estrelas com base em avaliações de mercado AboveThree - Produtos com classificações de clientes superiores a 3,0 estrelas com base em avaliações do mercado AboveFour - Produtos com classificações de clientes superiores a 4,0 estrelas com base em avaliações do mercado
ratingCount	integer (int32)	Número total de avaliações da oferta
service	string	O nome do serviço do produto, como 'Máquinas Virtuais'
serviceFamily	string	A família de serviços do produto, como 'Compute'
smallIconUri	string	URI para o ícone do pequeno produto
summary	string	Resumo do produto
supportedProducts	string[]	Mapas para a lista de produtos compatíveis
uniqueProductId	string	Identificador único do produto

ProductSummaryListResult

Object

A resposta personalizada de uma operação de lista.

Name	Tipo	Description
nextLink	string	O link para a próxima página de itens
value	ProductSummary[]	Os itens desta página