Products - List
Obtenha uma lista de produtos públicos comerciais.
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&storefront={storefront}&language={language}&locations={locations}&market={market}&hideKeys={hideKeys}&select={select}&filter={filter}&expand={expand}&orderby={orderby}
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versão da API REST usada para a solicitação. |
|
expand
|
query |
string[] |
Expande entidades relacionadas em linha. Exemplo: 'expand=startingPrice' |
|
|
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:
|
|
|
hide
|
query |
string[] |
Essa chave é utilizada para recuperar produtos de visualização e é gerada no Partner Center durante o processo de publicação da oferta. |
|
|
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,zh-hans,zh-hant'. O padrão é "en" |
|
|
locations
|
query |
string[] |
Devolver produtos disponíveis no local selecionado. Enumeração das regiões do datacenter do Azure. Veja https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Valor de mercado do produto (a resposta incluirá apenas produtos que podem ser vendidos no mercado especificado) Os valores possíveis podem ser encontrados em https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Exemplo: 'US' |
|
|
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:
|
|
|
select
|
query |
string[] |
Seleciona quais propriedades incluir nos resultados. Exemplo: 'select=displayName' |
|
|
storefront
|
query |
string |
Devolver produtos disponíveis no Azure Portal Marketplace, AppSource ou portal do Azure Marketplace. Os valores possíveis são:
|
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| X-API-Key | True |
string |
Use a chave Api fornecida pela Equipe de Catálogo do Marketplace como um parâmetro fornecido no cabeçalho |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
Devolve uma lista de produtos públicos ou de pré-visualização |
|
| Other Status Codes |
Respostas de erro:
Cabeçalhos x-ms-error-code: string |
Exemplos
List_Products
Pedido de amostra
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Resposta da amostra
{
"items": [
{
"displayName": "productDisplayName",
"popularity": 1,
"categoryIds": [
"monitoring-and-diagnostics",
"virtualMachine"
],
"industryIds": [
"consumer-goods",
"retailers"
],
"publisherId": "Microsoft",
"azureBenefit": "Eligible",
"badges": [
"ExternalPurchase"
],
"publisherType": "Microsoft",
"publishingStage": "Public",
"uniqueProductId": "uniqueProductId",
"productType": "VirtualMachine",
"productSubType": "Azure",
"operatingSystems": [
"windows.others"
],
"pricingTypes": [
"Payg"
],
"publisherDisplayName": "Microsoft",
"longSummary": "longSummary",
"summary": "summary",
"smallIconUri": "SomeIconUri",
"description": "productDescription",
"ratingBuckets": [
"AboveOne"
],
"ratingAverage": 0,
"ratingCount": 0,
"plans": [
{
"planId": "plan1Id",
"uniquePlanId": "uniquePlan1Id",
"displayName": "displayName",
"vmArchitectureType": "X64Gen1",
"cspState": "SelectiveOptIn",
"metadata": {
"generation": null,
"altStackReference": null
},
"altStackReference": "altStackReference",
"stackType": "Classic",
"altArchitectureReference": "altArchitectureReference",
"categoryIds": [],
"hasProtectedArtifacts": false,
"pricingTypes": [
"Payg"
],
"vmSecuritytypes": [
"None"
],
"summary": "PlanSummary",
"description": "plan description",
"skuId": "0001",
"planType": "VirtualMachine",
"displayRank": "2147483647",
"isPrivate": false
}
],
"supportedProducts": [
"suportedProduct1"
],
"applicableProducts": [
"applicableProduct1"
],
"locations": [
"EU North"
],
"serviceFamily": "service family",
"service": "service name",
"productId": "product id",
"hasMarketplaceFootprint": true,
"attributes": null,
"lastModifiedDateTime": "2022-02-14T23:31:25.5733368+00:00"
},
{
"displayName": "display name",
"popularity": 0,
"publisherId": "Microsoft",
"azureBenefit": "NotEligible",
"publisherType": "Microsoft",
"productType": "AzureServices",
"productSubType": "Azure",
"pricingTypes": [],
"publisherDisplayName": "Microsoft",
"description": "description",
"locations": [
"US West 2",
"UK South",
"BR South"
],
"serviceFamily": "Compute",
"service": "Virtual Machines",
"productId": "product id",
"hasMarketplaceFootprint": false,
"attributes": [
{
"key": "attr1",
"value": "val1"
}
]
}
],
"nextPageLink": "https://catalogapi.azure.com/products?api-version=2023-05-01-preview&$skiptoken=W3s..."
}
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. |
|
Azure |
Elegibilidade para o benefício de compromisso de consumo do Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valores possíveis:
|
| Badge |
Tipo de emblema |
|
Catalog |
Página de resposta composta por uma lista de objetos Product (que inclui subconjunto de atributos de produto) juntamente com um link de página seguinte. Normalmente, os atributos de produto retornados na lista são usados para criar blocos de produtos para a Galeria do Marketplace. Nota:nota O número máximo de itens devolvidos por página é 100. Em casos específicos para otimização de desempenho, entre em contato com a equipe do Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Valor mostrando se o plano está disponível para compra através do canal CSP. Valores possíveis:
|
|
Error |
O objeto de resposta de erro da API |
|
Error |
O objeto de detalhes da resposta de erro da API |
| Metadata |
Metadados de plano/SKU expandidos. |
|
Plan |
Apontando para um objeto SKU relacionado |
|
Plan |
Retorna um subconjunto de atributos Plan |
|
Plan |
Tipo de plano de modelo de Aplicativo Gerenciado ou Solução (aplicável somente ao produto Aplicativos do Azure). Valores possíveis:
|
|
Pricing |
Tipo de preço |
|
Product |
Devolve um subconjunto de atributos de Produto |
|
Product |
O método de entrega ou modelo de implantação. Valores possíveis:
|
|
Publisher |
Um valor que indica se este é um produto da Microsoft ou de terceiros. Valores possíveis:
|
|
Publishing |
Fase de publicação do produto. Valores possíveis:
|
|
Rating |
Balde de Avaliação |
| Sku |
O Sku |
|
Starting |
Preço de varejo do plano mais barato do produto |
|
Vm |
Tipo de arquitetura VM. Aplicável apenas a produtos de Máquina Virtual. Valores possíveis:
|
|
Vm |
Tipo de segurança VM. Aplicável apenas a produtos de Máquina Virtual. Valores possíveis:
|
Attribute
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 |
AzureBenefit
Elegibilidade para o benefício de compromisso de consumo do Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valores possíveis:
-
Eligible- O produto é elegível para o benefício de compromisso de consumo do Azure -
NotEligible- O produto não é elegível para o benefício de compromisso de consumo do Azure
| Valor | Description |
|---|---|
| Eligible | |
| NotEligible |
Badge
Tipo de emblema
| Valor | Description |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Página de resposta composta por uma lista de objetos Product (que inclui subconjunto de atributos de produto) juntamente com um link de página seguinte. Normalmente, os atributos de produto retornados na lista são usados para criar blocos de produtos para a Galeria do Marketplace. Nota:nota O número máximo de itens devolvidos por página é 100. Em casos específicos para otimização de desempenho, entre em contato com a equipe do Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Name | Tipo | Description |
|---|---|---|
| items |
A lista de itens devolvidos |
|
| nextPageLink |
string (uri) |
Link para a próxima página onde a solicitação retorna mais de uma única página de resultados |
CspState
Valor mostrando se o plano está disponível para compra através do canal CSP. Valores possíveis:
-
OptIn- Planejar o opt-in do programa CSP configurado para qualquer parceiro no Programa CSP -
Optout- Planejar a exclusão do programa CSP configurado -
SelectiveOptIn- Planeje o opt-in do programa CSP configurado para parceiros específicos no programa CSP selecionado pelo ISV. Para mais informações, consultar: https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Valor | Description |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
O objeto de resposta de erro da API
| Name | Tipo | Description |
|---|---|---|
| error |
Os detalhes da resposta da API |
ErrorResponseDetails
O objeto de detalhes da resposta de erro da API
| Name | Tipo | Description |
|---|---|---|
| code |
string |
A descrição do código de erro. Como code=InternalError |
| message |
string |
A mensagem de erro. Como message=Erro interno do servidor |
Metadata
Metadados de plano/SKU expandidos.
| 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).consulte https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Apontando para um planId de planos que estão relacionados a este plano |
PlanSkuRelation
Apontando para um objeto SKU relacionado
| Name | Tipo | Description |
|---|---|---|
| relationType |
string |
Tipo de relação |
| sku |
O Sku |
PlanSummary
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 |
Valor mostrando se o plano está disponível para compra através do canal CSP. Valores possíveis:
|
|
| 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' (conforme configurado pelo editor) |
| 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 |
Metadados de plano/SKU expandidos. |
|
| planId |
string |
Id do plano |
| planType |
Tipo de plano de modelo de Aplicativo Gerenciado ou Solução (aplicável somente ao produto Aplicativos do Azure). Valores possíveis:
|
|
| pricingTypes |
A lista dos tipos de preços para os quais este plano é designado (Os valores possíveis são os mesmos que no nível do produto) |
|
| skuId |
string |
O ID do SKU |
| stackType |
string |
Tipo de pilha: Classic, Gen1, Gen2 |
| summary |
string |
O texto de resumo do plano |
| uniquePlanId |
string |
Id de plano exclusivo que é prefixado combinando uniqueProductId e PlanId sem separador entre |
| vmArchitectureType |
Tipo de arquitetura VM. Aplicável apenas a produtos de Máquina Virtual. Valores possíveis:
|
|
| vmSecuritytypes |
Tipo de segurança VM. Aplicável apenas a produtos de Máquina Virtual. Valores possíveis:
|
PlanType
Tipo de plano de modelo de Aplicativo Gerenciado ou Solução (aplicável somente ao produto Aplicativos do Azure). Valores possíveis:
-
SolutionTemplate- Tipo de plano de Modelo de Solução (aplicável apenas a Aplicações do Azure) -
ManagedApplication- Tipo de plano de Aplicativo Gerenciado (aplicável somente aos Aplicativos do Azure)
PricingType
Tipo de preço
| Valor | Description |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Devolve um subconjunto de atributos de Produto
| Name | Tipo | Description |
|---|---|---|
| applicableProducts |
string[] |
Categorias de produtos a que a oferta pertence |
| attributes |
Conjunto de atributos de produtos (varia de acordo com o tipo de produto), onde cada atributo é representado por um par de chave (nome do atributo) e valor (valor do atributo) |
|
| azureBenefit |
Elegibilidade para o benefício de compromisso de consumo do Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valores possíveis:
|
|
| badges |
Badge[] |
Os seguintes emblemas de produto estão disponíveis: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Variedade de categorias de produtos, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Como a "produtividade" |
| 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 (date-time) |
Data da última atualização do produto |
| linkedAddInsTypes |
object |
Tipos de suplementos vinculados |
| 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 |
Lista de planos disponíveis para este produto |
|
| popularity |
number (double) |
Popularidade do produto |
| pricingTypes |
A lista dos tipos de preços para os quais esta oferta é designada. Valores possíveis:
|
|
| 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 |
O método de entrega ou modelo de implantação. Valores possíveis:
|
|
| publisherDisplayName |
string |
Nome de exibição do editor |
| publisherId |
string |
ID do editor |
| publisherType |
Um valor que indica se este é um produto da Microsoft ou de terceiros. Valores possíveis:
|
|
| publishingStage |
Fase de publicação do produto. Valores possíveis:
|
|
| ratingAverage |
number (double) |
Avaliação média da oferta |
| ratingBuckets |
Baldes de avaliação, Acima1, Acima2, Acima3, Acima4 |
|
| 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 |
| startingPrice |
Preço de varejo do plano mais barato do produto |
|
| summary |
string |
Resumo do produto |
| supportedProducts |
string[] |
Mapeia para a lista de produtos compatíveis que o editor fornece |
| uniqueProductId |
string |
Identificador único do produto |
ProductType
O método de entrega ou modelo de implantação. Valores possíveis:
-
SaaS- O produto é uma solução de software comprada em regime de pagamento consoante a utilização a um fornecedor de serviços na nuvem -
VirtualMachine- O produto é instâncias de serviço de imagem com preços baseados no uso -
AzureApplication- Produtos publicados como planos de Modelos de Solução (ST) ou Aplicativos Gerenciados do Azure (AMA) que implantam recursos do Azure para o locatário do cliente -
DynamicsCE- Todos os produtos Dynamics, exceto DynamicsBC e DynamicsOps -
DynamicsBC- Central de negócios do Dynamics 365 -
Container- O produto é entregue como Container -
DynamicsOps- Aplicativos de Operações do Dynamics 365 -
None- Tipo de produto retornado para Serviços do Azure, Extensões de Contêiner e extensões de VM -
IotEdgeModules- O recurso é fornecido como IoT Edge Module -
ContainerApps- O recurso é entregue como Container App -
ConsultingServicesServiços de Consultoria (disponíveis apenas no Azure Marketplace como ofertas de listagem) -
ManagedServices- O produto é entregue como Serviço Gerenciado -
PowerBI- Produtos Power BI -
CosellOnly- Produtos disponíveis apenas no âmbito do programa Co-Sell -
PowerBIVisuals- Produtos do Power BI Visuals -
Office365- Produtos do Office 365 -
DevService- Serviço de Desenvolvimento -
AADApps- Aplicativos do Ative Directory do Azure -
VisualStudioExtension- Extensões do Visual Studio -
SolutionTemplate- Tipo de plano de Modelo de Solução (aplicável apenas a Aplicações do Azure) -
ManagedApplication- Tipo de plano de Aplicativo Gerenciado (aplicável somente aos Aplicativos do Azure) -
MicrosoftProduct- Produto Azure de 1ª parte
| Valor | Description |
|---|---|
| None | |
| DevService | |
| ManagedApplication | |
| VirtualMachine | |
| AzureApplication | |
| Container | |
| SaaS | |
| SolutionTemplate | |
| IotEdgeModules | |
| ManagedServices | |
| ContainerApps | |
| VisualStudioExtension | |
| DynamicsOps | |
| DynamicsCE | |
| DynamicsBC | |
| PowerBI | |
| ConsultingServices | |
| CosellOnly | |
| CoreVirtualMachine | |
| PowerBIVisuals | |
| Office365 | |
| AADApps | |
| AzureServices | |
| AppService | |
| LogAnalytics | |
| MicrosoftProduct |
PublisherType
Um valor que indica se este é um produto da Microsoft ou de terceiros. Valores possíveis:
-
Microsoft- O produto é publicado pela Microsoft (produto de terceiros) -
Third Party- O produto é publicado por um fornecedor terceiro
| Valor | Description |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Fase de publicação do produto. Valores possíveis:
-
Preview- O produto está disponível para público restrito -
Public- O produto está disponível publicamente no Marketplace
| Valor | Description |
|---|---|
| Preview | |
| Public |
RatingBucket
Balde de Avaliação
| Valor | Description |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
O Sku
| Name | Tipo | Description |
|---|---|---|
| generation |
string |
A geração |
| identity |
string |
A identidade |
| name |
string |
O nome |
StartingPrice
Preço de varejo do plano mais barato do produto
| Name | Tipo | Description |
|---|---|---|
| currency |
string |
Moeda para o preço |
| market |
string |
O mercado para o qual o preço inicial é calculado |
| meterUnits |
string |
As unidades do modelo de preços dos contadores |
| minMeterPrice |
number |
Preço inicial (mínimo) dos metros |
| minTermPrice |
number |
Preço inicial (mínimo) |
| termUnits |
string |
Os termos unidades de modelo de preços |
VmArchitectureType
Tipo de arquitetura VM. Aplicável apenas a produtos de Máquina Virtual. Valores possíveis:
-
Arm64- A arquitetura de imagem VM do plano é Arm64 -
X64Gen1- A arquitetura de imagem VM do plano é X64 Generation1 -
X64Gen2- A arquitetura de imagem VM do plano é X64 Generation2
| Valor | Description |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Tipo de segurança VM. Aplicável apenas a produtos de Máquina Virtual. Valores possíveis:
- Standard - Nível básico de segurança para a máquina virtual
- Confiável - protege contra ataques persistentes e avançados em máquinas virtuais Gen2 com recursos configuráveis, como inicialização de segurança e vTPM (Trusted Platform Module) virtual
- Confidencial - além do Trusted Launch, as máquinas virtuais confidenciais oferecem maior confidencialidade e integridade garantidas com um ambiente de execução confiável baseado em hardware
| Valor | Description |
|---|---|
| None | |
| Trusted | |
| Confidential |