Product List - List By Subscription
Enumera los productos para suscripción.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01
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 identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
|
$expand
|
query |
string |
Expande las entidades relacionadas insertadas |
|
|
$filter
|
query |
string |
Filtra los resultados, en función de una condición booleana. Ejemplo: $filter=productType eq 'VirtualMachine'. Los campos por los que se puede filtrar son:
|
|
|
$order
|
query |
string |
Ordenación de la expresión de los resultados mediante la notación OData. Evite usar orderby a menos que sea esencial, ya que esto puede afectar la latencia de su solicitud. Ejemplo: $orderby=displayName desc. Esta API solo admite pedidos por un solo campo. Los campos por los que se puede ordenar son:
|
|
|
$search
|
query |
string |
Búsqueda opcional por nombre para mostrar, nombre para mostrar del editor o palabras clave. Ejemplo $search=Microsoft |
|
|
$select
|
query |
string |
Selecciona las propiedades que se incluirán en los resultados. Ejemplo: $select=displayName |
|
|
exclude
|
query |
boolean |
Si excluir las ofertas públicas y los planes públicos de la respuesta. El valor predeterminado es false, lo que significa que las ofertas públicas y los planes públicos se incluyen en la respuesta. Si se establece en true, solo se devolverán los planes privados. |
|
|
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,id,zh-hans,zh-hant'. El valor predeterminado es "en" |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| user_impersonation | suplantar la cuenta de usuario |
Ejemplos
ProductList_ListBySubscription
Solicitud de ejemplo
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
Respuesta de muestra
{
"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..."
}
Definiciones
| Nombre | Description |
|---|---|
| Attribute |
Representa un atributo SKU, que consta de una clave y un valor. Los atributos pueden diferir entre varios servicios. |
|
Discovery |
Detalles del error devueltos en DiscoveryErrorPayload |
|
Discovery |
Carga de error devuelta por las API de descubrimiento de Marketplace |
|
Plan |
Metadatos adicionales |
|
Plan |
Devuelve un subconjunto de atributos Plan |
|
Product |
Devuelve un subconjunto de atributos Product |
|
Product |
La respuesta personalizada de una operación de lista. |
Attribute
Representa un atributo SKU, que consta de una clave y un valor. Los atributos pueden diferir entre varios servicios.
| Nombre | Tipo | Description |
|---|---|---|
| key |
string |
La clave de atributo |
| value |
string |
El valor del atributo |
DiscoveryErrorDetails
Detalles del error devueltos en DiscoveryErrorPayload
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
El código de error HTTP |
| message |
string |
Mensaje de error |
DiscoveryErrorPayload
Carga de error devuelta por las API de descubrimiento de Marketplace
| Nombre | Tipo | Description |
|---|---|---|
| error |
El objeto de detalles del error |
PlanMetadata
Metadatos adicionales
| Nombre | Tipo | Description |
|---|---|---|
| altStackReference |
string |
Apuntar a un planId que contiene la referencia de pila alternativa |
| generation |
string |
La generación de imágenes de máquina virtual (aplicable solo a productos de máquinas virtuales) |
PlanSummary
Devuelve un subconjunto de atributos Plan
| Nombre | Tipo | Description |
|---|---|---|
| altArchitectureReference |
string |
La referencia de arquitectura alternativa |
| altStackReference |
string |
Referencia de pila alternativa |
| categoryIds |
string[] |
Plan CategoryIds |
| cspState |
string |
Controla la disponibilidad del plan y el acceso de los asociados dentro del programa Proveedor de soluciones en la nube (CSP) de Microsoft.
|
| description |
string |
Descripción del plan / SKU |
| displayName |
string |
Nombre para mostrar del plan / SKU |
| displayRank |
string |
El orden en que se muestra el plan en la tabla "Planes" |
| hasProtectedArtifacts |
boolean |
Se establece en true si el plan tiene artefactos que se van a ocultar para los usuarios no autenticados |
| hasRi |
boolean |
Indicación de si el SKU admite reservas |
| isPrivate |
boolean |
Indicación de que el plan es accesible solo para una audiencia restringida |
| metadata |
Metadatos ampliados del plan/SKU. |
|
| planId |
string |
Identificador del plan |
| planType |
string |
Especifica el modelo de implementación principal y la arquitectura de hospedaje para el producto de Marketplace. Los valores admitidos actualmente son:
|
| pricingTypes |
string[] |
Indica los modelos de facturación y las estructuras de costes disponibles para el plan.
|
| skuId |
string |
El ID de SKU |
| stackType |
string |
Tipo de pila: Clásica, Gen1, Gen2 |
| summary |
string |
El texto del resumen del plan |
| uniquePlanId |
string |
Identificador único del plan que se antepone mediante la combinación de uniqueProductId y PlanId sin ningún separador intermedio |
| vmArchitectureType |
string |
Especifica la arquitectura y la generación del procesador de la máquina virtual. Se aplica exclusivamente a los tipos de productos de máquinas virtuales.
|
| vmSecuritytypes |
string[] |
Define el nivel de mejora de seguridad para las implementaciones de máquinas virtuales. Se aplica exclusivamente a los tipos de productos de máquinas virtuales.
|
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 |
|
| azureBenefit |
string |
Indica si las compras de productos cuentan para las ventajas del compromiso de consumo de Azure para los clientes empresariales.
|
| badges |
string[] |
Muestra las insignias de certificación y calificación obtenidas por el producto para la visibilidad del mercado.
|
| categoryIds |
string[] |
Variedad de categorías de productos |
| cspLegalTermsUri |
string |
Los términos legales del producto para el CSP |
| description |
string |
El texto de la descripción del producto |
| displayName |
string |
Nombre para mostrar del producto |
| hasMarketplaceFootprint |
boolean |
Indicación de si el producto tiene representación en el mercado |
| hasRiPlans |
boolean |
Indicación de si el producto tiene planes con reservas |
| industryIds |
string[] |
Lista de ID de industria a los que pertenece el artículo |
| lastModifiedDateTime |
string |
Fecha de última actualización del producto |
| locations |
string[] |
Lista de ubicaciones que están disponibles en los SKU |
| longSummary |
string |
Resumen largo del producto |
| operatingSystems |
string[] |
Información del sistema operativo para este producto |
| plans |
Conjunto completo de atributos de plan/SKU |
|
| popularity |
number (double) |
Popularidad del producto |
| pricingTypes |
string[] |
Indica los modelos de facturación y las estructuras de costes disponibles para el plan.
|
| privacyPolicyUri |
string |
La política de privacidad del producto |
| productFamily |
string |
Familia de productos |
| productId |
string |
El identificador único del producto |
| productSubType |
string |
Subtipo de producto |
| productType |
string |
Especifica el modelo de implementación principal y la arquitectura de hospedaje para el producto de Marketplace almacenado en el catálogo de Marketplace.
|
| publisherDisplayName |
string |
Nombre para mostrar del publicador |
| publisherId |
string |
ID del editor |
| publisherType |
string |
Identifica la relación del editor con Microsoft para la clasificación de soporte técnico y asociación.
|
| publishingStage |
string |
Indica el estado de disponibilidad del producto y el nivel de acceso del cliente en Azure Marketplace.
|
| ratingAverage |
number (double) |
Valoración media de la oferta |
| ratingBuckets |
string[] |
Clasifica los productos por umbrales de calificación de clientes para el filtrado y la detección de marketplaces.
|
| ratingCount |
integer (int32) |
Número total de valoraciones de la oferta |
| service |
string |
El nombre del servicio del producto, como "Máquinas virtuales" |
| serviceFamily |
string |
La familia de servicios del producto, como "Compute" |
| smallIconUri |
string |
URI al icono de producto pequeño |
| summary |
string |
Resumen del producto |
| supportedProducts |
string[] |
Se asigna a la lista de productos compatibles |
| uniqueProductId |
string |
Identificador de producto único |
ProductSummaryListResult
La respuesta personalizada de una operación de lista.
| Nombre | Tipo | Description |
|---|---|---|
| nextLink |
string |
El enlace a la siguiente página de artículos |
| value |
Los elementos de esta página |