API d’ingestion de produit pour la place de marché commerciale

L’API d’ingestion de produit est une API modernisée qui unifie toutes les API de soumission existantes sur tous les produits de la Place de marché commerciale. L’API vous permet de créer, publier et gérer des ressources associées aux produits et plans au sein de votre compte Espace partenaires. Il utilise un modèle déclaratif pour envoyer des demandes, dans lesquelles l’état souhaité est indiqué par opposition à la spécification des étapes individuelles pour atteindre l’état souhaité.

Cet article fournit des conseils sur la prise en main des API pour n’importe quel type d’offre de place de marché commerciale. L’API d’ingestion de produit est actuellement prise en charge pour les types d’offres SaaS, machines virtuelles, offres privées et offres conteneur et est en préversion. Pour obtenir des conseils spécifiques à votre offre, passez en revue les conseils d’API par type d’offre.

Important

Azure Active Directory (Azure AD) Graph est déconseillé depuis le 30 juin 2023. À l’avenir, nous n’effectuons aucun investissement supplémentaire dans Azure AD Graph. Les API Graph Azure AD n’ont pas de contrat SLA ou de maintenance au-delà des correctifs liés à la sécurité. Nous limiterons les investissements dans de nouvelles fonctions et fonctionnalités à Microsoft Graph.

Nous allons mettre hors service Azure AD Graph en étapes incrémentielles afin que vous ayez suffisamment de temps pour migrer vos applications vers les API Microsoft Graph. À une date ultérieure que nous annoncerons, nous bloquerons la création de toutes les nouvelles applications à l’aide d’Azure AD Graph.

Pour plus d’informations, consultez Important : Suppression du module Azure AD Graph et Dépréciation du module PowerShell.

Mise en route

L’API d’ingestion de produit est accessible à l’aide de l’API MSGraph sous le nom de charge de travail « product-ingestion ». L'URL de base est https://graph.microsoft.com/rp/product-ingestion.

Pour utiliser l’API d’ingestion de produit, vous devez d’abord acquérir les éléments suivants :

• ID Microsoft Entra et vérifiez que vous disposez des autorisations d’administrateur général pour l’annuaire
• Une application Microsoft Entra
• Jeton d’accès Microsoft Entra

Étape 1 : Remplir les conditions préalables

Avant de commencer à écrire du code pour appeler l’API d’ingestion de produit, vérifiez que vous avez rempli les conditions préalables suivantes.

• Vous (ou votre organisation) devez disposer d’un annuaire Microsoft Entra et vous devez disposer de l’autorisation d’administrateur général pour l’annuaire. Si vous utilisez déjà Microsoft 365 ou d’autres services professionnels de Microsoft, vous disposez déjà d’un annuaire Microsoft Entra. Sinon, vous pouvez créer un NOUVEL ID Microsoft Entra dans l’Espace partenaires sans frais supplémentaires.
• Vous devez associer une application Microsoft Entra à votre compte Espace partenaires et obtenir votre ID de locataire, votre ID client et votre clé. Vous en avez besoin pour obtenir le jeton d’accès Microsoft Entra que vous utiliserez dans les appels à l’API de soumission du Microsoft Store.

Associer une application Microsoft Entra à votre compte Espace partenaires

Pour utiliser l’API d’ingestion de produit, vous devez associer une application Microsoft Entra à votre compte Espace partenaires, récupérer l’ID client et l’ID client de l’application et générer une clé. L’application Microsoft Entra représente l’application ou le service à partir duquel vous souhaitez appeler l’API d’ingestion de produit. Vous avez besoin de l’ID de locataire, de l’ID client et de la clé pour obtenir un jeton d’accès Microsoft Entra à transmettre à l’API.

Remarque

Vous ne devez effectuer cette tâche qu’une seule fois. Une fois que vous avez l’ID de locataire, l’ID client et la clé, vous pouvez les réutiliser chaque fois que vous devez créer un jeton d’accès Microsoft Entra.

1. Dans l’Espace partenaires, associez le compte espace partenaires de votre organisation à l’annuaire Microsoft Entra de votre organisation.
2. Dans la page Utilisateurs de la section Paramètres du compte de l’Espace partenaires, ajoutez l’application Microsoft Entra qui représente l’application ou le service que vous utiliserez pour accéder aux soumissions de votre compte Espace partenaires. Veillez à attribuer à cette application le rôle Gestionnaire. Si l’application n’existe pas encore dans votre annuaire Microsoft Entra, créez une application Microsoft Entra dans l’Espace partenaires. L’Espace partenaires crée deux types d’entrées pour l’application comme principal de service et l’autre comme type d’application Microsoft Entra.
3. Revenez à la page Utilisateurs, sélectionnez le nom de votre application Microsoft Entra pour accéder aux paramètres de l’application, puis copiez l’ID de locataire et les valeurs d’ID client.
4. Sélectionnez Ajouter une nouvelle clé. Sur l’écran suivant, copiez la valeur de la Clé. Vous ne pourrez plus accéder à cette information une fois que vous aurez quitté cette page. Pour plus d’informations, consultez Gérer les clés d’une application Microsoft Entra.

Étape 2 : Obtenir un jeton d’accès Microsoft Entra

Pour appeler l’une des méthodes de l’API d’ingestion de produit, vous devez d’abord obtenir un jeton d’accès Microsoft Entra pour passer à l’en-tête d’autorisation de chaque méthode de l’API. Un jeton d’accès expire 60 minutes après son émission. Vous pouvez ensuite l’actualiser pour pouvoir l’utiliser dans les prochains appels à l’API.

Pour obtenir le jeton d’accès, suivez les instructions de la section Appels de service à service à l’aide des informations d’identification du client pour envoyer une requête HTTP POST au point de terminaison https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token. Voici un exemple de requête :

POST https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded;

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&scope=https://graph.microsoft.com/.default

Pour la valeur tenant_id dans le POST URI et les paramètres client_id et client_secret, spécifiez l’ID du locataire, l’ID de client et la clé de votre application que vous avez récupérée dans l’Espace partenaires à la section précédente. Pour l’étendue du paramètre, vous devez spécifier https://graph.microsoft.com/.default.

Concepts

Avant de commencer, vous devez comprendre certains concepts de base.

Ressources

L’API est structurée autour des types de ressources, où chaque type est décrit à l’aide d’une définition de schéma dédiée telle qu’elle est référencée par la propriété « $schema ». Le schéma se compose des propriétés de configuration de cette ressource. Les ressources sont fondamentales dans la création et la mise à jour de la configuration de différents aspects d’un produit donné. Pour obtenir la liste complète des types de ressources et de leurs schémas, consultez la référence de l’API ressource.

ID durable

Un ID durable est un identificateur global généré par le système utilisé pour identifier de manière unique n’importe quelle ressource. Chaque ressource a une propriété « ID » associée, qui, lorsqu’elle est combinée avec le nom du type de ressource, constitue l’ID durable d’une ressource. L’ID durable est utilisé lors du référencement des ressources pour récupérer ou modifier.

Format :

\<resource-type>/\<id>

Exemple :

            { 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
                "id": "product/12345678-abcd-efgh-1234-12345678901", // durable ID
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo"
                },
                "type": "softwareAsAService", // Product types that can be specified include azureContainer, azureVirtualMachine, softwareAsAService
                "alias": "Contoso Image Resizing Service"
            }

ID externe

Un ID externe est un autre identificateur unique qui peut être utilisé pour référencer des produits ou des plans spécifiques. Il s’agit d’une autre façon de référencer ces ressources au lieu d’utiliser l’ID durable. L’ID externe d’un produit se traduit par son « offerID » et l’ID externe d’un plan se traduit par son « planID », comme défini lors de la création sous la propriété « identity ».

Exemple :

            { 
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
                "id": "plan/12345678-abcd-efgh-1234-12345678901/4e0bfefa-b993-4b79-a426-871c3bf236a5",
                "identity": {
                  "externalID": "gold-annual"
                },
                "azureRegions": [
                    "azureGlobal"
                  ],
                "alias": "Gold - Annual payment",
                "product": "product/12345678-abcd-efgh-1234-12345678901",
            }

Méthodes API

Il existe quatre API de gestion qui peuvent être utilisées pour effectuer différentes actions, telles que l’interrogation des ressources existantes, la création de mises à jour de configuration et la vérification de l’état d’une requête.

Remarque

Toutes les requêtes vous obligent à définir la version de schéma ($version paramètre de requête) souhaitée dans le cadre de la réponse.

Type d’API	Description	Méthode et chemin HTTP
Requête	Récupère les ressources existantes par : -Méthode 1 : type de ressource « resource-tree » -Méthode 2 : durable-id -Méthode 3 : paramètres de chaîne de requête	-Méthode 1 : GET resource-tree/<product-durableID> -Méthode 2 : GET <resource-durableID> -Méthode 3 : GET <resourceType>?<query parameters>
Configurer l’envoi	Envoie des demandes pour créer ou mettre à jour une ou plusieurs ressources. Une fois le traitement réussi, un jobID est retourné, qui peut être utilisé pour récupérer l’état de la demande. Ce type d’API peut être utilisé pour mettre à jour l’état brouillon et publier des modifications, synchroniser des audiences privées et modifier l’état du cycle de vie des ressources.	POST configure
Configurer l’état	Récupère l’état d’une demande en attente via l’ID de travail.	GET configure/<jobID>/status
Configurer les détails de l’état	Récupère un résumé détaillé d’une requête terminée, y compris les ressources mises à jour, via l’ID de travail.	GET configure/<jobID>
Annuler la configuration	Annule le travail Configure spécifié.	POST configure/<jobID>/cancel

un workflow classique

Pour mettre à jour une ressource existante, un flux de travail classique doit être :

1. Récupérer une configuration de ressource existante (type d’API : Interroger via l’arborescence des ressources)*
2. Effectuez les mises à jour nécessaires, puis envoyez une demande de configuration (type d’API : Configurer l’envoi)
3. Vérifiez l’état de la demande (type d’API : Configurer l’état et configurer les détails de l’état)

* Ce même flux de travail peut être appliqué lors de la création de ressources, mais au lieu de récupérer des ressources (étape 1), utilisez la table de référence de l’API de ressource pour vous assurer que vous utilisez le schéma actuel pour le type de ressource que vous créez.

Pour résumer, cette image montre le modèle d’appel classique utilisé pour envoyer une demande de configuration, que vous créiez ou modifiez une ressource existante.

Remarque

Veillez à passer en revue les conditions préalables supplémentaires spécifiques au type d’offre que vous gérez en faisant référence aux instructions de l’API par section de type d’offre.

Récupérer les configurations de ressources existantes

Avant de mettre à jour les ressources existantes, il est important de les récupérer pour vous assurer que vous disposez de leur dernière configuration. Il existe plusieurs façons de récupérer des ressources via un appel GET. Consultez la méthode 1, détaillée ci-dessous, pour récupérer toutes les ressources au sein d’un produit spécifique dans un seul appel d’API.

Méthode 1 : arborescence des ressources

Schema: https://``schema.mp.microsoft.com``/schema/resource-tree/2022-03-01-preview2

GET resource-tree/<product-durableID>?$version=<schema-version>

Vous pouvez récupérer toutes les configurations de ressources au sein d’un produit spécifique en utilisant le type de ressource « resource-tree », ainsi que l’ID durable du produit.

La dernière version de schéma disponible peut être différente pour chaque ressource. Lors de l’exécution d’une requête d’arborescence de ressources, la version de schéma spécifiée détermine quelle version est retournée pour chaque ressource du produit. La version spécifiée sert de limite de version « max » dans laquelle elle retourne la dernière version de schéma disponible pour toutes les ressources égales ou inférieures. Par exemple, si la dernière version de liste de plans disponible est « 2022-03-01-preview3 », la réponse surface cette version si vous deviez spécifier « 2022-03-01-preview5 » dans la requête GET de l’arborescence des ressources. Toutefois, si vous demandez « 2022-03-01-preview2 » comme version de l’arborescence des ressources, cela renvoie la ressource de liste de plan « 2022-03-01-preview2 », même si la dernière version disponible est « 2022-03-01-preview3 ». Il est recommandé d’utiliser la dernière version disponible de chaque ressource pour vous assurer que vous utilisez le schéma mis à jour avec les nouvelles fonctionnalités prises en charge.

Remarque

Si vous ne connaissez pas l’ID durable du produit, vous pouvez utiliser l’ID externe du produit pour récupérer la ressource de produit en exécutant GET product?externalID=<product-externalID>&$version=<product-schema-version>. Cette demande utilise un paramètre de chaîne de requête, qui est détaillé dans la méthode 3 ci-dessous. La réponse inclut l’ID durable du produit, que vous pouvez utiliser pour les demandes futures.

Par défaut, lorsque vous exécutez un appel GET à l’aide de l'« arborescence des ressources », vous récupérez la version brouillon de vos ressources. Toutefois, en passant le paramètre de requête « targetType », vous pouvez spécifier la cible souhaitée pour récupérer les données « preview » ou « live ». Dans l’exemple suivant, l’appel GET retourne la configuration de l’environnement d’aperçu pour toutes les ressources sous le produit « 12345678-abcd-efgh-1234-12345678901 ».

Exemple d’appel GET :

GET https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType="preview"&$version=2022-03-01-preview5

Exemple de réponse :

        {
          "$schema": "https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2",
          "root": "product/12345678-abcd-efgh-1234-12345678901",
          "target": {
            "targetType": "preview"
          },
          "resources": [
          { 
            "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
            "id": "product/12345678-abcd-efgh-1234-12345678901",
            "identity": {
              "externalID": "ds-contoso-image-resize-demo"
            },
            "type": "softwareAsAService",
            "alias": "Contoso Image Resizing Service"
          },
          { 
            "$schema": "https://schema.mp.microsoft.com/schema/property/2022-03-01-preview3",
            "id": "property/12345678-abcd-efgh-1234-12345678901/public/main",
            "product": "product/12345678-abcd-efgh-1234-12345678901",
            "kind": "azureSaaS",
            "termsConditions": "false",
            "categories": {
          "developer-tools-saas": [
            "devService"
          ]
            }
          },
          {
            "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
            "id": "plan/12345678-abcd-efgh-1234-12345678901/4e0bfefa-b993-4b79-a426-871c3bf236a5",
            "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468",
          ...
          }, 
              // The response would include all existing resources within this product.
          {
              ...
          }]
        }

Méthode 2 : ID durable

GET <resource-durableID>?$version=<schema-version>

Récupérez une ressource spécifique à l’aide de son ID durable. Une fois qu’une ressource est créée, l’ID durable reste toujours le même et peut être utilisé pour récupérer les dernières modifications brouillons de cette ressource en appelant la méthode GET. Par exemple, la requête suivante retourne la configuration brouillon de ce produit spécifique à l’aide de la version de schéma « 2022-03-01-preview3 ».

GET product/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview3

Important

Cette méthode est utilisée uniquement pour récupérer la configuration brouillon. Si vous souhaitez récupérer des données en préversion ou en direct, utilisez la méthode « resource-tree », comme indiqué ci-dessus.

Pour trouver l’ID durable de vos ressources, vous pouvez :

• Utilisez la méthode « resource-tree » pour extraire toutes les ressources du produit, ainsi que chacun de leurs ID durables respectifs, ou
• Récupérez les détails d’une demande de configuration de ressource terminée, qui inclut les ID durables de toutes les ressources créées ou mises à jour dans le cadre de la requête.

N’oubliez pas que la propriété « ID » est l’ID durable de la ressource respective.

Méthode 3 : Paramètres de chaîne de requête

GET <resourceType>?<query parameters>&$version=<schema-version>

Cette méthode permet d’interroger certains types de ressources associés à un compte spécifique. Par exemple, vous pouvez récupérer tous vos produits d’un type de produit spécifique avec un seul appel GET. Les paramètres de chaîne de requête sont utilisés pour interroger les détails relatifs à vos produits, plans ou soumissions.

Ce tableau présente les paramètres de requête pris en charge pour chacun des types de ressources pris en charge. Tous les types de ressources ne prennent pas en charge chacun des paramètres de requête. Référencez ce tableau pour obtenir la liste complète des chaînes de requête actuellement prises en charge.

Type de ressource	Paramètres	Exemples de chaîne de requête
plan	produit* externalID $maxpagesize continuationToken$version*	GET plan?product=<product-durableID>&$version=<schema-version> GET plan?product=<product-durableID>&externalID=<plan-externalID>&$version=<schema-version> GET plan?product=<product-durableID>&$maxpagesize=<#>&$version=<schema-version> GET plan?product=<product-durableID>&continuationToken=<token>&$version=<schema-version>
product	externalID type $maxpagesize continuationToken$version*	GET product?externalID=<product-externalID>&$version=<schema-version> GET product?type=<product-type>&$version=<schema-version> GET product?$maxpagesize=<#>&$version=<schema-version> GET product?continuationToken=<token>&$version=<schema-version>
soumission	targetType $maxpagesize continuationToken$version*	GET submission/<product-durableID>?targetType=<environment>&$version=<schema-version> GET submission/<product-id>?$maxpagesize=<#>&continuationToken=<token>&$version=<schema-version>
arborescence des ressources	targetType$version*	GET resource-tree/<product-durableID>?targetType=<environment>&$version=<schema-version>

* Les paramètres produit et $version sont toujours requis.

Fonctionnalités de chacun des paramètres de requête pris en charge :

• produit : lors du passage du paramètre « product » dans le contexte du type de ressource « plan », il retourne tous les plans au sein de ce produit spécifique.
• externalID : lors du passage du paramètre « externalID » dans le contexte d’un produit ou d’un plan, il retourne la configuration de ce produit ou plan respectif. Contrairement à la méthode « resource-tree », ce paramètre de chaîne de requête retourne uniquement les détails de cette ressource, et non toutes les ressources qu’elle contient.
• type : lors du passage du paramètre « type » dans le contexte du type de ressource « product », il retourne tous les produits de ce type associés à votre compte. Par exemple, en spécifiant « type=softwareAsAService », tous vos produits SaaS sont retournés.
• targetType : retourne les données d’un environnement spécifique dans le contexte du type de ressource utilisé. Les valeurs « targetType » prises en charge sont « brouillon », « préversion » ou « live ».
• $maxpagesize : en spécifiant la taille de page maximale, sous la forme d’un nombre entier positif, ce paramètre est utilisé pour limiter les résultats de votre recherche lors de l’interrogation de vos soumissions précédentes.
• continuationToken : ce paramètre peut être utilisé avec le paramètre « $maxpagesize » pour interroger un autre ensemble de résultats disponible dans votre recherche. La valeur « continuationToken » est fournie dans la réponse de la page précédente.
• $version : il s’agit d’un paramètre obligatoire pour tous les appels, il spécifie la version de schéma souhaitée pour la réponse de la demande que vous avez effectuée. La dernière version de schéma disponible peut être différente pour chaque ressource et la version spécifiée sert de limite de version « max ». Le système retourne la version exacte du schéma si disponible ou la version la plus proche antérieure à la version demandée. Cela peut vous aider à gérer votre code, même s’il existe des modifications de schéma plus récentes, mais pour utiliser les fonctionnalités les plus récentes, il est recommandé d’utiliser la dernière version disponible de chaque schéma.

Interrogation de vos soumissions

Vous pouvez récupérer vos soumissions de produits existantes en effectuant GET submission/<product-durableID>. Par défaut, vous récupérez toutes vos soumissions actives, y compris la référence préliminaire, mais vous pouvez également interroger un environnement spécifique à l’aide du paramètre de requête « targetType » : (GET submission/<product-durableID>?targetType=<environment>&$version=<version>).

Important

Une fois qu’une soumission « Preview » est envoyée à « Live », elle remplace toute soumission « Live » précédente. Lorsque cela se produit, les données représentent désormais à la fois les environnements « Préversion » et « Live » jusqu’à ce qu’une nouvelle soumission soit publiée sur « Aperçu ».

Exemple de requête :

GET https://graph.microsoft.com/rp/product-ingestion/submission/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview2

Exemple de réponse :

Cet exemple montre une demande GET pour les soumissions actives associées à l’ID de produit « 12345678-abcd-efgh-1234-12345678901 ». La soumission active « Live » (soumission/12345678-abcd-efgh-1234-12345678901/1152921515689847470) a été publiée en préversion, puis plus tard pour vivre. Lorsque cette soumission a été envoyée en direct le 25 janvier 2022, elle a représenté la préversion et la version en direct jusqu’à ce qu’une nouvelle soumission de préversion (soumission/12345678-abcd-efgh-1234-12345678901/1152921515689848683) ait été créée le 4 février 2022.

            {
              "value": [
                {
                  "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                  "id": "submission/12345678-abcd-efgh-1234-12345688901/0",
                  "product": "product/12345678-abcd-efgh-1234-12345678901",
                  "target": {
                    "targetType": "draft"
                  }
                },
                {
                  "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                  "id": "submission/12345678-abcd-efgh-1234-12345678901/1152921515689847470",
                  "product": "product/12345678-abcd-efgh-1234-12345678901",
                  "target": {
                    "targetType": "live"
                  },
                  "status": "completed",
                  "result": "succeeded",
                  "created": "2022-01-25T07:13:06.4408032Z"
                },
                {
                  "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                  "id": "submission/12345678-abcd-efgh-1234-12345678901/1152921515689848683",
                  "product": "product/12345678-abcd-efgh-1234-12345678901",
                  "target": {
                    "targetType": "preview"
                  },
                  "status": "completed",
                  "result": "succeeded",
                  "created": "2022-02-04T20:07:22.4220588Z"
                }
              ]
            }

Créer des produits et des ressources

Vous pouvez créer de nouvelles ressources, y compris de nouveaux produits, dans le cadre d’une demande de configuration unique. À l’aide de la table de référence de l’API de ressource , vous pouvez récupérer le schéma du type de ressource que vous souhaitez créer. Cela garantit que vous utilisez le schéma le plus récent et que vous configurez donc toutes les propriétés nécessaires pour créer la ressource.

Si vous créez un produit, les exigences varient selon le type de produit. Par conséquent, vous devez fournir différentes ressources. Vous pouvez référencer la documentation correspondante de la Place de marché commerciale pour le type de produit respectif pour vous assurer que vous configurez les exigences de base dans votre demande. Vous pouvez également effectuer une demande de configuration en utilisant uniquement la ressource de produit. Après avoir créé le produit, appelez l’API configurer les détails de l’état pour récupérer la ressource de produit créée et trouver son ID durable pour appeler l’API de requête de l’arborescence de ressources. La réponse retourne les ressources prises en charge applicables pour le type de produit que vous avez créé.

De même, pour créer une ressource au sein d’un produit existant, vous devez également récupérer le dernier schéma de ce type de ressource spécifique. Vérifiez que vous fournissez les ressources dépendantes dans le cadre de la demande de configuration en examinant les dépendances des ressources.

Après avoir construit vos ressources à l’aide des schémas, découvrez comment effectuer une demande de configuration.

Modifier les produits et ressources existants

Vous pouvez envoyer des mises à jour à l’aide de la charge utile de configuration. Cette charge utile se compose d’un ou plusieurs types de ressources et de la propriété « $schema » indique le type de ressource référencé.

Conseil

Nous vous recommandons de récupérer d’abord des ressources existantes avant de publier des mises à jour pour vous assurer que vous tirez parti de la dernière configuration.

Après avoir modifié vos ressources, découvrez comment effectuer une demande de configuration.

Demandes de configuration

Vous pouvez modifier et publier dans la même charge utile. Pour envoyer une demande de configuration, utilisez la méthode HTTP POST de l’API de configuration. La charge utile de configuration se compose d’un tableau de ressources qui indiquent les modifications souhaitées. Toutes les modifications affectent uniquement la version brouillon jusqu’à ce que vous envoyiez explicitement une ressource de soumission pour publier vos modifications provisoires. Lors de la publication en préversion ou en direct, incluez la ressource de soumission et spécifiez l’environnement cible. Avant de soumettre une demande, vous devez savoir comment référencer des ressources et comprendre leurs dépendances.

Schema:<https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2>

Lors de l’envoi de votre demande de configuration, vous récupérez un objet d’état de configuration avec l’ID de travail que vous pouvez utiliser pour suivre la progression et les résultats de votre demande.

Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>

Références et dépendances de ressources

Références

Pour référencer une ressource existante dans une demande de configuration, fournissez le type « $schema » de la ressource, ainsi que l’ID durable de la ressource. Dans le cas de produits et de plans, vous pouvez également référencer ces ressources via leur ID externe.

L’ID durable se trouve dans la propriété « ID », par exemple s’il s’agit de la ressource de produit que nous voulons référencer dans une autre ressource :

            { 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
                "id": "product/12345678-abcd-efgh-1234-12345678901",
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo"
                },
                "type": "softwareAsAService",
                "alias": "Contoso Image Resizing Service"
            }

L’ID durable serait « product/071b135e-9faf-4ff7-b113-a3f25bb0f468 ».

L’ID durable peut ensuite être utilisé dans l’exemple de ressource de référencement ci-dessous en le définissant dans la propriété de schéma de ressource « product » comme suit :

            {
                "$schema": "https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5", 
                "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468", // product durable ID
                  ...
              }

L’ID externe des ressources de produit et de plan est défini dans la propriété « identity ».

            {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2", 
                "alias": "Gold - Annual payment",
                "identity": {"externalID": "gold-annual"},
                "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468",
                  ...
              }

L’ID externe du plan « gold-annual » peut ensuite être référencé par d’autres ressources suivantes au format suivant :

              {
                "$schema": "https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5", 
                "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468"}
                "plan": {"externalID": "gold-annual"}
                  ...
              }

Exemple de requête :

Dans cet exemple, la charge utile de configuration est utilisée pour créer un produit SaaS avec un ID externe de « ds-contoso-image-resize-demo ». Lors de la création de ce produit, vous pouvez référencer ultérieurement ce produit à l’aide de son ID durable ou de son ID externe.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
                { 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo"
                },
                "type": "softwareAsAService",
                "alias": " Contoso Image Resizing Service"
              }
              ]
            }

Exemple de réponse :

            {
  "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
  "jobID": "071b135e-9faf-4ff7-b113-a3f25bb0f468",
  "jobStatus": "running",
  "jobResult": "pending",
  "jobStart": "2022-08-18T16:35:56.5917185Z",
  "jobEnd": "0001-01-01T00:00:00",
  "errors": []
}

Vous pouvez ensuite utiliser l’ID de travail via l’API Configurer l’état pour vérifier l’état de votre demande.

Les dépendances

Certaines ressources ont des dépendances sur la création d’une autre ressource comme condition préalable. Dans ce cas, nous utilisons la propriété « resourceName » dans la même charge utile pour indiquer la dépendance de la ressource de produit dans la ressource de plan, car nous créons les deux dans la même requête.

Le nom de ressource est utilisé uniquement pour identifier chaque ressource dans le cadre de la demande de configuration que vous effectuez. La valeur ne fait pas partie des données des ressources, elle n’est pas stockée ni exposée aux clients. En outre, s’il existe des erreurs dans le cadre de la demande de configuration, le nom de ressource est utilisé pour appeler la ressource à laquelle appartient l’erreur.

Exemple de requête :

Dans cet exemple, le produit doit être créé avant le plan et, par conséquent, la propriété « resourceName » est utilisée. Le produit créé, « myNewProduct », sera la valeur utilisée pour « resourceName » et référencée dans la ressource de plan dépendant.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
              {
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3", 
                "resourceName": "myNewProduct", 
                "alias": "Contoso Image Resizing Service",
                ...
              }, 
              {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2", 
                "alias": " Gold - Annual payment",
                "product": {"resourceName": "myNewProduct"}
                  ...
              }, 
              }]
            }

Ressource de soumission

Si vous publiez en « préversion » ou « en direct », incluez la ressource de soumission dans votre demande, qui contient :

• Propriété « product », indiquant que le produit est mis à jour comme référencé par son ID durable ou son ID externe
• Propriété « targetType », indiquant l’environnement cible

Lors de la publication en direct, l'« ID » de la soumission d’aperçu que vous recherchez à publier :

              {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "id": "submission/12345678-abcd-efgh-1234-12345678901/11521167929065",    
                "product": "product/12345678-abcd-efgh-1234-12345678901", 
                "target": { "targetType": "live" }
              }

Remarque

Si vous n’incluez pas la ressource de soumission, les modifications seront apportées uniquement à l’état brouillon.

Publication en préversion

Les types de produits commerciaux prennent en charge un environnement en préversion, et chaque mise à jour doit être publiée pour la première fois avant de passer en ligne. Vous ne pouvez pas publier directement en direct.

Important

L’exception à ceci est lorsque vous apportez des modifications à l’audience privée de vos plans. Lors de la synchronisation des mises à jour à l’audience privée spécifiquement, ces modifications se propagent à la fois en préversion et en direct en même temps.

Il existe deux façons de publier vos ressources dans l’environnement de préversion. Si des modifications doivent être apportées à la soumission en préversion, effectuez une autre requête GET, apportez les modifications nécessaires et envoyez à nouveau les modifications. Vous n’avez pas besoin d’être en direct avec vos modifications initiales.

Méthode 1 : Publier toutes les ressources brouillons

Si vous souhaitez publier chaque modification provisoire que vous avez apportée, vous pouvez envoyer une demande de configuration avec une ressource de soumission qui définit l’environnement d’aperçu comme « targetType ». Comme indiqué dans l’exemple ci-dessous, vous n’avez pas besoin de fournir explicitement toutes les ressources qui nécessitent une mise à jour, car cette méthode publie toutes les modifications apportées à l’environnement cible, ce qui, dans ce cas, est en préversion. Vous devez uniquement fournir le point de terminaison de l’API de configuration et la ressource de soumission.

Exemple de requête :

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
              {
            // Below is the submission resource to publish to preview
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "product": "product/12345678-abcd-efgh-1234-12345678901", // This is the product durable ID
                "target": { "targetType": "preview" }
              }
              ]
            }

Méthode 2 : Publier des ressources brouillons spécifiques (également appelées publication modulaire)

Sinon, si vous n’êtes pas prêt à publier tous les brouillons de modifications sur différentes ressources, fournissez simplement les ressources que vous souhaitez publier avec la ressource de soumission pour déclencher une publication modulaire. Vous pouvez également utiliser cette approche pour apporter des modifications aux ressources et les publier en même temps au lieu d’une mise à jour en bloc, comme c’est le cas via la méthode 1. Pour une publication modulaire, toutes les ressources sont requises à l’exception des détails au niveau du produit (par exemple, la liste, la disponibilité, les packages, le revendeur) en fonction de votre type de produit.

Exemple de requête :

Dans cet exemple, les ressources du produit sont explicitement fournies dans le cadre de la publication modulaire suivie de la ressource de soumission.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
              {
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview2", 
                "id": "product/12345678-abcd-efgh-1234-12345678901",
                ...
              },
              {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2", 
                  ...
              }, 
              // additional resources
              {
                  ...
              },
              // Below is the submission resource to publish to preview
              {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "product": "product/12345678-abcd-efgh-1234-12345678901", // This is the product durable ID
                "target": { "targetType": "preview" }
              }
              ]
            }

Publier en direct

Une fois que vos modifications en préversion ont été testées et vérifiées, vous pouvez envoyer vos modifications en direct en envoyant une demande de configuration avec l'« ID » de votre soumission d’aperçu et le « targetType » défini sur « live ». Pour rechercher l'« ID » de votre soumission en préversion à incorporer dans votre demande de configuration, consultez Interrogation de vos soumissions.

Important

Contrairement à la publication en préversion, il n’existe aucune option permettant d’effectuer une publication modulaire lors de la publication en direct. Par conséquent, il est important de vous assurer que vous avez vérifié votre soumission en préversion avant de passer en direct à vos modifications.

Exemple de requête :

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
              // Below is the submission resource, including the preview submission id, to publish to live.
              {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "id": "submission/12345678-abcd-efgh-1234-12345678901/11521167929065",    
                "product": "product/12345678-abcd-efgh-1234-12345678901", // This is the product durable ID
                "target": { "targetType": "live" }
              }
              ]
            }

Vérifier l’état d’une demande

Quelles que soient les ressources incluses dans votre demande de configuration ou les modifications que vous apportez, vous obtenez un objet d’état de configuration dans la réponse peu de temps après avoir envoyé une demande une fois qu’elle a été traitée. Le « jobID » est important, car il peut être utilisé ultérieurement pour vérifier l’état de la demande.

Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>

Exemple de réponse à une demande envoyée :

            {
                "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
                "jobID": "d4261631-c583-4949-a612-5150882632e9",
                "jobStatus": "notStarted",
                "jobResult": "pending",
                "jobStart": "2022-03-01T13:32:43.123456Z",
                "jobEnd": "0001-01-01T00:00:00",
                "errors": []
            }

État d’une demande en attente

Vous pouvez récupérer l’état jusqu’à ce que le travail se termine à l’aide de l’appel suivant et en plaçant le « jobID » de la requête. L’objet peut également contenir une liste d’erreurs s’il y a eu des problèmes avec votre demande.

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobID>/status?$version=2022-03-01-preview2

N’oubliez pas que le temps nécessaire peut varier en fonction de la complexité de votre demande,

Résumé d’une demande terminée

Une fois qu’une tâche de demande de configuration est terminée, soit correctement, soit avec un échec, vous pouvez obtenir la liste des ressources créées ou mises à jour à l’aide du « jobID ».

Remarque

Si vous effectuez cet appel avant la fin du travail, il échoue. En outre, il retourne uniquement les ressources qui ont été terminées avec succès, ou dans le cas d’une annulation uniquement les ressources terminées avant l’annulation.

Schema: <https://``schema.mp.microsoft.com``/schema/configure-detail/2022-03-01-preview2>

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobID>?$version=2022-03-01-preview2

Exemple de requête :

Dans l’exemple ci-dessous, une requête GET est utilisée pour récupérer les détails récapitulatives de la demande de configuration utilisée dans l’exemple précédent qui a créé un nouveau produit SaaS. La réponse est l’objet configure-detail avec le tableau de ressources contenant la ressource de produit créée avec son ID durable.

GET https://graph.microsoft.com/rp/product-ingestion/configure/071b135e-9faf-4ff7-b113-a3f25bb0f468?$version=2022-03-01-preview2

Exemple de réponse :

            {
"$schema": "https://schema.mp.microsoft.com/schema/configure-detail/2022-03-01-preview2",
"resources": [
{ 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview2",
                "id": "product/12345678-abcd-efgh-1234-12345678901",
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo "
                },
                "type": "softwareAsAService",
                "alias": "Contoso Image Resizing Service"
              }
]
}             

Annuler une demande de configuration

Avant la fin d’un travail, vous pouvez tenter de l’annuler si nécessaire. Pour les demandes longues, telles que la publication en « préversion » ou « en direct », la demande d’annulation peut être rejetée si le travail est assez long en cours de traitement complet.

Pour annuler un travail, effectuez un appel POST au point de terminaison d’annulation et fournissez l’ID de travail de la demande que vous souhaitez annuler.

POST https://graph.microsoft.com/rp/product-ingestion/configure<jobID>/cancel?$version=2022-03-01-preview2

Exemple de requête :

POST <https://graph.microsoft.com/rp/product-ingestion/configure/d4261631-c583-4949-a612-5150882632e9/cancel?$version=2022-03-01-preview2>

Exemple de réponse d’une demande d’annulation réussie :

            {
                "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
                "jobID": "d4261631-c583-4949-a612-5150882632e9",
                "jobStatus": "completed",
                "jobResult": "cancelled",
                "jobStart": "2022-03-01-T13:32:43.123456Z",
                "jobEnd": "2022-03-01T17:34:21.5225132Z",
                "errors": []
            }

Exemple de réponse au cas où l’annulation n’est pas autorisée : HTTP Status code: 400

Contenu :

            {
              "error": {
                "code": "badRequest",
                "message": "Cannot cancel job, job has already completed.",
                "details": []
              }
}

Important

N’oubliez pas que l’annulation s’applique uniquement aux ressources qui n’ont pas encore été traitées. Certaines ressources ont peut-être déjà terminé le traitement et reflètent les dernières mises à jour de configuration, malgré l’annulation de la demande.

Vous pouvez extraire le résumé de la demande de configuration après l’annulation pour vérifier quelles ressources (le cas échéant) ont déjà été traitées avant l’annulation.

Synchronisation des audiences privées

Pour un produit en direct, les mises à jour des audiences privées dans les environnements brouillons, en préversion et en direct peuvent être effectuées en même temps sans nécessiter de publication. Vous pouvez synchroniser l’audience privée à l’aide de la ressource « price-and-availability-update-private-audiences » en spécifiant les audiences que vous souhaitez ajouter ou supprimer d’un plan spécifique. Cela synchronise les environnements brouillons, en préversion et en direct pour avoir les mêmes valeurs d’audience privée. Vous n’avez pas besoin de fournir la ressource de soumission lors de la synchronisation de l’audience privée.

Pour modifier les audiences brouillons, utilisez la ressource « price-and-availability-plan » et la propriété « privateAudiences ». Cela doit passer par le flux de publication standard pour que les valeurs soient définies en préversion et en direct.

Important

Les types d’audience pris en charge sont « abonnement », « ea », « msdn » et « locataire », mais la prise en charge de ces types varie selon le type de produit. Si votre produit prend en charge plusieurs types d’identificateurs pour configurer l’audience privée (par exemple, les ID de locataire et les ID d’abonnement), vous devez effectuer une publication complète si vous fournissez un nouveau type d’identificateur pour la première fois. Vous ne pouvez pas synchroniser l’audience privée dans ce cas.

Exemple de requête pour synchroniser la configuration de l’audience privée :

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

        {
          "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
          "resources": [
          {
            "$schema": "https://schema.mp.microsoft.com/schema/price-and-availability-update-private-audiences/2022-03-01-preview2",
            "product": "product/12345678-abcd-efgh-1234-12345678901", // product durable ID
            "plan": "plan/12345678-abcd-efgh-1234-12345678901/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b", //plan durable ID 
            "privateAudiences":
            {
              "add ":
              [
                  {
            "type": "tenant",
                    "id": "4c2bdcdc-f10e-468d-8a2a-0832e089215b",
                    "label": "test 1"
                  }
              ],
              "remove ":
              [
                {
            "type": "subscription",
                    "id": "412c45bf-c99a-4e96-b683-77b0aa2dd09e",
                    "label": "test 2"
                }
              ]
            }
          }
          ]
        }

Configurer la gestion des prospects

Connectez votre système de gestion des relations client (CRM) à votre produit de la Place de marché commerciale afin de pouvoir recevoir des informations de contact client lorsqu’un client exprime son intérêt ou déploie votre produit. Vous pouvez modifier cette connexion à tout moment pendant ou après la création du produit. Pour en savoir plus, consultez Obtenir des prospects clients.

Exemple de demande pour configurer la gestion des prospects :

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

        {
          "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
          "resources": [
            {
            "$schema": "https://schema.mp.microsoft.com/schema/customer-leads/2022-03-01-preview3",
            "id": "customer-leads/a0c6484f-b4fb-4129-ac6b-35f2b5628089",
            "product": "product/a0c6484f-b4fb-4129-ac6b-35f2b5628089",
            "leadDestination": "httpsEndpoint",
            "httpsEndpointLeadConfiguration": {
              "httpsEndpointUrl": "https://www.your-crm.com/triggers/invoke"
            }
          }  
          ]
        }

États du cycle de vie des ressources

Vous pouvez effectuer différentes actions qui correspondent à l’état de cycle de vie d’une ressource. Toutes les ressources n’ont pas d’état de cycle de vie et tous les états de cycle de vie ne sont pas pris en charge par toutes les ressources. Pour découvrir si une ressource a un état de cycle de vie et quelles valeurs sont prises en charge, vous pouvez vérifier le schéma de ressource pour connaître l’existence de la propriété « lifecycleState ». Les différents états de cycle de vie pris en charge sont détaillés ci-dessous.

Supprimé

Vous pouvez supprimer des ressources spécifiques en mettant à jour la propriété « lifecycleState » sur « supprimée ». Vous ne pouvez supprimer que les ressources brouillons qui n’ont pas été publiées précédemment. Cette action ne peut pas être annulée.

Exemple de requête :

Dans l’exemple ci-dessous, le plan brouillon « de base » est supprimé.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

        {
          "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
          "resources": [
            {
            "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
            "id": "plan/9f8af57f-ab07-461b-8404-50e10e5e80fb/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b",
            "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
            "identity": { "externalID": "basic" },
            "alias": "basic plan"
            "lifecycleState": "deleted"
            }
          ]
        }

Déprécié

La dépréciation supprime la ressource de la place de marché commerciale. Pour déprécier, définissez la propriété « lifecycleState » sur « déconseillée » sur les ressources qui le prennent en charge. Il existe différents niveaux de dépréciation. Tous les types de produits prennent en charge la dépréciation de l’ensemble du produit et des plans individuels qu’il contient. Pour restaurer ultérieurement une ressource déconseillée, reportez-vous à l’état de cycle de vie « généralementavailable ».

Exemple de demande d’dépréciation d’un produit :

Dans l’exemple ci-dessous, la soumission dynamique du produit est définie pour déprécier. Une fois cette modification appliquée, elle est automatiquement publiée pour prendre effet.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
                {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2 ",
                "id": "submission/9f8af57f-ab07-461b-8404-50e10e5e80fb/1152921515689848683",
                "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
                "target": {
                    "targetType": "live"
                  },
                "lifecycleState": "deprecated"
                }
              ]
            }

Lors de la dépréciation des plans, la propriété « lifecycleState » doit être remplacée par « déconseillée » et les modifications doivent ensuite être publiées en « préversion », puis « live » pour que la dépréciation prenne effet. Cela diffère d’une dépréciation au niveau du produit dans laquelle la dépréciation sera automatiquement configurée dans l’environnement actif.

Exemple de demande d’dépréciation d’un plan :

Dans l’exemple ci-dessous, un plan dans un produit SaaS est défini pour déprécier. N’oubliez pas que pour appliquer cette modification, vous pouvez publier ultérieurement à l’aide de la ressource de soumission.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
                {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2 ",
                "id": "plan/9f8af57f-ab07-461b-8404-50e10e5e80fb/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b",
                "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
                "identity": { "externalID": "basic" },
                "alias": "basic plan"
                "lifecycleState": "deprecated"
                }
              ]
            }

Il existe d’autres formes de dépréciation qui varient en fonction du type de produit. En savoir plus sur la dépréciation de SaaS, de machines virtuelles et de conteneurs.

Disponibilité générale

generallyAvailable est l’état de cycle de vie par défaut pour toutes les ressources. Une fois qu’une ressource est déconseillée, vous pouvez la restaurer en remplaçant la propriété « lifecycleState » par « généralementAvailable ». Pour restaurer un produit déconseillé, vous devez publier le produit en préversion, puis en direct. Vous trouverez des exemples pour SaaS, machines virtuelles et conteneurs dans leurs articles respectifs.

Exemple de requête d’une restauration de plan :

Dans l’exemple ci-dessous, un plan est destiné à être restauré. Pour appliquer cette modification, vous devez publier ultérieurement tout le moyen de vivre à l’aide de la ressource de soumission.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-03-01-preview2

            {
              "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2"
              "resources": [
                {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
                "id": "plan/9f8af57f-ab07-461b-8404-50e10e5e80fb/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b",
                "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
                "identity": { "externalID": "basic" },
                "alias": "basic plan"
                "lifecycleState": "generallyAvailable"
                }
              ]
            }     

Informations de référence sur l’API de ressource

Les versions de schéma ci-dessous s’appliquent uniquement à la préversion et changent une fois que l’API devient généralement disponible.

Remarque

Vous pouvez afficher les ressources disponibles existantes et leurs versions ici : resources-index

Type de ressource	Description	Schéma
commercial-marketplace-setup	Décrit la configuration transactionnable des produits dans la Place de marché commerciale.	https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2
clients-prospects	Permet de se connecter à un système CRM pour recevoir des prospects clients.	https://schema.mp.microsoft.com/schema/customer-leads/2022-03-01-preview3
listage	Cela inclut les descriptions de votre produit, qui seront affichées dans les vitrines de la Place de marché commerciale Microsoft.	https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5
listing-asset	Captures d’écran et ressources marketing liées à la ressource de référencement.	https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5
listing-trailer	Ressources vidéo liées à la ressource de référencement.	https://schema.mp.microsoft.com/schema/listing-trailer/2022-03-01-preview5
microsoft365-integration	Activation et sélection de type Microsoft 365.	https://schema.mp.microsoft.com/schema/microsoft365-integration/2022-03-01-preview2
plan	Pour créer des plans, qui seront ensuite référencés par les ressources au niveau du plan que vous configurez, telles que la liste des plans.	https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2
liste de plans	Définissez le nom et la description du plan comme vous le souhaitez dans la Place de marché commerciale.	https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5
price-and-availability-custom-meter	Définissez les compteurs personnalisés partagés entre vos plans.	https://schema.mp.microsoft.com/schema/price-and-availability-custom-meter/2022-03-01-preview3
offre price-and-availability-offer	Définissez un public limité qui peut passer en revue votre produit avant de le publier en direct.	https://schema.mp.microsoft.com/schema/price-and-availability-offer/2022-03-01-preview3
price-and-availability-plan	Configurez les marchés dans utilisant ce plan, le modèle de monétisation souhaité, le prix et les conditions de facturation souhaitées.	https://schema.mp.microsoft.com/schema/price-and-availability-plan/2022-03-01-preview4
price-and-availability-update-private-audiences	Les mises à jour des audiences privées dans les environnements brouillons, en préversion et en direct peuvent être effectuées en même temps sans nécessiter de publication.	https://schema.mp.microsoft.com/schema/price-and-availability-update-private-audiences/2022-03-01-preview3
private-and-availability-private-offer-plan	Utilisé pour configurer les détails absolus des tarifs d’un produit/plan utilisé dans une offre privée	https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2022-07-01
offre privée	Définit le nom et le type d’offre privée, avec les conditions et détails de l’offre, ainsi que les produits/plans inclus et leurs tarifs	https://schema.mp.microsoft.com/schema/private-offer/2022-07-01
product	Il s’agit de la ressource principale, définit le nom et le type du produit, toutes les ressources font référence à ceci.	https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3
propriété	Définissez les catégories et les secteurs applicables à votre offre, à votre version d’application et aux contrats juridiques.	https://schema.mp.microsoft.com/schema/property/2022-03-01-preview5
revendeur	Configurez les partenaires dans le programme fournisseur de solutions Cloud s (CSP) auquel vous souhaitez rendre votre produit disponible.	https://schema.mp.microsoft.com/schema/reseller/2022-03-01-preview2
arborescence des ressources	Décrit le produit une liste de ressources pour ce produit dans l’état actuel de l’environnement cible spécifié.	https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2
software-as-a-service-technical-configuration	Détails techniques qui aident la Place de marché commerciale Microsoft à se connecter à votre solution.	https://schema.mp.microsoft.com/schema/software-as-a-service-technical-configuration/2022-03-01-preview3
soumission	Peut être utilisé pour déclencher différentes actions sur votre produit et indiquer l’état de publication de vos environnements indifférents de produit (brouillon, préversion et live).	https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2
virtual-machine-plan-technical-configuration	Détails techniques décrivant la machine virtuelle et l’emplacement de l’image.	https://schema.mp.microsoft.com/schema/virtual-machine-plan-technical-configuration/2022-03-01-preview3
container-plan-technical-configuration	Détails techniques décrivant les propriétés de l’image conteneur.	https://schema.mp.microsoft.com/schema/container-plan-technical-configuration/2022-03-01-preview3

Conseils d’API par type de produit

L’API d’ingestion de produit sera mise à la disposition d’autres types de produits à l’avenir. À mesure que d’autres types de produits sont pris en charge, des conseils plus spécifiques à chaque type de produit seront mis à disposition.

Type de produit	Ressources spécifiques au type de produit
Offres privées	Créer et gérer des offres privées via l’API d’ingestion de produit
SaaS	Créer et gérer des offres SaaS via l’API d’ingestion de produit
Machines virtuelles	Créer et gérer des offres de machines virtuelles via l’API d’ingestion de produit
conteneurs	Créer et gérer des offres de conteneur via l’API d’ingestion de produit

Versions et mises à jour de l’API

Update	Qu’est-ce qui a changé ?
11-2023	Tous les points de terminaison de schéma ont été mis à jour de product-ingestion.azureedge.net à schema.mp.microsoft.com
12-2022	Une nouvelle version de schéma 2022-03-01-preview3 de l’API d’ingestion du PC pour les prospects client est désormais disponible qui accepte clientID et clientSecret lors de la configuration des prospects clients et arrête de capturer les champs serverID et contact email. Passez à la nouvelle version et fournissez l’ID client et le clientSecret pour continuer à configurer le connecteur Marketo pour les offres de la Place de marché. Nouvelle URL de schéma : https://``schema.mp.microsoft.com``/schema/customer-leads/2022-03-01-preview3
09-2022	La prise en charge de la préversion du conteneur est publiée en tant que version 2022-03-01-preview4
08-2022	La prise en charge de la préversion du logiciel en tant que service est publiée en tant que version 2022-03-01-preview3
08-2022	Publication publique de l’offre privée version 2022-07-01
05-2022	La prise en charge de la préversion des machines virtuelles est publiée en tant que version 2022-03-01-preview2

Contenu connexe

• API d’ingestion de produit pour SaaS
• API d’ingestion de produit pour les conteneurs transactables