Product List - List By Subscription

Serviço:

Marketplace Catalog

Versão da API:

2025-05-01

Lista os 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 de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		string	Expande entidades relacionadas embutidas
$filter	query		string	Filtra os resultados, com base em uma condição booliana. 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	Ordenação da 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 de sua solicitação. Exemplo: $orderby=displayName desc. Essa 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 é false, o que significa que as ofertas públicas e os planos públicos estão incluídos na resposta. Se definido como true, somente os planos privados serão retornados.
language	query		string	Idioma a pesquisar, código de duas letras ISO 639-1, 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

Nome	Tipo	Description
200 OK	ProductSummaryListResult	A solicitação foi bem-sucedida.
Other Status Codes	DiscoveryErrorPayload	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ProductList_ListBySubscription

Solicitação de exemplo

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 de exemplo

Código de status:

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

Nome	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 de erro retornada pelas APIs de descoberta do Marketplace
PlanMetadata	Metadados adicionais
PlanSummary	Retorna um subconjunto de atributos de plano
ProductSummary	Retorna um subconjunto de atributos do produto
ProductSummaryListResult	A resposta personalizada de uma operação de lista.

Attribute

Objeto

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

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

DiscoveryErrorDetails

Objeto

Detalhes do erro retornados em DiscoveryErrorPayload

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

DiscoveryErrorPayload

Objeto

Carga de erro retornada pelas APIs de descoberta do Marketplace

Nome	Tipo	Description
error	DiscoveryErrorDetails	O objeto de detalhes do erro

PlanMetadata

Objeto

Metadados adicionais

Nome	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 somente a produtos de Máquina Virtual)

PlanSummary

Objeto

Retorna um subconjunto de atributos de plano

Nome	Tipo	Description
altArchitectureReference	string	A referência de arquitetura alternativa
altStackReference	string	Referência de pilha alternativa
categoryIds	string[]	CategoryIds do plano
cspState	string	Controla a disponibilidade do plano e o acesso do parceiro no programa CSP (Provedor de Soluções na Nuvem) da Microsoft. OptIn - Permite que todos os parceiros provedores de soluções em nuvem autorizados revendam e implantem o produto para os clientes OptOut - Excluído do programa Provedor de Soluções na Nuvem, disponível apenas por meio de canais diretos SelectiveOptIn - Disponível apenas para parceiros Provedores de Soluções na Nuvem selecionados para revenda e implantação do cliente
description	string	Descrição do plano / sku
displayName	string	Nome de 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 ocultados para usuários não autenticados
hasRi	boolean	Indicação se o SKU dá suporte a reservas
isPrivate	boolean	Indicação de que o plano é acessível apenas para públicos restritos
metadata	PlanMetadata	Metadados expandidos de plano/SKU.
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 com suporte no momento 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 que aproveitam os serviços e APIs da plataforma Container - Aplicativos em contêineres implantados por meio de Instâncias de Contêiner do Azure ou serviços semelhantes SaaS - Soluções de software como serviço hospedadas e gerenciadas pelo editor SolutionTemplate - Modelos do Azure Resource Manager que provisionam vários recursos do Azure IotEdgeModules - Módulos projetados para implantação em ambientes de runtime do Azure IoT Edge ManagedServices - Serviços totalmente gerenciados em que o editor lida com infraestrutura e operações ContainerApps - Aplicativos criados para a plataforma de contêiner sem servidor dos Aplicativos de Contêiner do Azure VisualStudioExtension - Extensões que se integram à funcionalidade do 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, dashboards e componentes de visualização de dados do Microsoft Power BI ConsultingServices - Ofertas de serviços profissionais, incluindo serviços de implementação e consultoria CosellOnly - Produtos disponíveis exclusivamente por meio de programas de parceiros de venda conjunta da Microsoft CoreVirtualMachine - Principais ofertas de máquina virtual com recursos de computação de linha de base do Azure PowerBIVisuals - Visualizações personalizadas para a plataforma de relatórios do Microsoft Power BI Office365 - Aplicativos, suplementos e integrações do Microsoft 365 e Office 365 AADApps - Aplicativos integrados do Azure Active Directory que dão suporte à identidade organizacional AzureServices - Serviços nativos da plataforma Azure e provedores de recursos AppService - Aplicativos Web hospedados na plataforma do Serviço de Aplicativo do Azure LogAnalytics - Soluções do Log Analytics do Azure Monitor e configurações de workspace MicrosoftProduct - Produtos primários da Microsoft disponíveis por meio de canais de marketplace
pricingTypes	string[]	Indica os modelos de cobrança e as estruturas de custos disponíveis para o plano. Free - Sem cobrança pelo uso do plano, normalmente para edições da comunidade ou níveis de serviço básico FreeTrial - Período de acesso gratuito por tempo limitado antes da transição para o modelo de cobrança paga Byol - Modelo Bring Your Own License, em que os clientes fornecem licenças de software existentes Payg - Faturamento pré-pago baseado em consumo calculado com base no uso real de recursos Ri - Faturamento de instância reservada com compromisso antecipado para preços de longo prazo com desconto
skuId	string	A 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 de uniqueProductId e PlanId sem separador entre eles
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áquina virtual. 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 inicialização 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 confidenciais

ProductSummary

Objeto

Retorna um subconjunto de atributos do produto

Nome	Tipo	Description
applicableProducts	string[]	Categorias de produtos às quais a oferta pertence
attributes	Attribute[]	Conjunto de atributos de produtos
azureBenefit	string	Indica se as compras de produtos contam para os benefícios de compromisso de consumo do Azure para clientes corporativos. Eligible - Os custos do produto se aplicam aos cálculos e créditos do benefício de compromisso de consumo do Azure NotEligible - Os custos do produto não se qualificam para os programas de benefícios de compromisso de consumo do Azure
badges	string[]	Exibe selos de certificação e qualificação obtidos pelo produto para visibilidade no mercado. PreferredSolution - Solução reconhecida pela Microsoft que atende 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 assinaturas adicionais para 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 uma representação no marketplace
hasRiPlans	boolean	Indicação se o produto possui planos com reservas
industryIds	string[]	Lista de IDs de setor às quais o item pertence
lastModifiedDateTime	string	Data da última atualização do produto
locations	string[]	Lista de locais disponíveis nas 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 cobrança e as estruturas de custos disponíveis para o plano. Free - Sem cobrança pelo uso do plano, normalmente para edições da comunidade ou níveis de serviço básico FreeTrial - Período de acesso gratuito por tempo limitado antes da transição para o modelo de cobrança paga Byol - Modelo Bring Your Own License, em que os clientes fornecem licenças de software existentes Payg - Faturamento pré-pago baseado em consumo calculado com base no uso real de recursos Ri - Faturamento de instância reservada com compromisso antecipado 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	O ID exclusivo 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 que aproveitam os serviços e APIs da plataforma Container - Aplicativos em contêineres implantados por meio de Instâncias de Contêiner do Azure ou serviços semelhantes SaaS - Soluções de software como serviço hospedadas e gerenciadas pelo editor SolutionTemplate - Modelos do Azure Resource Manager que provisionam vários recursos do Azure IotEdgeModules - Módulos projetados para implantação em ambientes de runtime do Azure IoT Edge ManagedServices - Serviços totalmente gerenciados em que o editor lida com infraestrutura e operações ContainerApps - Aplicativos criados para a plataforma de contêiner sem servidor dos Aplicativos de Contêiner do Azure 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, dashboards e componentes de visualização de dados do Microsoft Power BI ConsultingServices - Ofertas de serviços profissionais, incluindo serviços de implementação e consultoria CosellOnly - Produtos disponíveis exclusivamente por meio de programas de parceiros de venda conjunta da Microsoft CoreVirtualMachine - Principais ofertas de máquina virtual com recursos de computação de linha de base do Azure PowerBIVisuals - Visualizações personalizadas para a plataforma de relatórios do Microsoft Power BI Office365 - Aplicativos, suplementos e integrações do Microsoft 365 e Office 365 AADApps - Aplicativos integrados do Azure Active Directory que dão suporte à identidade organizacional AzureServices - Serviços nativos da plataforma Azure e provedores de recursos AppService - Aplicativos Web hospedados na plataforma do Serviço de Aplicativo do Azure LogAnalytics - Soluções do Log Analytics do Azure Monitor e configurações de workspace MicrosoftProduct - Produtos primários da Microsoft disponíveis por meio de canais de marketplace
publisherDisplayName	string	Nome a apresentar do Publisher
publisherId	string	ID do editor
publisherType	string	Identifica a relação do editor com a Microsoft para suporte e classificação de parceria. Microsoft - Produto primário da Microsoft com suporte e desenvolvimento diretos 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 teste 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)	Classificação média da oferta
ratingBuckets	string[]	Categoriza os produtos por limites de classificação do cliente para filtragem e descoberta do marketplace. 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 do 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 nas avaliações do mercado
ratingCount	integer (int32)	Número total de classificações para a 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 de produto pequeno
summary	string	Resumo do produto
supportedProducts	string[]	Mapeia para a lista de produtos compatíveis
uniqueProductId	string	Identificador de produto exclusivo

ProductSummaryListResult

Objeto

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

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