Products - List
Obtenez une liste de produits commerciaux publics.
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}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version de l’API REST utilisée pour la requête. |
|
expand
|
query |
string[] |
Développe les entités associées inline. Exemple : 'expand=startingPrice' |
|
|
filter
|
query |
string |
Filtre les résultats, en fonction d’une condition booléenne. Exemple : 'filter=productType eq « VirtualMachine"'. Les champs qui peuvent être filtrés sont les suivants :
|
|
|
hide
|
query |
string[] |
Cette clé est utilisée pour récupérer les produits en préversion et est générée dans l’Espace partenaires pendant le processus de publication de l’offre. |
|
|
language
|
query |
string |
Langue à rechercher, code à deux lettres ISO 639-1, valeurs possibles - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. La valeur par défaut est « en » |
|
|
locations
|
query |
string[] |
Retourner des produits disponibles à l’emplacement sélectionné. Énumération des régions du centre de données Azure. Voir https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Valeur du marché du produit (la réponse inclut uniquement les produits qui peuvent être vendus sur le marché spécifié) Les valeurs possibles sont disponibles à https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Exemple : 'US' |
|
|
orderby
|
query |
string |
Expression de classement pour les résultats à l’aide de la notation OData. Évitez d’utiliser orderby, sauf si cela est essentiel, car cela peut avoir un impact sur la latence de votre requête. Exemple : 'orderby=displayName desc'. Cette API prend uniquement en charge l’ordre par un seul champ. Les champs pouvant être triés sont les suivants :
|
|
|
select
|
query |
string[] |
Sélectionne les propriétés à inclure dans les résultats. Exemple : 'select=displayName' |
|
|
storefront
|
query |
string |
Retournez des produits disponibles dans la Place de marché du portail Azure, AppSource ou le portail de la Place de marché Azure. Les valeurs possibles sont les suivantes :
|
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| X-API-Key | True |
string |
Utiliser la clé API fournie par l’équipe catalogue de la Place de marché comme paramètre fourni dans l’en-tête |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Retourne une liste de produits publics ou en préversion |
|
| Other Status Codes |
Réponses d’erreur :
En-têtes x-ms-error-code: string |
Exemples
List_Products
Exemple de requête
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Exemple de réponse
{
"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..."
}
Définitions
| Nom | Description |
|---|---|
| Attribute |
Représente un attribut de référence SKU, qui se compose d’une clé et d’une valeur. Les attributs peuvent différer entre différents services. |
|
Azure |
Éligibilité à l’avantage d’engagement de consommation Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valeurs possibles :
|
| Badge |
Type de badge |
|
Catalog |
Page de réponse composée d’une liste d’objets Product (qui inclut un sous-ensemble d’attributs de produit) avec un lien de page suivant. En règle générale, les attributs de produit retournés dans la liste sont utilisés pour générer des vignettes de produit pour la galerie de la Place de marché. Remarque :remarque Le nombre maximal d’éléments retournés par page est de 100. Dans des cas spécifiques d’optimisation des performances, contactez l’équipe de la Place de marché Microsoft MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Valeur indiquant si le plan est disponible pour l’achat via le canal CSP. Valeurs possibles :
|
|
Error |
Objet de réponse d’erreur d’API |
|
Error |
Objet détails de réponse d’erreur de l’API |
| Metadata |
Métadonnées de plan/référence SKU développées. |
|
Plan |
Pointage vers un objet de référence SKU associé |
|
Plan |
Retourne un sous-ensemble d’attributs de plan |
|
Plan |
Type de plan de modèle d’application managée ou de solution (applicable uniquement au produit Azure Applications). Valeurs possibles :
|
|
Pricing |
Type de tarification |
|
Product |
Retourne un sous-ensemble d’attributs Product |
|
Product |
Méthode de remise ou modèle de déploiement. Valeurs possibles :
|
|
Publisher |
Valeur indiquant s’il s’agit d’un produit Microsoft ou tiers. Valeurs possibles :
|
|
Publishing |
Étape de publication du produit. Valeurs possibles :
|
|
Rating |
Compartiment d’évaluation |
| Sku |
Référence SKU |
|
Starting |
Prix de vente au détail du plan le moins cher du produit |
|
Vm |
Type d’architecture de machine virtuelle. Applicable uniquement aux produits de machine virtuelle. Valeurs possibles :
|
|
Vm |
Type de sécurité de machine virtuelle. Applicable uniquement aux produits de machine virtuelle. Valeurs possibles :
|
Attribute
Représente un attribut de référence SKU, qui se compose d’une clé et d’une valeur. Les attributs peuvent différer entre différents services.
| Nom | Type | Description |
|---|---|---|
| key |
string |
Clé d’attribut |
| value |
string |
Valeur de l’attribut |
AzureBenefit
Éligibilité à l’avantage d’engagement de consommation Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valeurs possibles :
-
Eligible- Le produit est éligible à l’avantage de l’engagement de consommation Azure -
NotEligible- Le produit n’est pas éligible à l’avantage d’engagement de consommation Azure
| Valeur | Description |
|---|---|
| Eligible | |
| NotEligible |
Badge
Type de badge
| Valeur | Description |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Page de réponse composée d’une liste d’objets Product (qui inclut un sous-ensemble d’attributs de produit) avec un lien de page suivant. En règle générale, les attributs de produit retournés dans la liste sont utilisés pour générer des vignettes de produit pour la galerie de la Place de marché. Remarque :remarque Le nombre maximal d’éléments retournés par page est de 100. Dans des cas spécifiques d’optimisation des performances, contactez l’équipe de la Place de marché Microsoft MKPL_Platform_API_DL@microsoft.com
| Nom | Type | Description |
|---|---|---|
| items |
Liste des éléments retournés |
|
| nextPageLink |
string (uri) |
Lien vers la page suivante où la requête retourne plus d’une seule page de résultats |
CspState
Valeur indiquant si le plan est disponible pour l’achat via le canal CSP. Valeurs possibles :
-
OptIn- Planifier le programme CSP configuré opt-in pour n’importe quel partenaire du programme CSP -
Optout- Planifier la désactivation du programme CSP configuré -
SelectiveOptIn- Planifier le programme CSP configuré opt-in pour des partenaires spécifiques dans l’isv du programme CSP sélectionne. Pour plus d’informations, consultez https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Valeur | Description |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Objet de réponse d’erreur d’API
| Nom | Type | Description |
|---|---|---|
| error |
Détails de la réponse de l’API |
ErrorResponseDetails
Objet détails de réponse d’erreur de l’API
| Nom | Type | Description |
|---|---|---|
| code |
string |
Description du code d’erreur. Par exemple code=InternalError |
| message |
string |
Message d’erreur. Par exemple, message=Erreur de serveur interne |
Metadata
Métadonnées de plan/référence SKU développées.
| Nom | Type | Description |
|---|---|---|
| altStackReference |
string |
Pointant vers un planId qui contient la référence de pile alternative |
| generation |
string |
La génération d’image de machine virtuelle (applicable aux produits de machine virtuelle uniquement).voir https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Pointage vers un planId de plans liés à ce plan |
PlanSkuRelation
Pointage vers un objet de référence SKU associé
| Nom | Type | Description |
|---|---|---|
| relationType |
string |
Relation Type |
| sku |
Référence SKU |
PlanSummary
Retourne un sous-ensemble d’attributs de plan
| Nom | Type | Description |
|---|---|---|
| altArchitectureReference |
string |
Référence d’architecture alternative |
| altStackReference |
string |
Référence de pile alternative |
| categoryIds |
string[] |
Plan CategoryIds |
| cspState |
Valeur indiquant si le plan est disponible pour l’achat via le canal CSP. Valeurs possibles :
|
|
| description |
string |
Description du plan /référence SKU |
| displayName |
string |
Nom complet du plan / référence sku |
| displayRank |
string |
L’ordre dans lequel le plan est affiché dans la table « Plans » (tel que configuré par l’éditeur) |
| hasProtectedArtifacts |
boolean |
Défini sur true si le plan comporte des artefacts qui doivent être masqués pour les utilisateurs non authentifiés |
| hasRI |
boolean |
Indication indiquant si la référence SKU prend en charge les réservations |
| isPrivate |
boolean |
Indication que le plan est accessible uniquement à un public restreint |
| metadata |
Métadonnées de plan/référence SKU développées. |
|
| planId |
string |
ID de plan |
| planType |
Type de plan de modèle d’application managée ou de solution (applicable uniquement au produit Azure Applications). Valeurs possibles :
|
|
| pricingTypes |
Liste des types de tarification pour lesquels ce plan est désigné (Les valeurs possibles sont identiques au niveau du produit) |
|
| skuId |
string |
ID de la référence SKU |
| stackType |
string |
Type de pile : Classic, Gen1, Gen2 |
| summary |
string |
Texte récapitulative du plan |
| uniquePlanId |
string |
ID de plan unique qui est préfixé en combinant uniqueProductId et PlanId sans séparateur entre |
| vmArchitectureType |
Type d’architecture de machine virtuelle. Applicable uniquement aux produits de machine virtuelle. Valeurs possibles :
|
|
| vmSecuritytypes |
Type de sécurité de machine virtuelle. Applicable uniquement aux produits de machine virtuelle. Valeurs possibles :
|
PlanType
Type de plan de modèle d’application managée ou de solution (applicable uniquement au produit Azure Applications). Valeurs possibles :
-
SolutionTemplate- Type de plan de modèle de solution (applicable uniquement aux applications Azure) -
ManagedApplication- Type de plan d’application managée (applicable uniquement aux applications Azure)
PricingType
Type de tarification
| Valeur | Description |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Retourne un sous-ensemble d’attributs Product
| Nom | Type | Description |
|---|---|---|
| applicableProducts |
string[] |
Catégories de produits auxquelles appartient l’offre |
| attributes |
Ensemble d’attributs de produits (varie par type de produit), où chaque attribut est représenté par une paire de clés (nom d’attribut) et valeur(valeur d’attribut) |
|
| azureBenefit |
Éligibilité à l’avantage d’engagement de consommation Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valeurs possibles :
|
|
| badges |
Badge[] |
Les badges de produit suivants sont disponibles : preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Tableau de catégories de produits, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Par exemple , « Productivité » |
| cspLegalTermsUri |
string |
Conditions légales du produit pour le fournisseur de solutions Cloud |
| description |
string |
Texte de description du produit |
| displayName |
string |
Nom d’affichage du produit |
| hasMarketplaceFootprint |
boolean |
Indication si le produit a une représentation sur la Place de marché |
| hasRIPlans |
boolean |
Indication indiquant si le produit a des plans avec des réservations |
| industryIds |
string[] |
Liste des ID du secteur auquel appartient l’élément |
| lastModifiedDateTime |
string (date-time) |
Dernière date de mise à jour du produit |
| linkedAddInsTypes |
object |
Types de compléments liés |
| locations |
string[] |
Liste des emplacements disponibles sur les références SKU |
| longSummary |
string |
Résumé long du produit |
| operatingSystems |
string[] |
Informations du système d’exploitation pour ce produit |
| plans |
Liste des plans disponibles pour ce produit |
|
| popularity |
number (double) |
Popularité du produit |
| pricingTypes |
Liste des types de tarification pour lesquels cette offre est désignée. Valeurs possibles :
|
|
| privacyPolicyUri |
string |
La politique de confidentialité du produit |
| productFamily |
string |
Famille de produits |
| productId |
string |
ID unique du produit |
| productSubType |
string |
Sous-type de produit |
| productType |
Méthode de remise ou modèle de déploiement. Valeurs possibles :
|
|
| publisherDisplayName |
string |
Nom d’affichage de l’éditeur |
| publisherId |
string |
ID du serveur de publication |
| publisherType |
Valeur indiquant s’il s’agit d’un produit Microsoft ou tiers. Valeurs possibles :
|
|
| publishingStage |
Étape de publication du produit. Valeurs possibles :
|
|
| ratingAverage |
number (double) |
Évaluation moyenne de l’offre |
| ratingBuckets |
Compartiments d’évaluation, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Nombre total d’évaluations pour l’offre |
| service |
string |
Nom du service du produit, tel que « Machines virtuelles » |
| serviceFamily |
string |
Famille de services du produit, par exemple « Compute » |
| smallIconUri |
string |
URI vers l’icône petit produit |
| startingPrice |
Prix de vente au détail du plan le moins cher du produit |
|
| summary |
string |
Résumé du produit |
| supportedProducts |
string[] |
Correspond à la liste des produits compatibles que l’éditeur fournit |
| uniqueProductId |
string |
Identificateur de produit unique |
ProductType
Méthode de remise ou modèle de déploiement. Valeurs possibles :
-
SaaS- Le produit est une solution logicielle achetée au paiement à l’utilisation auprès d’un fournisseur de services cloud -
VirtualMachine- Le produit est des instances de service Image avec une tarification basée sur l’utilisation -
AzureApplication- Produits publiés en tant que modèles de solution (ST) ou Azure Managed Apps (AMA) qui déploient des ressources Azure sur le locataire client -
DynamicsCE- Tous les produits Dynamics à l’exception de DynamicsBC et DynamicsOps -
DynamicsBC- Dynamics 365 Business Central (en anglais seulement) -
Container- Le produit est livré en tant que conteneur -
DynamicsOps- Applications Dynamics 365 Operations -
None- Type de produit retourné pour les extensions azure Services, Container Extensions et vm -
IotEdgeModules- La ressource est fournie en tant que module IoT Edge -
ContainerApps- La ressource est fournie en tant qu’application conteneur -
ConsultingServicesServices de conseil (disponible uniquement dans la Place de marché Azure en tant qu’offres de référencement) -
ManagedServices- Le produit est livré en tant que service géré -
PowerBI- Produits Power BI -
CosellOnly- Produits disponibles dans l’étendue du programme Co-Sell uniquement -
PowerBIVisuals- Produits visuels Power BI -
Office365- Produits Office 365 -
DevService- Service de développement -
AADApps- Applications Azure Active Directory -
VisualStudioExtension- Extensions Visual Studio -
SolutionTemplate- Type de plan de modèle de solution (applicable uniquement aux applications Azure) -
ManagedApplication- Type de plan d’application managée (applicable uniquement aux applications Azure) -
MicrosoftProduct- produit Azure tiers
| Valeur | 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
Valeur indiquant s’il s’agit d’un produit Microsoft ou tiers. Valeurs possibles :
-
Microsoft- Le produit est publié par Microsoft (produit tiers) -
Third Party- Le produit est publié par un fournisseur tiers
| Valeur | Description |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Étape de publication du produit. Valeurs possibles :
-
Preview- Le produit est disponible pour un public restreint -
Public- Le produit est disponible publiquement sur la Place de marché
| Valeur | Description |
|---|---|
| Preview | |
| Public |
RatingBucket
Compartiment d’évaluation
| Valeur | Description |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Référence SKU
| Nom | Type | Description |
|---|---|---|
| generation |
string |
Génération |
| identity |
string |
Identité |
| name |
string |
Nom |
StartingPrice
Prix de vente au détail du plan le moins cher du produit
| Nom | Type | Description |
|---|---|---|
| currency |
string |
Devise pour le prix |
| market |
string |
Le marché pour lequel le prix de départ est calculé |
| meterUnits |
string |
Unités de modèle de tarification des compteurs |
| minMeterPrice |
number |
Prix des compteurs de départ (minimal) |
| minTermPrice |
number |
Prix des conditions de départ (minimales) |
| termUnits |
string |
Unités de modèle de tarification des termes |
VmArchitectureType
Type d’architecture de machine virtuelle. Applicable uniquement aux produits de machine virtuelle. Valeurs possibles :
-
Arm64- L’architecture de l’image de machine virtuelle du plan est Arm64 -
X64Gen1- L’architecture de l’image de machine virtuelle du plan est X64 Generation1 -
X64Gen2- L’architecture de l’image de machine virtuelle du plan est X64 Generation2
| Valeur | Description |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Type de sécurité de machine virtuelle. Applicable uniquement aux produits de machine virtuelle. Valeurs possibles :
- Standard - Niveau de sécurité de base pour la machine virtuelle
- Approuvé : protège contre les attaques persistantes et avancées sur des machines virtuelles Gen2 avec des fonctionnalités configurables telles que le démarrage de sécurité et le module de plateforme sécurisée virtuelle (vTPM)
- Confidentiel : en plus du lancement approuvé, les machines virtuelles confidentielles offrent une confidentialité et une intégrité plus élevées garanties avec l’environnement d’exécution approuvé basé sur le matériel
| Valeur | Description |
|---|---|
| None | |
| Trusted | |
| Confidential |