Produktinmatnings-API för den kommersiella marknadsplatsen
API:et för produktinmatning är ett moderniserat API som förenar alla befintliga api:er för insändning i alla produkter på den kommersiella marknadsplatsen. Med API:et kan du skapa, publicera och hantera resurser som är associerade med produkter och planer i ditt Partnercenter-konto. Den använder ett deklarativt mönster för att skicka begäranden, där önskat tillstånd anges i stället för att ange de enskilda stegen för att nå önskat tillstånd.
Den här artikeln innehåller vägledning om hur du kommer igång med API:erna för alla typer av erbjudanden på den kommersiella marknadsplatsen. API:et för produktinmatning stöds för närvarande för SaaS, virtuella datorer, privata erbjudanden och containererbjudandetyper och finns i förhandsversion. Vägledning som är specifik för ditt erbjudande finns i API-vägledningen per erbjudandetyp.
Viktigt!
Azure Active Directory (Azure AD) Graph är inaktuell från och med den 30 juni 2023. Framöver gör vi inga ytterligare investeringar i Azure AD Graph. Azure AD Graph-API:er har inget serviceavtal eller underhållsåtagande utöver säkerhetsrelaterade korrigeringar. Investeringar i nya funktioner och funktioner görs endast i Microsoft Graph.
Vi drar tillbaka Azure AD Graph i stegvisa steg så att du har tillräckligt med tid för att migrera dina program till Microsoft Graph-API:er. Vid ett senare tillfälle som vi kommer att meddela kommer vi att blockera skapandet av nya program med hjälp av Azure AD Graph.
Mer information finns i Viktigt: Utfasning av Azure AD Graph Och Utfasning av Powershell-moduler.
Komma igång
API:et för produktinmatning kan nås med hjälp av MSGraph-API :et under arbetsbelastningsnamnet "product-ingestion". Bas-URL:en är https://graph.microsoft.com/rp/product-ingestion.
Om du vill använda API:et för produktinmatning måste du först skaffa följande:
- Ett Microsoft Entra-ID och se till att du har global administratörsbehörighet för katalogen
- Ett Microsoft Entra-program
- En Microsoft Entra-åtkomsttoken
Steg 1: Slutför förutsättningar
Innan du börjar skriva kod för att anropa API:et för produktinmatning kontrollerar du att du har slutfört följande krav.
- Du (eller din organisation) måste ha en Microsoft Entra-katalog och du måste ha global administratörsbehörighet för katalogen. Om du redan använder Microsoft 365 eller andra företagstjänster från Microsoft har du redan Microsoft Entra-katalog. Annars kan du skapa ett nytt Microsoft Entra-ID i Partnercenter utan extra kostnad.
- Du måste associera ett Microsoft Entra-program med ditt Partnercenter-konto och hämta ditt klient-ID, klient-ID och nyckel. Du behöver dessa för att hämta den Microsoft Entra-åtkomsttoken som du kommer att använda i anrop till Microsoft Store-api:et för överföring.
Associera ett Microsoft Entra-program med ditt Partnercenter-konto
Om du vill använda API:et för produktinmatning måste du associera ett Microsoft Entra-program med ditt PartnerCenter-konto, hämta klient-ID:t och klient-ID:t för programmet och generera en nyckel. Microsoft Entra-programmet representerar den app eller tjänst som du vill anropa API:et för produktinmatning från. Du behöver klientorganisations-ID, klient-ID och nyckel för att hämta en Microsoft Entra-åtkomsttoken för att skicka till API:et.
Kommentar
Du behöver bara utföra den här uppgiften en gång. När du har klient-ID, klient-ID och nyckel kan du återanvända dem när du behöver skapa en ny Microsoft Entra-åtkomsttoken.
- I Partnercenter associerar du organisationens Partnercenter-konto med organisationens Microsoft Entra-katalog.
- På sidan Användare i avsnittet Kontoinställningar i Partnercenter lägger du till Microsoft Entra-programmet som representerar den app eller tjänst som du ska använda för att få åtkomst till inskickade filer för ditt Partnercenter-konto. Se till att du tilldelar det här programmet rollen Chef . Om programmet inte finns ännu i din Microsoft Entra-katalog skapar du ett nytt Microsoft Entra-program i Partnercenter. Partnercenter skapar två typer av poster för programmet en som tjänstens huvudnamn och den andra som Microsoft Entra-programtyp.
- Gå tillbaka till sidan Användare , välj namnet på ditt Microsoft Entra-program för att gå till programinställningarna och kopiera värdena för klient-ID och klient-ID .
- Välj Lägg till ny nyckel. På följande skärm kopierar du nyckelvärdet . Du kommer inte att kunna komma åt den här informationen igen när du har lämnat den här sidan. Mer information finns i Hantera nycklar för ett Microsoft Entra-program.
Steg 2: Hämta en Microsoft Entra-åtkomsttoken
Om du vill anropa någon av metoderna i API:et för produktinmatning måste du först skaffa en Microsoft Entra-åtkomsttoken för att skicka till auktoriseringshuvudet för varje metod i API:et. En åtkomsttoken upphör att gälla 60 minuter efter utfärdandet. Därefter kan du uppdatera den så att du kan använda den i framtida anrop till API:et.
Om du vill hämta åtkomsttoken följer du anvisningarna i Tjänst-till-tjänst-anrop med klientautentiseringsuppgifter för att skicka en HTTP POST till https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token slutpunkten. Här är en exempelbegäran:
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
För det tenant_id värdet i POST-URI:n och parametrarna client_id och client_secret anger du klient-ID, klient-ID och nyckeln för ditt program som du hämtade från Partnercenter i föregående avsnitt. För omfångsparametern måste du ange https://graph.microsoft.com/.default.
Begrepp
Innan du kommer igång måste du förstå några grundläggande begrepp.
Resurser
API:et är uppbyggt kring resurstyper, där varje typ beskrivs med hjälp av en dedikerad schemadefinition som refereras av egenskapen "$schema". Schemat består av konfigurationsegenskaperna för den resursen. Resurser är grundläggande för att skapa och uppdatera konfigurationen av olika aspekter av en viss produkt. En fullständig lista över resurstyper och deras scheman finns i resurs-API-referensen.
Varaktigt ID
Ett varaktigt ID är ett systemgenererat globalt ID som används för att unikt identifiera alla resurser. Varje resurs har en associerad "ID"-egenskap, som i kombination med resurstypsnamnet utgör en resurss varaktiga ID. Det varaktiga ID:t används när du refererar till resurser för att antingen hämta eller ändra.
Format:
\<resource-type>/\<id>
Exempel:
{
"$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"
}
Externt ID
Ett externt ID är en annan unik identifierare som kan användas för att referera till specifika produkter eller planer. Det här är ett alternativt sätt att referera till dessa resurser i stället för att använda det varaktiga ID:t. Det externa ID:t för en produkt översätts till dess "offerID" och det externa ID:t för en plan översätts till dess "planID", enligt definitionen när den skapas under egenskapen "identitet".
Exempel:
{
"$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",
}
API-metoder
Det finns fyra hanterings-API:er som kan användas för att utföra olika åtgärder, till exempel att fråga befintliga resurser, göra konfigurationsuppdateringar och kontrollera status för en begäran.
Kommentar
Alla begäranden kräver att du anger den schemaversion ($version frågeparameter) som du vill ha som en del av svaret.
| API-typ | Beskrivning | HTTP-metod och sökväg |
|---|---|---|
| Fråga | Hämtar befintliga resurser genom att: -Metod 1: Resursträdstyp -Metod 2: durable-id -Metod 3: frågesträngsparametrar |
-Metod 1: GET resource-tree/<product-durableID>-Metod 2: GET <resource-durableID>-Metod 3: GET <resourceType>?<query parameters> |
| Konfigurera sändning | Skickar begäranden om att skapa eller uppdatera en eller flera resurser. När bearbetningen har slutförts returneras ett jobID som kan användas för att hämta status för begäran. Den här API-typen kan användas för att uppdatera utkasttillståndet och publicera ändringar, synkronisera privata målgrupper och ändra resursens livscykeltillstånd. | POST configure |
| Konfigurera status | Hämtar status för en väntande begäran via jobID. | GET configure/<jobID>/status |
| Konfigurera statusinformation | Hämtar en detaljerad sammanfattning av en slutförd begäran, inklusive de uppdaterade resurserna, via jobID. | GET configure/<jobID> |
| Avbryt konfiguration | Avbryter det angivna Konfigurera jobbet. | POST configure/<jobID>/cancel |
Ett typiskt arbetsflöde
För att uppdatera en befintlig resurs skulle ett vanligt arbetsflöde vara att:
- Hämta en befintlig resurskonfiguration (API-typ: Fråga via resursträd)*
- Gör nödvändiga uppdateringar och skicka sedan en konfigurationsbegäran (API-typ: Konfigurera skicka)
- Kontrollera statusen för begäran (API-typ: Konfigurera status och Konfigurera statusinformation)
*Samma arbetsflöde kan användas när du skapar nya resurser, men i stället för att hämta resurser (steg 1) använder du referenstabellen för resurs-API:et för att se till att du använder det aktuella schemat för den resurstyp som du skapar.
Sammanfattnings nog visar den här bilden det typiska anropsmönster som används för att skicka en konfigurationsbegäran, oavsett om du skapar en ny eller ändrar en befintlig resurs.
Kommentar
Se till att granska eventuella ytterligare krav som är specifika för den erbjudandetyp som du hanterar genom att läsa avsnittet API-vägledning per erbjudandetyp .
Hämta befintliga resurskonfigurationer
Innan du uppdaterar befintliga resurser är det viktigt att först hämta dem för att se till att du har den senaste konfigurationen. Det finns flera sätt att hämta resurser via ett GET-anrop. Se Metod 1, som beskrivs nedan, för att hämta alla resurser inom en specifik produkt i ett enda API-anrop.
Metod 1: Resursträd
Schema: https://``schema.mp.microsoft.com``/schema/resource-tree/2022-03-01-preview2
GET resource-tree/<product-durableID>?$version=<schema-version>
Du kan hämta alla resurskonfigurationer i en specifik produkt med resurstypen "resource-tree" tillsammans med produktens hållbara ID.
Den senaste tillgängliga schemaversionen kan vara olika för varje resurs. När du utför en resursträdsbegäran avgör den angivna schemaversionen vilken version som returneras för varje resurs i produkten. Den angivna versionen fungerar som en "max"-versionsgräns eftersom den returnerar den senaste schemaversionen som är tillgänglig för alla resurser med samma eller lägre version. Om till exempel den senaste tillgängliga planlistningsversionen är "2022-03-01-preview3" visas den här versionen om du anger "2022-03-01-preview5" i GET-begäran för resursträd. Men om du begär "2022-03-01-preview2" som resursträdsversion returnerar detta planen "2022-03-01-preview2" som listar resursen trots att den senaste tillgängliga versionen är "2022-03-01-preview3". Vi rekommenderar att du använder den senaste tillgängliga versionen av varje resurs för att säkerställa att du använder ett uppdaterat schema med nyligen stödda funktioner.
Kommentar
Om du inte känner till produktens varaktiga ID kan du använda produktens externa ID för att hämta produktresursen genom att köra GET product?externalID=<product-externalID>&$version=<product-schema-version>. Den här begäran använder en frågesträngsparameter, som beskrivs i metod 3 nedan. Svaret innehåller produktens varaktiga ID, som du kan använda för framtida begäranden.
När du kör ett GET-anrop med hjälp av "resource-tree" får du som standard tillbaka utkastversionen av dina resurser. Men genom att skicka frågeparametern "targetType" kan du ange önskat mål för att hämta "förhandsversion" eller "live"-data. I följande exempel returnerar GET-anropet konfigurationen av förhandsgranskningsmiljön för alla resurser under produkten "12345678-abcd-efgh-1234-12345678901".
Exempel på GET-anrop:
GET https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType="preview"&$version=2022-03-01-preview5
Exempelsvar:
{
"$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.
{
...
}]
}
Metod 2: Varaktigt ID
GET <resource-durableID>?$version=<schema-version>
Hämta en specifik resurs med hjälp av dess varaktiga ID. När en resurs har skapats förblir det varaktiga ID:t alltid detsamma och kan användas för att hämta de senaste utkaständringarna för resursen genom att anropa GET-metoden. Följande begäran returnerar till exempel utkastkonfigurationen för den här specifika produkten med schemaversionen "2022-03-01-preview3".
GET product/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview3
Viktigt!
Den här metoden används endast för att hämta utkastkonfigurationen. Om du vill hämta förhandsgransknings- eller livedata använder du metoden "resource-tree" enligt beskrivningen ovan.
Om du vill hitta det varaktiga ID:t för dina resurser kan du antingen:
- Använd metoden "resource-tree" för att hämta alla resurser i produkten tillsammans med var och en av deras respektive varaktiga ID:n, eller
- Hämta information om en slutförd resurskonfigurationsbegäran, som innehåller de varaktiga ID:erna för alla resurser som skapats eller uppdaterats som en del av begäran.
Kom ihåg att egenskapen "ID" är durable-id för respektive resurs.
Metod 3: Frågesträngsparametrar
GET <resourceType>?<query parameters>&$version=<schema-version>
Den här metoden används för att fråga vissa resurstyper som är associerade med ett specifikt konto. Du kan till exempel hämta alla dina produkter av en viss produkttyp med ett enda GET-anrop. Frågesträngsparametrar används för att fråga efter information om dina produkter, planer eller inlämningar.
Den här tabellen visar de frågeparametrar som stöds för var och en av de resurstyper som stöds. Alla resurstyper stöder inte var och en av frågeparametrarna. Referera till den här tabellen för den fullständiga listan över frågesträngar som stöds för närvarande.
| Resurstyp | Parametrar | Exempel på frågesträngar |
|---|---|---|
| Plan | Produkt*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> |
| Produkt | 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> |
| Inlämning | targetType $maxpagesize continuationToken$version * |
GET submission/<product-durableID>?targetType=<environment>&$version=<schema-version>GET submission/<product-id>?$maxpagesize=<#>&continuationToken=<token>&$version=<schema-version> |
| resource-tree | targetType$version* |
GET resource-tree/<product-durableID>?targetType=<environment>&$version=<schema-version> |
* Parametrarna för produkten och $version krävs alltid.
Funktioner för var och en av de frågeparametrar som stöds:
- product – När parametern "product" skickas i samband med resurstypen "plan" returneras alla planer inom den specifika produkten.
- externalID – När parametern "externalID" skickas i samband med en produkt eller plan returneras konfigurationen av respektive produkt eller plan. Till skillnad från metoden "resource-tree" returnerar den här frågesträngsparametern bara information om den resursen, inte alla resurser i den.
- type – När parametern "type" skickas i samband med resurstypen "produkt" returneras alla produkter av den typen som är kopplade till ditt konto. Genom att till exempel ange "type=softwareAsAService" returneras alla dina SaaS-produkter.
- targetType – Detta returnerar data för en specifik miljö i kontexten för den resurstyp som används. De "targetType"-värden som stöds är "draft", "preview" eller "live".
- $maxpagesize – Genom att ange den maximala sidstorleken, i form av ett positivt heltal, används den här parametern för att begränsa resultatet av sökningen när du frågar efter dina tidigare inlämningar.
- continuationToken – Den här parametern kan användas med parametern "$maxpagesize" för att köra frågor mot en annan uppsättning resultat som är tillgängliga i sökningen. Värdet "continuationToken" anges i svaret på föregående sida.
- $version – Det här är en obligatorisk parameter för alla anrop, den anger vilken schemaversion du vill ha för svaret från den begäran du gjorde. Den senaste tillgängliga schemaversionen kan vara olika för varje resurs och den angivna versionen fungerar som en maxversionsgräns. Systemet returnerar antingen den exakta schemaversionen om den är tillgänglig eller den närmaste versionen som är äldre än den begärda versionen. Detta kan hjälpa dig att hålla koden igång även om det finns nyare schemaändringar, men för att kunna använda de senaste funktionerna rekommenderar vi att du använder den senaste tillgängliga versionen av varje schema.
Köra frågor mot dina inskickade
Du kan hämta dina befintliga produktöverföringar genom att göra GET submission/<product-durableID>. Som standard får du tillbaka alla dina aktiva inlämningar, inklusive utkastreferensen, men du kan dessutom köra frågor mot en specifik miljö med hjälp av frågeparametern "targetType": (GET submission/<product-durableID>?targetType=<environment>&$version=<version>).
Viktigt!
När en "förhandsversion" skickas till "Live" ersätter den alla tidigare "Live"-inskickningar. När detta händer representerar data nu både "Förhandsversion" och "Live"-miljöer tills en ny insändning har publicerats till "Förhandsversion".
Exempelbegäran:
GET https://graph.microsoft.com/rp/product-ingestion/submission/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview2
Exempelsvar:
Det här exemplet visar en GET-begäran för aktiva inlämningar som är kopplade till produkt-ID :t "12345678-abcd-efgh-1234-12345678901". Den aktiva "Live"-inlämningen (submission/12345678-abcd-efgh-1234-12345678901/1152921515689847470) publicerades för att förhandsgranska först och sedan senare för att leva. När den här inlämningen skickades live den 25 januari 2022 representerade den både förhandsversion och live tills en ny förhandsversion (submission/12345678-abcd-efgh-1234-12345678901/1152921515689848683) skapades den 4 februari 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"
}
]
}
Skapa nya produkter och resurser
Du kan skapa nya resurser, inklusive nya produkter, som en del av en enda konfigurationsbegäran. Med hjälp av resurs-API-referenstabellen kan du hämta schemat för den resurstyp som du vill skapa. Detta säkerställer att du använder det senaste schemat och därför konfigurerar alla nödvändiga egenskaper för att skapa resursen.
Om du skapar en ny produkt varierar kraven beroende på produkttyp. Därför måste du ange olika resurser. Du kan referera till motsvarande dokumentation om den kommersiella marknadsplatsen för respektive produkttyp för att säkerställa att du konfigurerar de grundläggande kraven i din begäran. Du kan också göra en konfigurationsbegäran med bara produktresursen. När du har skapat produkten anropar du API:et konfigurera statusinformation för att hämta den skapade produktresursen och hitta dess varaktiga ID för att anropa fråge-API:et för resursträd. Svaret returnerar de tillämpliga resurser som stöds för den produkttyp som du skapade.
Om du vill skapa en ny resurs i en befintlig produkt måste du också hämta det senaste schemat för den specifika resurstypen. Se till att du anger de beroende resurserna som en del av konfigurationsbegäran genom att granska resursberoendena.
När du har konstruerat dina resurser med hjälp av schemana får du lära dig hur du gör en konfigurationsbegäran.
Ändra befintliga produkter och resurser
Du kan skicka uppdateringar med hjälp av den konfigurerade nyttolasten. Den här nyttolasten består av en eller flera resurstyper och egenskapen "$schema" anger resurstypen som refereras.
Dricks
Vi rekommenderar att du först hämtar befintliga resurser innan du publicerar uppdateringar för att säkerställa att du använder den senaste konfigurationen.
När du har modifierat dina resurser får du lära dig hur du gör en konfigurationsbegäran.
Konfigurationsbegäranden
Du kan redigera och publicera i samma nyttolast. Om du vill skicka en konfigurationsbegäran använder du HTTP POST-metoden för konfigurations-API:et. Den konfigurerade nyttolasten består av en matris med resurser som anger önskade ändringar. Alla ändringar påverkar endast utkastversionen tills du uttryckligen skickar en inskickad resurs för att publicera dina utkaständringar. När du publicerar för att förhandsgranska eller live ska du ta med insändningsresursen och ange målmiljön. Innan du skickar en begäran måste du veta hur du refererar till resurser och förstår deras beroenden.
Schema:<https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2>
När du skickar konfigurationsbegäran får du tillbaka ett konfigurationsstatusobjekt med det jobID som du kan använda för att spåra förloppet och resultatet av din begäran.
Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>
Resursreferenser och beroenden
Referenser
Om du vill referera till en befintlig resurs i en konfigurerad begäran anger du resursens typ "$schema" tillsammans med resursens varaktiga ID. När det gäller produkter och planer kan du även referera till dessa resurser via deras externa ID.
Det hållbara ID:t finns i egenskapen "ID", till exempel om det här är den produktresurs som vi vill referera till i en annan resurs:
{
"$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"
}
Det hållbara ID:t skulle vara "product/071b135e-9faf-4ff7-b113-a3f25bb0f468".
Det varaktiga ID:t kan sedan användas i resursexemplet nedan genom att ange det i resursschemaegenskapen "produkt" så här:
{
"$schema": "https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5",
"product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468", // product durable ID
...
}
Det externa ID:t för produkt- och planresurser definieras i egenskapen "identitet".
{
"$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",
...
}
Planens externa ID "gold-annual" kan sedan refereras till av andra efterföljande resurser i följande format:
{
"$schema": "https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5",
"product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468"}
"plan": {"externalID": "gold-annual"}
...
}
Exempelbegäran:
I det här exemplet används den konfigurerade nyttolasten för att skapa en ny SaaS-produkt med ett externt ID för "ds-contoso-image-resize-demo". När du skapar den här produkten kan du senare referera till den här produkten med hjälp av dess varaktiga ID eller externa ID.
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"
}
]
}
Exempelsvar:
{
"$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": []
}
Du kan sedan använda jobID via API:et Konfigurera status för att kontrollera statusen för din begäran.
Beroenden
Vissa resurser har beroenden för att skapa en annan resurs som en förutsättning. I det här fallet använder vi egenskapen "resourceName" inom samma nyttolast för att ange beroendet av produktresursen i planresursen när vi skapar båda i samma begäran.
"resourceName" används bara för att identifiera varje resurs som en del av den konfigurerade begäran som du gör. Värdet kommer inte att vara en del av resursernas data, det lagras inte och exponeras inte heller för kunderna. Om det finns några fel som en del av konfigurationsbegäran används "resourceName" för att anropa den resurs som felet tillhör.
Exempelbegäran:
I det här exemplet måste produkten skapas före planen och därför används egenskapen "resourceName". Produkten som skapas, "myNewProduct", är det värde som används för "resourceName" och refereras till i den beroende planresursen.
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"}
...
},
}]
}
Överföringsresurs
Om du publicerar till "förhandsversion" eller "live" inkluderar du den inskickade resursen i din begäran, som innehåller:
- Egenskapen "produkt" som anger att produkten uppdateras enligt referensen för antingen dess varaktiga ID eller externa ID
- Egenskapen "targetType" som anger målmiljön
När du publicerar till live specifikt, "ID" för den förhandsversion som du vill publicera:
{
"$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" }
}
Kommentar
Om du inte tar med den inskickade resursen görs ändringarna endast i utkasttillståndet.
Publicera till förhandsversion
Kommersiella produkttyper stöder en förhandsversionsmiljö och varje uppdatering måste först publiceras till förhandsversionen innan den går live. Du kan inte publicera direkt till live.
Viktigt!
Undantaget är när du gör ändringar i den privata målgruppen för dina planer. När du synkroniserar uppdateringar till den privata målgruppen specifikt sprids dessa ändringar till både förhandsversion och live samtidigt.
Det finns två sätt att publicera dina resurser i förhandsversionsmiljön. Om du behöver göra några ändringar i förhandsgranskningsöverföringen gör du en annan GET-begäran, gör nödvändiga ändringar och push-överför ändringarna igen. Du behöver inte först gå live med dina första ändringar.
Metod 1: Publicera alla utkastresurser
Om du vill publicera varje utkaständring som du har gjort kan du skicka en konfigurerad begäran med en inskickad resurs som anger förhandsgranskningsmiljön som "targetType". Som du ser i exemplet nedan behöver du inte uttryckligen ange varje resurs som kräver en uppdatering eftersom den här metoden publicerar alla ändringar i målmiljön, vilket i det här fallet är förhandsversion. Du behöver bara ange den konfigurerade API-slutpunkten och överföringsresursen.
Exempelbegäran:
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" }
}
]
}
Metod 2: Publicera specifika utkastresurser (kallas även modulär publicering)
Om du inte är beredd att publicera alla utkaständringar över olika resurser kan du också ange de resurser som du vill publicera tillsammans med överföringsresursen för att utlösa en modulär publicering. Du kan också använda den här metoden för att göra ändringar i resurser och publicera dem samtidigt i stället för som en del av en massuppdatering, som görs via metod 1. För en modulär publicering krävs alla resurser förutom information på produktnivå (till exempel lista, tillgänglighet, paket, återförsäljare) som gäller för din produkttyp.
Exempelbegäran:
I det här exemplet tillhandahålls resurser i produkten uttryckligen som en del av den modulära publiceringen följt av överföringsresursen.
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" }
}
]
}
Publicera live
När dina ändringar i förhandsversionen har testats och verifierats kan du skicka ändringarna live genom att skicka en konfigurerad begäran med "ID" för förhandsversionen och "targetType" inställt på "live". Information om hur du hittar "ID" för din förhandsversion som ska införlivas i din konfigurerade begäran finns i Fråga efter dina inskickade filer.
Viktigt!
Till skillnad från när du publicerar till förhandsversionen finns det inget alternativ för att utföra en modulär publicering när du publicerar live. Därför är det viktigt att se till att du har verifierat din förhandsversion innan du går live med dina ändringar.
Exempelbegäran:
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" }
}
]
}
Kontrollera status för en begäran
Oavsett vilka resurser som ingår i din konfigurerade begäran eller de ändringar du gör får du tillbaka ett konfigurationsstatusobjekt i svaret strax efter att du har skickat en begäran när den har bearbetats. "jobID" är viktigt eftersom det senare kan användas för att kontrollera status för begäran.
Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>
Exempelsvar på en skickad begäran:
{
"$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": []
}
Status för en väntande begäran
Du kan hämta statusen tills jobbet har slutförts med hjälp av följande anrop och ange "jobID" för begäran. Objektet kan också innehålla en lista över fel om det finns några problem med din begäran.
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobID>/status?$version=2022-03-01-preview2
Tänk på att tiden att slutföra kan variera beroende på komplexiteten i din begäran,
Sammanfattning av en slutförd begäran
När ett konfigurerat begärandejobb har slutförts, antingen korrekt eller med ett fel, kan du hämta listan över resurser som skapats eller uppdaterats med hjälp av "jobID".
Kommentar
Om du gör det här anropet innan jobbet har slutförts misslyckas det. Dessutom returnerar den endast de resurser som har slutförts, eller vid en annullering endast de som slutfördes före annulleringen.
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
Exempelbegäran:
I exemplet nedan används en GET-begäran för att hämta sammanfattningsinformationen för den konfigurerade begäran som användes i det tidigare exemplet som skapade en ny SaaS-produkt. Svaret är objektet configure-detail med resursmatrisen som innehåller produktresursen som skapades tillsammans med dess varaktiga ID.
GET https://graph.microsoft.com/rp/product-ingestion/configure/071b135e-9faf-4ff7-b113-a3f25bb0f468?$version=2022-03-01-preview2
Exempelsvar:
{
"$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"
}
]
}
Avbryt en konfigurationsbegäran
Innan ett jobb har slutförts kan du försöka avbryta det om det behövs. För tidskrävande begäranden, till exempel publicering till "förhandsversion" eller "live", kan avbokningsbegäran avvisas om jobbet är tillräckligt långt för att bearbetas fullt ut.
Om du vill avbryta ett jobb gör du ett POST-anrop till den avbrutna slutpunkten och anger jobb-ID:t för den begäran som du vill avbryta.
POST https://graph.microsoft.com/rp/product-ingestion/configure<jobID>/cancel?$version=2022-03-01-preview2
Exempelbegäran:
POST <https://graph.microsoft.com/rp/product-ingestion/configure/d4261631-c583-4949-a612-5150882632e9/cancel?$version=2022-03-01-preview2>
Exempelsvar på en lyckad annulleringsbegäran:
{
"$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": []
}
Exempelsvar om annullering inte tillåts: HTTP Status code: 400
Innehåll:
{
"error": {
"code": "badRequest",
"message": "Cannot cancel job, job has already completed.",
"details": []
}
}
Viktigt!
Tänk på att annulleringen endast gäller för resurser som ännu inte har bearbetats. Vissa resurser kanske redan har slutfört bearbetningen och återspeglar de senaste konfigurationsuppdateringarna, trots att begäran har avbrutits.
Du kan hämta sammanfattningen av den konfigurerade begäran efter annulleringen för att kontrollera vilka resurser (om några) som redan hade bearbetats före annulleringen.
Synkronisera privata målgrupper
För en liveprodukt kan uppdateringar till privata målgrupper i utkast-, förhandsversions- och livemiljöer utföras samtidigt utan att en publicering krävs. Du kan synkronisera den privata målgruppen med hjälp av resursen "price-and-availability-update-private-audiences" genom att ange vilka målgrupper du vill lägga till eller ta bort från en specifik plan. Detta synkroniserar utkast-, förhandsversions- och livemiljöerna så att de har samma privata målgruppsvärden. Du behöver inte ange den inskickade resursen när du synkroniserar den privata målgruppen.
Om du vill redigera utkastens målgrupper använder du resursen "price-and-availability-plan" och egenskapen "privateAudiences". Detta måste gå igenom det vanliga publiceringsflödet för att värdena ska anges i förhandsversion och live.
Viktigt!
Målgruppstyperna som stöds är "prenumeration", "ea", "msdn" och "klientorganisation", men stödet för dessa varierar beroende på produkttyp. Om din produkt stöder mer än en typ av identifierare för att konfigurera den privata målgruppen (till exempel både klient-ID:n och prenumerations-ID:n) måste du utföra en fullständig publicering om du anger en ny identifierartyp för första gången. Du kan inte synkronisera den privata målgruppen i det här fallet.
Exempelbegäran om att synkronisera konfigurationen av den privata målgruppen:
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"
}
]
}
}
]
}
Konfigurera leadhantering
Anslut ditt CRM-system (Customer Relationship Management) med din produkt på den kommersiella marknadsplatsen så att du kan få kundkontaktinformation när en kund uttrycker intresse eller distribuerar din produkt. Du kan ändra den här anslutningen när som helst under eller efter produktskapandet. Mer information finns i Hämta kundleaser.
Exempelbegäran för att konfigurera leadhantering:
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"
}
}
]
}
Tillstånd för resurslivscykel
Det finns olika åtgärder som du kan vidta för att mappa till en resurs livscykeltillstånd. Alla resurser har inte ett livscykeltillstånd och alla livscykeltillstånd stöds inte av alla resurser. Om du vill ta reda på om en resurs har ett livscykeltillstånd och vilka värden som stöds kan du kontrollera resursschemat för förekomsten av egenskapen "lifecycleState". Olika livscykeltillstånd som stöds beskrivs nedan.
Borttagen
Du kan ta bort specifika resurser genom att uppdatera egenskapen "lifecycleState" till "deleted". Du kan bara ta bort utkastresurser som inte har publicerats tidigare. Det går inte att ångra den här åtgärden.
Exempelbegäran:
I exemplet nedan tas det "grundläggande" utkastet bort.
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"
}
]
}
Inaktuell
Utfasning tar bort resursen från den kommersiella marknadsplatsen. Om du vill bli inaktuell anger du egenskapen "lifecycleState" till "inaktuell" på de resurser som stöder den. Det finns olika nivåer av utfasning. Alla produkttyper stöder inaktuella hela produkten och enskilda planer i den. Om du vill återställa en inaktuell resurs senare läser du livscykeltillståndet "allmänttillgängligt".
Exempelbegäran om en produktutfasning:
I exemplet nedan är livesändningen av produkten inställd på att föråldras. När den här ändringen har tillämpats publiceras den automatiskt live för att börja gälla.
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"
}
]
}
Vid inaktuella planer måste egenskapen "lifecycleState" ändras till "inaktuell" och ändringarna måste sedan publiceras till "förhandsversion" och sedan "live" för att utfasningen ska börja gälla. Detta skiljer sig från en utfasning på produktnivå där utfasningen automatiskt konfigureras i den aktiva miljön.
Exempelbegäran om en planutfasning:
I exemplet nedan är en plan i en SaaS-produkt inställd på att bli inaktuell. Kom ihåg att om du vill tillämpa den här ändringen kan du publicera senare med hjälp av överföringsresursen.
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"
}
]
}
Det finns andra former av utfasning som varierar beroende på produkttyp. Läs mer om utfasning av SaaS, virtuella datorer och containrar.
Allmänt tillgängligt
generallyAvailable är standardlivscykeltillståndet för alla resurser. När en resurs är inaktuell kan du återställa den genom att ändra tillbaka egenskapen "lifecycleState" till "allmäntTillgänglig". Om du vill återställa en inaktuell produkt måste du publicera produkten för förhandsversionen och sedan live. Du hittar exempel för SaaS, virtuella datorer och containrar i respektive artiklar.
Exempelbegäran om en planåterställning:
I exemplet nedan är en plan avsedd att återställas. Om du vill tillämpa den här ändringen måste du senare publicera hela vägen till live med hjälp av överföringsresursen.
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"
}
]
}
Resurs-API-referens
Schemaversionerna nedan gäller endast för förhandsversioner och ändras när API:et blir allmänt tillgängligt.
Kommentar
Du kan visa befintliga tillgängliga resurser och deras versioner här: resources-index
| Resurstyp | Beskrivning | Schema |
|---|---|---|
| azure-test-drive-technical-configuration | Teknisk information som hjälper Microsofts kommersiella marknadsplats att ansluta till din testenhetslösning. | https://schema.mp.microsoft.com/schema/azure-test-drive-technical-configuration/2022-03-01-preview3 |
| commercial-marketplace-setup | Beskriver den transaktionsbara konfigurationen av produkter på den kommersiella marknadsplatsen. | https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2 |
| kundleads | Tillåter anslutning till ett CRM-system för att ta emot kundleas. | https://schema.mp.microsoft.com/schema/customer-leads/2022-03-01-preview3 |
| Lista | Detta inkluderar beskrivningarna av din produkt, som visas i Microsofts kommersiella marknadsplatsbutiker. | https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5 |
| listing-asset | Skärmbilder och dina marknadsföringstillgångar som är länkade till listresursen. | https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5 |
| listningstrailer | Videotillgångar som är länkade till listresursen. | https://schema.mp.microsoft.com/schema/listing-trailer/2022-03-01-preview5 |
| microsoft365-integration | Microsoft 365-aktivering och typval. | https://schema.mp.microsoft.com/schema/microsoft365-integration/2022-03-01-preview2 |
| Plan | För att skapa planer, som sedan refereras av de plannivåresurser som du konfigurerar, till exempel plan-listning. | https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2 |
| plan-listning | Definiera plannamnet och beskrivningen som du vill att de ska visas på den kommersiella marknadsplatsen. | https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5 |
| price-and-availability-custom-meter | Definiera de anpassade mätare som delas mellan dina planer. | https://schema.mp.microsoft.com/schema/price-and-availability-custom-meter/2022-03-01-preview3 |
| pris- och tillgänglighetserbjudande | Definiera en begränsad målgrupp som kan granska din produkt innan du publicerar den live. | https://schema.mp.microsoft.com/schema/price-and-availability-offer/2022-03-01-preview3 |
| pris- och tillgänglighetsplan | Konfigurera de marknader som planen är tillgänglig i, önskad intäktsmodell, pris och faktureringsvillkor. | https://schema.mp.microsoft.com/schema/price-and-availability-plan/2022-03-01-preview4 |
| price-and-availability-update-private-audiences | Uppdateringar till privata målgrupper i utkast-, förhandsversions- och livemiljöer kan utföras samtidigt utan att en publicering krävs. | https://schema.mp.microsoft.com/schema/price-and-availability-update-private-audiences/2022-03-01-preview3 |
| private-and-availability-private-offer-plan | Används för att konfigurera den absoluta prisinformationen för en produkt/plan-prissättning som används i ett privat erbjudande | https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2022-07-01 |
| privat erbjudande | Definierar namn och typ av privat erbjudande, med erbjudandets villkor och information, tillsammans med de produkter/abonnemang som ingår och deras priser | https://schema.mp.microsoft.com/schema/private-offer/2022-07-01 |
| Produkt | Det här är huvudresursen, definierar produktens namn och typ, alla resurser refererar till detta. | https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3 |
| Egenskapen | Definiera de kategorier och branscher som gäller för ditt erbjudande, din appversion och juridiska kontrakt. | https://schema.mp.microsoft.com/schema/property/2022-03-01-preview5 |
| Återförsäljare | Konfigurera partnerna i det Molnlösningsleverantör program (CSP) som du vill göra produkten tillgänglig för. | https://schema.mp.microsoft.com/schema/reseller/2022-03-01-preview2 |
| resource-tree | Beskriver produkten en lista över resurser för produkten i aktuellt tillstånd för den angivna målmiljön. | https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2 |
| software-as-a-service-technical-configuration | Teknisk information som hjälper Microsofts kommersiella marknadsplats att ansluta till din lösning. | https://schema.mp.microsoft.com/schema/software-as-a-service-technical-configuration/2022-03-01-preview3 |
| Inlämning | Kan användas för att utlösa olika åtgärder på produkten och ange publiceringstillståndet för dina produktoberoende miljöer (utkast, förhandsversion och live). | https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2 |
| Provköra | Definiera om du vill låta dina kunder prova produkten kostnadsfritt under en begränsad tid. | https://schema.mp.microsoft.com/schema/test-drive/2022-03-01-preview2 |
| test-drive-listing | Definiera information om hur kunder kan prova din produkt. | https://schema.mp.microsoft.com/schema/test-drive-listing/2022-03-01-preview3 |
| virtual-machine-plan-technical-configuration | Teknisk information som beskriver den virtuella datorn och avbildningsplatsen. | https://schema.mp.microsoft.com/schema/virtual-machine-plan-technical-configuration/2022-03-01-preview3 |
| virtual-machine-test-drive-technical-configuration | Teknisk information som hjälper Microsofts kommersiella marknadsplats att ansluta till din testenhetslösning. | https://schema.mp.microsoft.com/schema/virtual-machine-test-drive-technical-configuration/2022-03-01-preview2 |
| container-plan-technical-configuration | Teknisk information som beskriver egenskaperna för containeravbildningen. | https://schema.mp.microsoft.com/schema/container-plan-technical-configuration/2022-03-01-preview3 |
API-vägledning per produkttyp
API:et för produktinmatning kommer att göras tillgängligt för andra produkttyper i framtiden. I takt med att fler produkttyper stöds kommer mer vägledning som är specifik för varje produkttyp att göras tillgänglig.
| Produkttyp | Produkttypspecifika resurser |
|---|---|
| Privata erbjudanden | Skapa och hantera privata erbjudanden via API för produktinmatning |
| SaaS | Skapa och hantera SaaS-erbjudanden via API för produktinmatning |
| Virtuella datorer | Skapa och hantera erbjudanden för virtuella datorer via API för produktinmatning |
| Fraktbehållare | Skapa och hantera containererbjudanden via API för produktinmatning |
API-versioner och -uppdateringar
| Uppdatering | Vad har ändrats? |
|---|---|
| 11-2023 | Alla schemaslutpunkter har uppdaterats från product-ingestion.azureedge.net till schema.mp.microsoft.com |
| 12-2022 | En ny schemaversion 2022-03-01-preview3 av API:et PC Ingestion för kundleads är nu tillgänglig som accepterar clientID och clientSecret samtidigt som kundleads konfigureras och slutar samla in serverID- och kontakt-e-postfälten. Växla till den nya versionen och ange clientID och clientSecret för att fortsätta konfigurera Marketo-anslutningsappen för Marketplace-erbjudanden. Ny schema-URL: https://``schema.mp.microsoft.com``/schema/customer-leads/2022-03-01-preview3 |
| 09-2022 | Stöd för förhandsversion av containrar släpps som version 2022-03-01-preview4 |
| 08-2022 | Stöd för förhandsversion av programvara som en tjänst släpps som version 2022-03-01-preview3 |
| 08-2022 | Offentlig version av privat erbjudande som version 2022-07-01 |
| 05-2022 | Stöd för förhandsversion av virtuell dator släpps som version 2022-03-01-preview2 |
Nästa steg
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för