Public Products - List

Servicio:: Marketplace Catalog

Versión de la API:: 2023-01-01-preview

Obtén una lista de productos comerciales públicos.

GET https://catalogapi.azure.com/products?api-version=2023-01-01-preview

Con parámetros opcionales:

GET https://catalogapi.azure.com/products?api-version=2023-01-01-preview&storefront={storefront}&language={language}&market={market}&hideKeys={hideKeys}&select={select}&filter={filter}&expand={expand}&orderby={orderby}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Versión de la API REST que se usa para la solicitud.
expand	query		string[]	Expande las entidades relacionadas insertadas. Ejemplo: 'expand=startingPrice'
filter	query		string	Filtra los resultados, en función de una condición booleana. Ejemplo: 'filter=productType eq "VirtualMachine"'. Los campos que se pueden filtrar por son: `displayName` `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`
hideKeys	query		string[]	Agregue ocultar clave para recuperar elementos de vista previa. Las teclas Hidekey se proporcionan en formato "multi". Ejemplo: HideKey[]=first
language	query		string	Idioma para buscar, código de dos letras ISO 639-1, valores posibles - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. El valor predeterminado es "en"
market	query		string	Valor de mercado del producto (la respuesta incluirá solo los productos que se pueden vender en el mercado especificado) Los valores posibles se pueden encontrar en https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Ejemplo: "EE. UU.
orderby	query		string	Expresión de ordenación de los resultados mediante notación OData. Evite usar orderby a menos que sea esencial, ya que esto puede afectar a la latencia de la solicitud. Ejemplo: 'orderby=displayName desc'. Esta API solo admite la ordenación por un solo campo. Los campos que se pueden ordenar mediante son: `lastModifiedDateTime` `uniqueProductId` `productType` `displayName` `publisherId`
select	query		string[]	Selecciona las propiedades que se van a incluir en los resultados. Ejemplo: 'select=displayName'
storefront	query		string	Escaparate relevante, valores posibles: "azure, amp, appsource". Default='azure'

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
X-API-Key	True	string	Uso de la clave de API proporcionada por el equipo de catálogo de Marketplace como parámetro proporcionado en el encabezado

Respuestas

Nombre	Tipo	Description
200 OK	CatalogApiResponse	Devuelve una lista de productos públicos o en versión preliminar.
Other Status Codes	ErrorResponse	Respuestas de error: 400 - En caso de una solicitud mal configurada. 401: en caso de que falte un encabezado de clave de API 500- En caso de error interno. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

CatalogApiResponse

Devuelve una lista de productos públicos o en versión preliminar.

Other Status Codes

ErrorResponse

Respuestas de error:

400 - En caso de una solicitud mal configurada.
401: en caso de que falte un encabezado de clave de API
500- En caso de error interno.

Encabezados

x-ms-error-code: string

Ejemplos

Product_Get

Solicitud de ejemplo

HTTP

GET https://catalogapi.azure.com/products?api-version=2023-01-01-preview&language=en&market=US

Respuesta de muestra

status code:: 200

{
  "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",
      "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"
      ],
      "lastModifiedDateTime": "2022-02-14T23:31:25.5733368+00:00"
    }
  ],
  "nextPageLink": "https://catalogapi.azure.com/products?api-version=2023-01-01-preview&$skiptoken=W3sidG9rZW4iOiIrUklEOn4yVk53QU9LeFJIQWNBZ0FBQUFBQURnPT0jUlQ6MSNUUkM6MTU0I0lTVjoyI0lFTzo2NTU1MSNRQ0Y6OCIsInJhbmdlIjp7Im1pbiI6IjA1QzFFNzMzOTlDRDVFIiwibWF4IjoiMDVDMUU5NDk2NTMxMTIifX1d"
}

Definiciones

Nombre	Description
AzureBenefit	Elegibilidad para la ventaja de compromiso de consumo de Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)
Badge	Tipo de distintivo
CatalogApiResponse	Página de respuesta compuesta de una lista de resúmenes de productos junto con un vínculo de página siguiente
CspState	Valor que muestra si el plan está disponible para su compra a través del canal CSP. Para obtener más información, consulte https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
ErrorResponse	El objeto de respuesta de error de la API de catálogo
ErrorResponseDetails	El objeto catalog API error response details (Detalles de respuesta de error de la API de catálogo)
Metadata	Metadatos de plan adicionales
PlanSkuRelation	Información relacionada del plan
PlanSummary	Descripción de resumen del plan
PlanType	Tipo de plan de plantilla de aplicación administrada o solución (aplicable solo al producto De aplicaciones de Azure). Valores posibles: `SolutionTemplate`: tipo de plan de plantilla de solución (aplicable solo a aplicaciones de Azure) `ManagedApplication`: tipo de plan de aplicación administrada (aplicable solo a aplicaciones de Azure)
PricingType	Tipo de precios
ProductSummary	Descripción de resumen del producto
ProductType	El método de entrega o el modelo de implementación
PublisherType	Valor que indica si se trata de un producto de Microsoft o de terceros.
PublishingStage	Fase de publicación del producto. Los valores posibles son: Versión preliminar, Público
RatingBucket	Cubo de clasificación
Sku	El SKU
StartingPrice	Precio comercial del plan más barato del producto
VmArchitectureType	Tipo de arquitectura de máquina virtual
VmSecurityType	Tipo de seguridad de máquina virtual

AzureBenefit

Enumeración

Elegibilidad para la ventaja de compromiso de consumo de Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)

Valor	Description
Eligible
NotEligible

Badge

Enumeración

Tipo de distintivo

Valor	Description
AdditionalPurchaseRequirement
PowerBICertified
PreferredSolution

CatalogApiResponse

Object

Página de respuesta compuesta de una lista de resúmenes de productos junto con un vínculo de página siguiente

Nombre	Tipo	Description
items	ProductSummary[]	Lista de elementos devueltos
nextPageLink	string (uri)	Vínculo a la página siguiente donde la solicitud devuelve más de una sola página de resultados

CspState

Enumeración

Valor que muestra si el plan está disponible para su compra a través del canal CSP. Para obtener más información, consulte https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers

Valor	Description
OptIn
OptOut
SelectiveOptIn

ErrorResponse

Object

El objeto de respuesta de error de la API de catálogo

Nombre	Tipo	Description
error	ErrorResponseDetails	Detalles de la respuesta de la API de catálogo

ErrorResponseDetails

Object

El objeto catalog API error response details (Detalles de respuesta de error de la API de catálogo)

Nombre	Tipo	Description
code	string	Descripción del código de error. Por ejemplo, code=InternalError
message	string	Mensaje de error. Por ejemplo, message=Error interno del servidor

Metadata

Object

Metadatos de plan adicionales

Nombre	Tipo	Description
altStackReference	string	Apuntar a un planId que contiene la referencia de pila alternativa
generation	string	Generación de imágenes de máquina virtual (aplicable solo a los productos de máquina virtual). Consulte https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2
relatedSkus	PlanSkuRelation[]	Apuntar a un planId de plan relacionado con este plan

PlanSkuRelation

Object

Información relacionada del plan

Nombre	Tipo	Description
relationType	string	Tipo de relación
sku	Sku	El SKU

PlanSummary

Object

Descripción de resumen del plan

Nombre	Tipo	Description
altArchitectureReference	string	Referencia de arquitectura alternativa
altStackReference	string	Referencia de pila alternativa
categoryIds	string[]	Plan CategoryIds
cspState	CspState	Valor que indica si el producto está disponible para su compra a través del canal CSP.
description	string	Descripción del plan
displayName	string	Nombre para mostrar del plan
displayRank	string	El orden en el que se muestra el plan en la tabla "Planes" (según lo configurado por el publicador)
hasProtectedArtifacts	boolean	Establézcalo en true si el plan tiene artefactos que se van a ocultar para los usuarios no autenticados
isPrivate	boolean	Indicación de que el plan solo es accesible para la audiencia restringida
metadata	Metadata	Metadatos de plan adicionales
planId	string	Identificador del plan
planType	PlanType	Tipo de plan de plantilla de aplicación administrada o solución (aplicable solo al producto De aplicaciones de Azure). Valores posibles: `SolutionTemplate`: tipo de plan de plantilla de solución (aplicable solo a aplicaciones de Azure) `ManagedApplication`: tipo de plan de aplicación administrada (aplicable solo a aplicaciones de Azure)
pricingTypes	PricingType[]	Lista de los tipos de precios para los que se designa este plan (Los valores posibles son los mismos que en el nivel de producto)
skuId	string	Identificador de SKU
stackType	string	Tipo de pila: Clásico, Gen1, Gen2
summary	string	Texto de resumen del plan
uniquePlanId	string	Identificador de plan único prefijo mediante la combinación de uniqueProductId y PlanId sin separador entre
vmArchitectureType	VmArchitectureType	Tipo de arquitectura de máquina virtual. Aplicable solo a los productos de máquina virtual. Valores posibles: `Arm64`: la arquitectura de la imagen de máquina virtual del plan es Arm64. `X64Gen1`: la arquitectura de imagen de máquina virtual del plan es X64 Generation1. `X64Gen2`: la arquitectura de imagen de máquina virtual del plan es X64 Generation2.
vmSecuritytypes	VmSecurityType[]	Tipo de seguridad de máquina virtual. Aplicable solo a los productos de máquina virtual. Valores posibles: Estándar: nivel básico de seguridad para la máquina virtual Confianza: protege contra ataques persistentes y avanzados en máquinas virtuales gen2 con características configurables, como el arranque de seguridad y el módulo virtual de plataforma segura (vTPM) Confidencial: además del inicio seguro, las máquinas virtuales confidenciales ofrecen mayor confidencialidad e integridad garantizadas con el entorno de ejecución de confianza basado en hardware.

PlanType

Object

Tipo de plan de plantilla de aplicación administrada o solución (aplicable solo al producto De aplicaciones de Azure). Valores posibles:

SolutionTemplate: tipo de plan de plantilla de solución (aplicable solo a aplicaciones de Azure)
ManagedApplication: tipo de plan de aplicación administrada (aplicable solo a aplicaciones de Azure)

PricingType

Enumeración

Tipo de precios

Valor	Description
Byol
Free
FreeTrial
Payg
Ri

ProductSummary

Object

Descripción de resumen del producto

Nombre	Tipo	Description
applicableProducts	string[]	Categorías de productos a las que pertenece la oferta
azureBenefit	AzureBenefit	Elegibilidad para la ventaja de compromiso de consumo de Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valores posibles: `Eligible`: el producto es apto para la ventaja de compromiso de consumo de Azure. `NotEligible`: el producto no es apto para la ventaja de compromiso de consumo de Azure
badges	Badge[]	Están disponibles las siguientes notificaciones de producto: preferredSolution, powerBICertified, AdditionalPurchaseRequirement
categoryIds	string[]	Matriz de categorías de productos, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Por ejemplo, "Productividad"
description	string	Texto de la descripción del producto
displayName	string	Nombre para mostrar del producto
industryIds	string[]	Lista de identificadores del sector al que pertenece el elemento
lastModifiedDateTime	string (date-time)	Fecha de actualización más reciente del producto
linkedAddInsTypes	object	Tipos de complementos vinculados
longSummary	string	Resumen largo del producto
operatingSystems	string[]	Información del sistema operativo para este producto
plans	PlanSummary[]	Lista de planes disponibles para este producto
popularity	number (double)	Popularidad del producto
pricingTypes	PricingType[]	Lista de los tipos de precios para los que se designa esta oferta. Valores posibles: `Free`: el producto tiene al menos un plan gratuito. `FreeTrial`: el producto tiene al menos un plan que es una evaluación gratuita. `Byol`: el producto tiene al menos un plan que traiga su propia licencia. `Payg`: el producto tiene al menos un plan que es Pago por uso, modelo de facturación basado en el uso. `Ri`: el producto tiene al menos un plan que es el modelo de facturación de instancias reservadas.
productType	ProductType	El método de entrega o el modelo de implementación. Valores posibles: `SaaS`: el producto es una solución de software comprada de pago por uso desde un proveedor de servicios en la nube `VirtualMachine`: el producto es instancias del servicio Image con precios basados en el uso `AzureApplication`: productos publicados como plantillas de solución (ST) o planes de Azure Managed Apps (AMA) que implementan recursos de Azure en el inquilino del cliente `DynamicsCE`: todos los productos de Dynamics excepto DynamicsBC y DynamicsOps `DynamicsBC`: Dynamics 365 Business Central `Container`: el producto se entrega como contenedor `DynamicsOps`: Aplicaciones de operaciones de Dynamics 365 `None`: tipo de producto devuelto para servicios de Azure, extensiones de contenedor y extensiones de máquina virtual `IotEdgeModules`: el recurso se entrega como módulo ioT Edge `ContainerApps`: el recurso se entrega como aplicación contenedora `ConsultingServices`: servicios de consultoría (disponibles solo en Azure Marketplace como ofertas de descripción) `ManagedServices`: el producto se entrega como servicio administrado `PowerBI`: productos de Power BI `CosellOnly`: productos disponibles solo en el ámbito del programa de Co-Sell `PowerBIVisuals`: productos de objetos visuales de Power BI `Office365`: productos de Office 365 `DevService`: servicio de desarrollo `AADApps`: aplicaciones de Azure Active Directory `VisualStudioExtension`: extensiones de Visual Studio
publisherDisplayName	string	Nombre para mostrar del publicador
publisherId	string	Id. del publicador
publisherType	PublisherType	Valor que indica si se trata de un producto de Microsoft o de terceros. Valores posibles: `Microsoft`: Microsoft publica el producto (producto de primera entidad) `Third Party`: el producto lo publica el proveedor de terceros
publishingStage	PublishingStage	Fase de publicación del producto. Valores posibles: `Preview`: el producto está disponible para el público restringido `Public`: el producto está disponible públicamente en Marketplace
ratingAverage	number (double)	Clasificación media de la oferta
ratingBuckets	RatingBucket[]	Cubos de clasificación, Above1, Above2, Above3, Above4
ratingCount	integer (int32)	Número total de clasificaciones de la oferta
smallIconUri	string	URI al icono de producto pequeño
startingPrice	StartingPrice	Precio comercial del plan más barato del producto
summary	string	Resumen del producto
supportedProducts	string[]	Se asigna a la lista de productos compatibles que proporciona el publicador
uniqueProductId	string	Identificador único del producto.

ProductType

Enumeración

El método de entrega o el modelo de implementación

Valor	Description
AADApps
AppService
AzureApplication
AzureServices
ConsultingServices
Container
ContainerApps
CoreVirtualMachine
CosellOnly
DevService
DynamicsBC
DynamicsCE
DynamicsOps
IotEdgeModules
LogAnalytics
ManagedApplication
ManagedServices
None
Office365
PowerBI
PowerBIVisuals
SaaS
SolutionTemplate
VirtualMachine
VisualStudioExtension

PublisherType

Enumeración

Valor que indica si se trata de un producto de Microsoft o de terceros.

Valor	Description
Microsoft
ThirdParty

PublishingStage

Enumeración

Fase de publicación del producto. Los valores posibles son: Versión preliminar, Público

Valor	Description
Preview
Public

RatingBucket

Enumeración

Cubo de clasificación

Valor	Description
AboveFour
AboveOne
AboveThree
AboveTwo

Sku

Object

El SKU

Nombre	Tipo	Description
generation	string	Generación
identity	string	La identidad
name	string	El nombre

StartingPrice

Object

Precio comercial del plan más barato del producto

Nombre	Tipo	Description
currency	string	Moneda del precio
market	string	Mercado para el que se calcula el precio inicial
meterUnits	string	Unidades del modelo de precios de medidores
minMeterPrice	number	Precio de medidores de inicio (mínimo)
minTermPrice	number	Precio de términos de inicio (mínimo)
termUnits	string	Las unidades del modelo de precios de términos

VmArchitectureType

Enumeración

Tipo de arquitectura de máquina virtual

Valor	Description
Arm64
X64Gen1
X64Gen2

VmSecurityType

Enumeración

Tipo de seguridad de máquina virtual

Valor	Description
Confidential
None
Trusted

Compartir a través de

Public Products - List

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Ejemplos

Product_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureBenefit

Badge

CatalogApiResponse

CspState

ErrorResponse

ErrorResponseDetails

Metadata

PlanSkuRelation

PlanSummary

PlanType

PricingType

ProductSummary

ProductType

PublisherType

PublishingStage

RatingBucket

Sku

StartingPrice

VmArchitectureType

VmSecurityType