Products - List
Obtén una lista de productos comerciales públicos.
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 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:
|
|
|
hide
|
query |
string[] |
Esta clave se usa para recuperar productos en versión preliminar y se genera en el Centro de partners durante el proceso de publicación de ofertas. |
|
|
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" |
|
|
locations
|
query |
string[] |
Devolver productos disponibles en la ubicación seleccionada. Enumeración de las regiones del centro de datos de Azure. Vea https://azure.microsoft.com/regions/. |
|
|
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:
|
|
|
select
|
query |
string[] |
Selecciona las propiedades que se van a incluir en los resultados. Ejemplo: 'select=displayName' |
|
|
storefront
|
query |
string |
Devuelve productos disponibles en Marketplace de Azure Portal, AppSource o El portal de Azure Marketplace. Los valores posibles son:
|
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 |
Devuelve una lista de productos públicos o en versión preliminar. |
|
| Other Status Codes |
Respuestas de error:
Encabezados x-ms-error-code: string |
Ejemplos
List_Products
Solicitud de ejemplo
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Respuesta de muestra
{
"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..."
}
Definiciones
| Nombre | Description |
|---|---|
| Attribute |
Representa un atributo de SKU, que consta de una clave y un valor. Los atributos pueden diferir en varios servicios. |
|
Azure |
Elegibilidad para la ventaja de compromiso de consumo de Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valores posibles:
|
| Badge |
Tipo de distintivo |
|
Catalog |
Página de respuesta compuesta de una lista de objetos Product (que incluye subconjunto de atributos de producto) junto con un vínculo de página siguiente. Normalmente, los atributos de producto devueltos en la lista se usan para crear iconos de producto para la Galería de Marketplace. Nota:nota El número máximo de elementos devueltos por página es 100. En casos específicos para la optimización del rendimiento, póngase en contacto con el equipo de Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Valor que muestra si el plan está disponible para su compra a través del canal CSP. Valores posibles:
|
|
Error |
El objeto de respuesta de error de API |
|
Error |
Objeto de detalles de respuesta de error de API |
| Metadata |
Metadatos de plan/SKU expandidos. |
|
Plan |
Apuntar a un objeto de SKU relacionado |
|
Plan |
Devuelve un subconjunto de atributos Plan. |
|
Plan |
Tipo de plan de plantilla de aplicación administrada o solución (aplicable solo al producto De aplicaciones de Azure). Valores posibles:
|
|
Pricing |
Tipo de precios |
|
Product |
Devuelve un subconjunto de atributos Product. |
|
Product |
El método de entrega o el modelo de implementación. Valores posibles:
|
|
Publisher |
Valor que indica si se trata de un producto de Microsoft o de terceros. Valores posibles:
|
|
Publishing |
Fase de publicación del producto. Valores posibles:
|
|
Rating |
Cubo de clasificación |
| Sku |
El SKU |
|
Starting |
Precio comercial del plan más barato del producto |
|
Vm |
Tipo de arquitectura de máquina virtual. Aplicable solo a los productos de máquina virtual. Valores posibles:
|
|
Vm |
Tipo de seguridad de máquina virtual. Aplicable solo a los productos de máquina virtual. Valores posibles:
|
Attribute
Representa un atributo de SKU, que consta de una clave y un valor. Los atributos pueden diferir en varios servicios.
| Nombre | Tipo | Description |
|---|---|---|
| key |
string |
Clave de atributo |
| value |
string |
Valor del atributo |
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
| Valor | Description |
|---|---|
| Eligible | |
| NotEligible |
Badge
Tipo de distintivo
| Valor | Description |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Página de respuesta compuesta de una lista de objetos Product (que incluye subconjunto de atributos de producto) junto con un vínculo de página siguiente. Normalmente, los atributos de producto devueltos en la lista se usan para crear iconos de producto para la Galería de Marketplace. Nota:nota El número máximo de elementos devueltos por página es 100. En casos específicos para la optimización del rendimiento, póngase en contacto con el equipo de Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Nombre | Tipo | Description |
|---|---|---|
| items |
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
Valor que muestra si el plan está disponible para su compra a través del canal CSP. Valores posibles:
-
OptIn: planear la participación del programa CSP configurado para cualquier asociado del programa CSP -
Optout: no participar en el programa CSP configurado para planear -
SelectiveOptIn: planea la participación del programa CSP configurado para asociados específicos en el ISV del programa 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
El objeto de respuesta de error de API
| Nombre | Tipo | Description |
|---|---|---|
| error |
Detalles de la respuesta de la API |
ErrorResponseDetails
Objeto de detalles de respuesta de error de API
| 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
Metadatos de plan/SKU expandidos.
| 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 |
Apuntar a un planId de planes relacionados con este plan |
PlanSkuRelation
Apuntar a un objeto de SKU relacionado
| Nombre | Tipo | Description |
|---|---|---|
| relationType |
string |
Tipo de relación |
| sku |
El SKU |
PlanSummary
Devuelve un subconjunto de atributos Plan.
| Nombre | Tipo | Description |
|---|---|---|
| altArchitectureReference |
string |
Referencia de arquitectura alternativa |
| altStackReference |
string |
Referencia de pila alternativa |
| categoryIds |
string[] |
Plan CategoryIds |
| cspState |
Valor que muestra si el plan está disponible para su compra a través del canal CSP. Valores posibles:
|
|
| description |
string |
Descripción de plan/sku |
| displayName |
string |
Nombre para mostrar del plan/sku |
| 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 |
| hasRI |
boolean |
Indicación de si la SKU admite reservas |
| isPrivate |
boolean |
Indicación de que el plan solo es accesible para la audiencia restringida |
| metadata |
Metadatos de plan/SKU expandidos. |
|
| planId |
string |
Identificador 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:
|
|
| pricingTypes |
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 |
Tipo de arquitectura de máquina virtual. Aplicable solo a los productos de máquina virtual. Valores posibles:
|
|
| vmSecuritytypes |
Tipo de seguridad de máquina virtual. Aplicable solo a los productos de máquina virtual. Valores posibles:
|
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
| Valor | Description |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Devuelve un subconjunto de atributos Product.
| Nombre | Tipo | Description |
|---|---|---|
| applicableProducts |
string[] |
Categorías de productos a las que pertenece la oferta |
| attributes |
Conjunto de atributos de productos (varía según el tipo de producto), donde cada atributo se representa mediante un par de claves (nombre de atributo) y value(valor de atributo) |
|
| azureBenefit |
Elegibilidad para la ventaja de compromiso de consumo de Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valores posibles:
|
|
| 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" |
| cspLegalTermsUri |
string |
Los términos legales del producto para el CSP |
| description |
string |
Texto de la descripción del producto |
| displayName |
string |
Nombre para mostrar del producto |
| hasMarketplaceFootprint |
boolean |
Indicación de si el producto tiene una representación en Marketplace |
| hasRIPlans |
boolean |
Indicación de si el producto tiene planes con reservas |
| 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 |
| locations |
string[] |
Lista de ubicaciones disponibles en las SKU |
| longSummary |
string |
Resumen largo del producto |
| operatingSystems |
string[] |
Información del sistema operativo para este producto |
| plans |
Lista de planes disponibles para este producto |
|
| popularity |
number (double) |
Popularidad del producto |
| pricingTypes |
Lista de los tipos de precios para los que se designa esta oferta. Valores posibles:
|
|
| privacyPolicyUri |
string |
La directiva de privacidad del producto |
| productFamily |
string |
Familia de productos |
| productId |
string |
Identificador único del producto |
| productSubType |
string |
Subtipo de producto |
| productType |
El método de entrega o el modelo de implementación. Valores posibles:
|
|
| publisherDisplayName |
string |
Nombre para mostrar del publicador |
| publisherId |
string |
Id. del publicador |
| publisherType |
Valor que indica si se trata de un producto de Microsoft o de terceros. Valores posibles:
|
|
| publishingStage |
Fase de publicación del producto. Valores posibles:
|
|
| ratingAverage |
number (double) |
Clasificación media de la oferta |
| ratingBuckets |
Cubos de clasificación, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Número total de clasificaciones de la oferta |
| service |
string |
Nombre del servicio del producto, como "Virtual Machines" |
| serviceFamily |
string |
La familia de servicios del producto, como "Compute" |
| smallIconUri |
string |
URI al icono de producto pequeño |
| 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
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 -
ConsultingServicesServicios de consultoría (disponible 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 -
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) -
MicrosoftProduct: producto de Azure de primera entidad
| 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
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
| Valor | Description |
|---|---|
| Microsoft | |
| ThirdParty |
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
| Valor | Description |
|---|---|
| Preview | |
| Public |
RatingBucket
Cubo de clasificación
| Valor | Description |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
El SKU
| Nombre | Tipo | Description |
|---|---|---|
| generation |
string |
Generación |
| identity |
string |
La identidad |
| name |
string |
El nombre |
StartingPrice
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
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.
| Valor | Description |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
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.
| Valor | Description |
|---|---|
| None | |
| Trusted | |
| Confidential |