Product Ingestion API a kereskedelmi piactéren

Cikk
06/14/2024

A Product Ingestion API egy modernizált API, amely egyesíti az összes meglévő beküldési API-t az összes kereskedelmi piactéri termékben. Az API lehetővé teszi a termékekhez és csomagokhoz társított erőforrások létrehozását, közzétételét és kezelését a Partnerközpont-fiókban. Deklaratív mintát használ a kérelmek elküldéséhez, amelyben a kívánt állapot szerepel, szemben a kívánt állapot eléréséhez szükséges egyes lépések megadásával.

Ez a cikk útmutatást nyújt az API-k használatának megkezdéséhez bármely kereskedelmi piactéri ajánlattípushoz. A Product Ingestion API jelenleg saaS-, virtuális gépek , privát ajánlatok és tárolóajánlat-típusok esetében támogatott, és előzetes verzióban érhető el. Az ajánlatra vonatkozó útmutatásért tekintse át az API ajánlattípusonkénti útmutatóját.

Fontos

Az Azure Active Directory (Azure AD) Graph 2023. június 30-ától elavult. A továbbiakban nem teszünk további befektetéseket az Azure AD Graphban. Az Azure AD Graph API-k nem rendelkeznek SLA-val vagy karbantartási kötelezettségvállalással a biztonsággal kapcsolatos javításokon túl. Az új funkciókba és funkciókba csak a Microsoft Graph-ban lehet befektetni.

Az Azure AD Graphot növekményes lépésekben kivonjuk, hogy elegendő ideje legyen az alkalmazások Microsoft Graph API-kba való migrálására. Egy későbbi időpontban, amikor bejelentjük, letiltjuk az új alkalmazások létrehozását az Azure AD Graph használatával.

További információ: Fontos: Az Azure AD Graph kivonása és a PowerShell-modul elavulása.

Első lépések

A Product Ingestion API a "product-ingestion" nevű MSGraph API használatával érhető el. Az alap URL-cím a következő https://graph.microsoft.com/rp/product-ingestion: .

A Product Ingestion API használatához először be kell szereznie a következőket:

Microsoft Entra-azonosító, és győződjön meg arról, hogy globális rendszergazdai engedélyekkel rendelkezik a címtárhoz
Microsoft Entra-alkalmazás
Microsoft Entra hozzáférési jogkivonat

1. lépés: Előfeltételek teljesítése

Mielőtt elkezdené írni a Product Ingestion API meghívására szolgáló kódot, győződjön meg arról, hogy teljesítette az alábbi előfeltételeket.

Önnek (vagy a szervezetének) rendelkeznie kell egy Microsoft Entra-címtárral, és globális rendszergazdai engedéllyel kell rendelkeznie a címtárhoz. Ha már használja a Microsoft 365-öt vagy más üzleti szolgáltatásokat a Microsofttól, már rendelkezik a Microsoft Entra címtárral. Ellenkező esetben ingyenesen létrehozhat egy új Microsoft Entra-azonosítót a Partnerközpontban.
Microsoft Entra-alkalmazást kell társítania a Partnerközpont-fiókjához, és be kell szereznie a bérlőazonosítót, az ügyfél-azonosítót és a kulcsot. Ezekre szüksége van a Microsoft Entra hozzáférési jogkivonat beszerzéséhez, amelyet a Microsoft Store beküldési API-jának hívásaiban fog használni.

Microsoft Entra-alkalmazás társítása a Partnerközpont-fiókhoz

A Product Ingestion API használatához társítania kell egy Microsoft Entra-alkalmazást a Partnerközpont-fiókjával, le kell kérnie az alkalmazás bérlőazonosítóját és ügyfél-azonosítóját, és létre kell hoznia egy kulcsot. A Microsoft Entra alkalmazás azt az alkalmazást vagy szolgáltatást jelöli, amelyből a Product Ingestion API-t meg szeretné hívni. A Microsoft Entra hozzáférési jogkivonatának beszerzéséhez a bérlőazonosítóra, az ügyfélazonosítóra és a kulcsra van szüksége az API-nak való továbbításhoz.

Feljegyzés

Ezt a feladatot csak egyszer kell elvégeznie. Miután rendelkezik a bérlőazonosítóval, az ügyfélazonosítóval és a kulccsal, bármikor újra felhasználhatja őket, amikor új Microsoft Entra hozzáférési jogkivonatot kell létrehoznia.

A Partnerközpontban társítsa a szervezet Partnerközpont-fiókját a szervezet Microsoft Entra-címtárához.
A Partnerközpont Fiókbeállítások szakaszÁnak Felhasználók lapján adja hozzá azt a Microsoft Entra-alkalmazást, amely azt az alkalmazást vagy szolgáltatást jelöli, amelyet a Partnerközpont-fiókhoz tartozó beküldések eléréséhez használni fog. Győződjön meg arról, hogy ezt az alkalmazást a Manager szerepkörhöz rendeli. Ha az alkalmazás még nem létezik a Microsoft Entra címtárban, hozzon létre egy új Microsoft Entra-alkalmazást a Partnerközpontban. A Partnerközpont két típusú bejegyzést hoz létre az alkalmazáshoz az egyik szolgáltatásnévként, a másik pedig a Microsoft Entra alkalmazástípust.
Térjen vissza a Felhasználók lapra, válassza ki a Microsoft Entra-alkalmazás nevét az alkalmazásbeállítások eléréséhez, és másolja ki a bérlőazonosító és az ügyfélazonosító értékeit.
Válassza az Új kulcs hozzáadása lehetőséget. A következő képernyőn másolja ki a kulcs értékét. A lap elhagyása után nem fogja tudni újból elérni ezt az információt. További információ: Microsoft Entra-alkalmazások kulcsainak kezelése.

2. lépés: Microsoft Entra hozzáférési jogkivonat beszerzése

A Product Ingestion API bármely metódusának meghívásához először be kell szereznie egy Microsoft Entra hozzáférési jogkivonatot, amely az API egyes metódusainak engedélyezési fejlécére kerül. A hozzáférési jogkivonat a kiállítás után 60 perccel lejár. Ezt követően frissítheti, hogy az API későbbi hívásaiban is használhassa.

A hozzáférési jogkivonat beszerzéséhez kövesse a Szolgáltatásról szolgáltatásra irányuló hívások ügyfél-hitelesítő adatokkal történő beszerzésére vonatkozó utasításokat a https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token végpontra való küldéshezHTTP POST. Íme egy mintakérés:

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

A POST URI tenant_id értékéhez, valamint a client_id és client_secret paraméterekhez adja meg az előző szakaszban a Partnerközpontból lekért bérlőazonosítót, ügyfélazonosítót és az alkalmazás kulcsát. A hatókör paraméteréhez meg kell adnia https://graph.microsoft.com/.default.

Fogalmak

Az első lépések előtt meg kell ismernie néhány alapvető fogalmat.

Források

Az API erőforrástípusok köré épül fel, ahol az egyes típusokat a "$schema" tulajdonság által hivatkozott dedikált sémadefinícióval írják le. A séma az erőforrás konfigurációs tulajdonságaiból áll. Az erőforrások alapvető fontosságúak az adott termék különböző aspektusainak konfigurálásának létrehozásában és frissítésében. Az erőforrástípusok és sémáik teljes listáját a Resource API-referencia tartalmazza.

Tartós azonosító

A tartós azonosító egy rendszer által generált globális azonosító, amely minden erőforrás egyedi azonosítására szolgál. Minden erőforrás rendelkezik egy társított "ID" tulajdonsággal, amely az erőforrástípus nevével kombinálva az erőforrás tartós azonosítóját alkotja. A tartós azonosítót az erőforrások lekérésére vagy módosítására való hivatkozáskor használja a rendszer.

Formátum:

\<resource-type>/\<id>

Példa:

            { 
                "$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"
            }

Külső azonosító

A külső azonosító egy másik egyedi azonosító, amely adott termékekre vagy csomagokra hivatkozhat. Ez egy alternatív módszer arra, hogy ezeket az erőforrásokat a tartós azonosító használata helyett hivatkozzon ezekre az erőforrásokra. A termék külső azonosítója az "offerID"-ra, a terv külső azonosítója pedig a "planID"-ra lesz lefordítva az "identity" tulajdonság létrehozásakor meghatározottak szerint.

Példa:

            { 
                "$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-metódusok

Négy felügyeleti API használható különböző műveletek végrehajtására, például meglévő erőforrások lekérdezésére, konfigurációfrissítések elvégzésére és egy kérés állapotának ellenőrzésére.

Feljegyzés

Minden kéréshez be kell állítania a válasz részeként a kívánt sémaverziót ($version lekérdezési paramétert).

API-típus	Leírás	HTTP-metódus és elérési út
Lekérdezés	A meglévő erőforrások lekérése a következőkkel: -1. módszer: "resource-tree" erőforrástípus -2. módszer: a tartós azonosító -3. módszer: lekérdezési sztringparaméterek	-1. módszer: `GET resource-tree/<product-durableID>` -2. módszer: `GET <resource-durableID>` -3. módszer: `GET <resourceType>?<query parameters>`
Küldés konfigurálása	Kéréseket küld egy vagy több erőforrás létrehozásához vagy frissítéséhez. Sikeres feldolgozás esetén a rendszer egy feladatazonosítót ad vissza, amely a kérés állapotának lekérésére használható. Ez az API-típus használható a piszkozat állapotának frissítésére és a módosítások közzétételére, a privát célközönségek szinkronizálására és az erőforrás-életciklus állapotának módosítására.	`POST configure`
Állapot konfigurálása	Egy függőben lévő kérelem állapotát kéri le a jobID-en keresztül.	`GET configure/<jobID>/status`
Állapotadatok konfigurálása	Lekéri egy befejezett kérelem részletes összegzését, beleértve a frissített erőforrásokat is a feladatazonosítón keresztül.	`GET configure/<jobID>`
Konfigurálás megszakítása	Megszakítja a megadott konfigurálási feladatot.	`POST configure/<jobID>/cancel`

Egy tipikus munkafolyamat

Egy meglévő erőforrás frissítéséhez egy tipikus munkafolyamat a következő:

Meglévő erőforráskonfiguráció lekérése (API-típus: Lekérdezés erőforrásfán keresztül)*
Végezze el a szükséges frissítéseket, majd küldjön be egy konfigurációs kérelmet (API-típus: Küldés konfigurálása)
Ellenőrizze a kérés állapotát (API-típus: Állapot konfigurálása és állapotadatok konfigurálása)

* Ugyanez a munkafolyamat alkalmazható új erőforrások létrehozásakor, de az erőforrások beolvasása (1. lépés) helyett használja a Resource API referenciatábláját annak biztosítására, hogy az aktuális sémát használja a létrehozott erőforrástípushoz.

Összefoglalva, ez a kép a konfigurációs kérelem elküldéséhez használt tipikus hívási mintát mutatja, függetlenül attól, hogy új erőforrást hoz létre vagy módosít egy meglévő erőforrást.

A konfigurációs kérelem elküldéséhez használt tipikus hívási mintát bemutató képernyőkép.

Feljegyzés

Mindenképpen tekintse át a kezelt ajánlattípusra vonatkozó további előfeltételeket az ajánlattípusonkénti API-útmutatóra hivatkozva.

Meglévő erőforráskonfigurációk lekérése

A meglévő erőforrások frissítése előtt fontos, hogy először lekérje őket, hogy biztosan a legújabb konfigurációval rendelkezzen. Az erőforrásokat többféleképpen is lekérheti egy GET-hívással. Az alábbiakban részletezett 1. módszer segítségével egyetlen API-hívásban lekérheti egy adott termék összes erőforrását.

1. módszer: Erőforrásfa

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

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

Egy adott termék összes erőforrás-konfigurációját lekérheti az "erőforrásfa" erőforrástípussal és a termék tartós azonosítójával.

Az elérhető legújabb sémaverzió minden erőforrás esetében eltérő lehet. Erőforrásfa-kérés végrehajtásakor a megadott sémaverzió határozza meg, hogy a rendszer melyik verziót adja vissza a termék minden erőforrásához. A megadott verzió "maximális" verziókorlátként szolgál, mivel a legújabb sémaverziót adja vissza, amely az összes azonos vagy alacsonyabb verziójú erőforráshoz elérhető. Ha például a legújabb elérhető csomaglistás verzió a "2022-03-01-preview3", a válasz ezt a verziót fogja felszínre helyezni, ha a "2022-03-01-preview5" értéket szeretné megadni az erőforrásfa GET kérésében. Ha azonban erőforrásfa-verzióként a "2022-03-01-preview2" kérést kéri, ez a "2022-03-01-preview2" csomagot fogja visszaadni, annak ellenére, hogy a legújabb elérhető verzió a "2022-03-01-preview3". Javasoljuk, hogy az egyes erőforrások legújabb elérhető verzióját használja annak érdekében, hogy a frissített sémát újonnan támogatott funkciókkal használja.

Feljegyzés

Ha nem ismeri a termék tartós azonosítóját, a termék külső azonosítójával lekérheti a termék erőforrását a futtatássalGET product?externalID=<product-externalID>&$version=<product-schema-version>. Ez a kérés egy lekérdezési sztringparamétert használ, amelyet az alábbi 3. módszer részletez. A válasz tartalmazza a termék tartós azonosítóját, amelyet a jövőbeli kérésekhez használhat.

Alapértelmezés szerint ha get hívást futtat az "erőforrásfa" használatával, az erőforrások piszkozatverzióját kapja vissza. A "targetType" lekérdezési paraméter átadásával azonban megadhatja a kívánt célértéket az "előnézet" vagy az "élő" adatok lekéréséhez. Az alábbi példában a GET hívás a "12345678-abcd-efgh-1234-12345678901" termékben szereplő összes erőforrás előzetes környezetének konfigurációját adja vissza.

Get-mintahívás:

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

Mintaválasz:

        {
          "$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.
          {
              ...
          }]
        }

2. módszer: Tartós azonosító

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

Egy adott erőforrás lekérése a tartós azonosítójával. Az erőforrás létrehozása után a tartós azonosító mindig ugyanaz marad, és a GET metódus meghívásával lekérheti az erőforrás legújabb piszkozatmódosításait. A következő kérés például a "2022-03-01-preview3" sémaverzióval adja vissza az adott termék vázlatkonfigurációját.

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

Fontos

Ez a módszer csak a vázlatkonfiguráció lekérésére használható. Ha előnézeti vagy élő adatokat szeretne lekérni, használja az "erőforrásfa" metódust a fent leírtak szerint.

Az erőforrások tartós azonosítójának megkereséséhez a következőkre van lehetőség:

Az "erőforrásfa" metódussal lekérheti a terméken belüli összes erőforrást az egyes tartós azonosítókkal együtt, vagy
Kérje le egy befejezett erőforráskonfigurációs kérelem részleteit, amely tartalmazza a kérelem részeként létrehozott vagy frissített összes erőforrás tartós azonosítóit.

Ne feledje, hogy az "ID" tulajdonság a megfelelő erőforrás tartós azonosítója.

3. módszer: Lekérdezési sztringparaméterek

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

Ez a módszer egy adott fiókhoz társított egyes erőforrástípusok lekérdezésére szolgál. Lekérheti például egy adott terméktípus összes termékét egyetlen GET hívással. A lekérdezési sztringparaméterek a termékekre, tervekre vagy beküldésekre vonatkozó adatok lekérdezésére szolgálnak.

Ez a táblázat a támogatott erőforrástípusok támogatott lekérdezési paramétereit mutatja be. Nem minden erőforrástípus támogatja az egyes lekérdezési paramétereket. Tekintse meg ezt a táblázatot a jelenleg támogatott lekérdezési sztringek teljes listájához.

Erőforrás típusa	Paraméterek	Példa lekérdezési sztringekre
terv	termék`` 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>`
termék	externalID típus $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>`
meghódolás	targetType $maxpagesize continuationToken$version`*`	`GET submission/<product-durableID>?targetType=<environment>&$version=<schema-version>` `GET submission/<product-id>?$maxpagesize=<#>&continuationToken=<token>&$version=<schema-version>`
erőforrásfa	targetType$-verzió`*`	`GET resource-tree/<product-durableID>?targetType=<environment>&$version=<schema-version>`

* A termékre és $version paraméterekre mindig szükség van.

A támogatott lekérdezési paraméterek funkciói:

product – Amikor a "termék" paramétert a "terv" erőforrástípus kontextusában adja át, az adott terméken belüli összes csomagot visszaadja.
externalID – Ha egy termék vagy terv kontextusában adja át az "externalID" paramétert, az az adott termék vagy terv konfigurációját adja vissza. Az "erőforrásfa" metódustól eltérően ez a lekérdezési sztring paraméter csak az adott erőforrás részleteit adja vissza, nem az összes erőforrást.
típus – Amikor a "type" paramétert a "termék" erőforrástípus kontextusában adja át, a fiókhoz társított összes ilyen típusú terméket visszaadja. Például a "type=softwareAsAService" megadásával a rendszer az összes SaaS-terméket visszaadja.
targetType – Ez egy adott környezet adatait adja vissza a használt erőforrástípus kontextusában. A támogatott "targetType" értékek a "piszkozat", az "előzetes verzió" vagy az "élő".
$maxpagesize – A maximális oldalméret megadásával, pozitív egész szám formájában ez a paraméter korlátozza a keresés eredményeit a korábbi beküldések lekérdezése során.
continuationToken – Ez a paraméter a "$maxpagesize" paraméterrel használható a keresésben elérhető találatok egy másik készletének lekérdezéséhez. A "continuationToken" érték az előző oldal válaszában van megadva.
$version – Ez minden híváshoz kötelező paraméter, amely meghatározza, hogy milyen sémaverziót szeretne használni a kérés által adott válaszhoz. A legújabb elérhető sémaverzió minden erőforrás esetében eltérő lehet, és a megadott verzió "maximális" verziókorlátként szolgál. A rendszer vagy a pontos sémaverziót adja vissza, ha elérhető, vagy a legközelebbi verziót, amely régebbi a kért verziónál. Ez segíthet fenntartani a kód működését még akkor is, ha újabb sémamódosítások történnek, de a legújabb funkciók használatához ajánlott az egyes sémák legújabb elérhető verzióját használni.

A beküldések lekérdezése

A meglévő termékbeküldéseket a művelet elvégzésével GET submission/<product-durableID>is lekérheti. Alapértelmezés szerint az összes aktív beküldést visszakapja, beleértve a piszkozathivatkozást is, de egy adott környezetet is lekérdezhet a "targetType" lekérdezési paraméterrel: (GET submission/<product-durableID>?targetType=<environment>&$version=<version>).

Fontos

Az "Előzetes verzió" elküldése után a rendszer lecseréli az előző "Élő" beküldést. Ha ez történik, az adatok mostantól az "Előzetes verzió" és az "Élő" környezeteket is képviselik, amíg egy új beküldést nem tesznek közzé az "Előzetes verzióban".

Mintakérés:

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

Mintaválasz:

Ez a példa a "123456778-abcd-efgh-1234-12345678901" termékazonosítóhoz társított aktív beküldésekre vonatkozó GET kérelmet mutat be. Az aktív "Élő" beküldés (submission/12345678-abcd-efgh-1234-12345678901/1152921515689847470) először előzetes verzióban, majd később élőben jelent meg. Amikor ezt a beküldést 2022. január 25-én élőben küldték el, az előnézetet és az élő verziót is képviselte, amíg 2022. február 4-én létre nem jött egy új előzetes beküldés (submission/123456778901/1152921515689848683).

            {
              "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"
                }
              ]
            }

Új termékek és erőforrások létrehozása

Egyetlen konfigurációs kérelem részeként létrehozhat új erőforrásokat, beleértve az új termékeket is. A Resource API referenciatáblájának használatával lekérheti a létrehozni kívánt erőforrástípus sémáját. Ez biztosítja, hogy a legújabb sémát használja, ezért konfigurálja az erőforrás létrehozásához szükséges összes tulajdonságot.

Ha új terméket hoz létre, a követelmények terméktípusonként változnak. Ezért különböző erőforrásokat kell megadnia. Hivatkozhat a megfelelő terméktípushoz tartozó kereskedelmi piactér dokumentációra, hogy biztosan konfigurálja a kérés alapvető követelményeit. Másik lehetőségként létrehozhat egy konfigurációs kérelmet csak a termékerőforrás használatával. A termék létrehozása után hívja meg a konfigurálási állapotadatok API-t a létrehozott termékerőforrás lekéréséhez, és keresse meg annak tartós azonosítóját az erőforrásfa lekérdezési API meghívásához. A válasz a létrehozott terméktípusra vonatkozó támogatott erőforrásokat adja vissza.

Hasonlóképpen, ha új erőforrást szeretne létrehozni egy meglévő termékben, le kell kérnie az adott erőforrástípus legújabb sémáját is. Győződjön meg arról, hogy a konfigurációs kérelem részeként megadja a függő erőforrásokat az erőforrás-függőségek áttekintésével.

Miután a sémák használatával konfigurálta az erőforrásokat, megtudhatja, hogyan készíthet konfigurációs kérést.

Meglévő termékek és erőforrások módosítása

A frissítéseket a hasznos adatok konfigurálásával küldheti el. Ez a hasznos adat egy vagy több erőforrástípusból áll, a "$schema" tulajdonság pedig a hivatkozott erőforrástípust jelzi.

Tipp.

Javasoljuk, hogy a frissítések közzététele előtt először kérje le a meglévő erőforrásokat, hogy a legújabb konfigurációt használja.

Az erőforrások módosítása után megtudhatja, hogyan végezhet konfigurációs kérést.

Konfigurációs kérelmek

Ugyanabban a hasznos adatban szerkesztheti és teheti közzé. Konfigurációs kérés elküldéséhez használja a konfigurálási API HTTP POST metódusát. A konfigurált hasznos adat egy erőforrástömbből áll, amely a kívánt módosításokat jelzi. Az összes módosítás csak a piszkozatverziót érinti, amíg explicit módon nem küld be egy beküldési erőforrást a piszkozatok közzétételéhez. Az előzetes verzióban vagy élőben történő közzétételkor adja meg a beküldési erőforrást , és adja meg a célkörnyezetet. A kérés elküldése előtt tudnia kell, hogyan hivatkozhat az erőforrásokra, és meg kell ismernie a függőségeiket.

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

A konfigurációs kérelem elküldésekor egy konfigurálási állapotobjektumot kap vissza azzal a feladatazonosítóval, amellyel nyomon követheti a kérés előrehaladását és eredményeit .

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

Erőforráshivatkozások és függőségek

Hivatkozások

Ha egy konfigurálási kérelemben meglévő erőforrásra szeretne hivatkozni, adja meg az erőforrás "$schema" típusát az erőforrás tartós azonosítójával együtt. Termékek és csomagok esetén ezekre az erőforrásokra a külső azonosítójukon keresztül is hivatkozhat.

A tartós azonosító az "ID" tulajdonságban található, például ha egy másik erőforrásban hivatkozni szeretnénk erre a termékerőforrásra:

            { 
                "$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"
            }

A tartós azonosító a következő lenne: "product/071b135e-9faf-4ff7-b113-a3f25bb0f468".

A tartós azonosító ezután az alábbi listaerőforrás-példában használható a "product" erőforrásséma tulajdonságban az alábbihoz hasonló beállítással:

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

A termék- és terverőforrások külső azonosítója az "identity" tulajdonságban van definiálva.

            {
                "$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",
                  ...
              }

A "gold-annual" külső azonosítójú tervre ezután más további források is hivatkozhatnak a következő formátumban:

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

Mintakérés:

Ebben a példában a konfigurált hasznos adat egy új SaaS-termék létrehozására szolgál a "ds-contoso-image-resize-demo" külső azonosítójával. A termék létrehozása után később hivatkozhat a termékre tartós azonosítójával vagy külső azonosítójával.

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"
              }
              ]
            }

Mintaválasz:

            {
  "$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": []
}

Ezután az Állapot konfigurálása API-val ellenőrizheti a kérés állapotát a jobID használatával.

Függőségek

Bizonyos erőforrások előfeltételeként függőségek vannak egy másik erőforrás létrehozásához. Ebben a helyzetben a "resourceName" tulajdonságot használjuk ugyanazon a hasznos adaton belül a termékerőforrás függőségének jelölésére a terverőforrásban, mivel mindkettőt ugyanabban a kérelemben hozjuk létre.

A "resourceName" csak az egyes erőforrások azonosítására szolgál a konfigurálási kérelem részeként. Az érték nem lesz része az erőforrások adatainak, nem lesz tárolva, és az ügyfelek számára sem lesz elérhető. Ha a konfigurálási kérelem részeként hibák lépnek fel, a rendszer a "resourceName" nevet használja annak az erőforrásnak a meghívásához, amelyhez a hiba tartozik.

Mintakérés:

Ebben a példában a terméket a terv előtt kell létrehozni, ezért a rendszer a resourceName tulajdonságot használja. A létrehozandó termék , a "myNewProduct" a "resourceName" kifejezéshez használt és a függő terverőforrásban hivatkozott érték lesz.

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"}
                  ...
              }, 
              }]
            }

Beküldési erőforrás

Ha "előzetes verzióban" vagy "élőben" teszi közzé a közzétételt, vegye fel a kérelembe a beküldési erőforrást, amely a következőket tartalmazza:

A "product" tulajdonság, amely azt jelöli, hogy a termék a tartós azonosító vagy külső azonosító alapján frissül
A célkörnyezetet denotáló "targetType" tulajdonság

Ha kifejezetten élő közzétételt tesz közzé, a közzétenni kívánt előzetes beküldés "azonosítója" a következő:

              {
                "$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" }
              }

Feljegyzés

Ha nem tartalmazza a beküldési erőforrást, a módosítások csak a piszkozat állapotában lesznek.

Közzététel előzetes verzióban

A kereskedelmi terméktípusok támogatják az előzetes verziójú környezetet, és minden frissítést először közzé kell tenni az előzetes verzióban, mielőtt élőben megjelennek. Nem tehet közzé közvetlenül élőben.

Fontos

Ez alól kivételt képeznek a tervek privát közönségének módosításakor. Ha a frissítéseket külön szinkronizálja a privát közönségnek , ezek a módosítások egyszerre propagálódnak az előzetes verzióban és az élőben is.

Az erőforrások kétféleképpen tehetők közzé az előzetes verziójú környezetben. Ha bármilyen módosítást kell végrehajtania az előzetes beküldésen, végezze el az újabb GET kérést, végezze el a szükséges módosításokat, és küldje el újra a módosításokat. Nem kell először élőben használnia a kezdeti módosításokat.

1. módszer: Az összes piszkozaterőforrás közzététele

Ha minden elvégzett piszkozatmódosítást közzé szeretne tenni, elküldhet egy konfigurálási kérelmet egy beküldési erőforrással, amely az előnézeti környezetet "targetType"-ként állítja be. Ahogyan az alábbi példában látható, nem kell minden olyan erőforrást explicit módon megadnia, amely frissítést igényel, mivel ez a módszer közzéteszi a célkörnyezet összes módosítását, amely ebben az esetben előzetes verzió. Csak a konfigurálási API-végpontot és a beküldési erőforrást kell megadnia.

Mintakérés:

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" }
              }
              ]
            }

2. módszer: Adott vázlaterőforrások közzététele (más néven moduláris közzététel)

Ha nem áll készen arra, hogy az összes módosítástervezetet közzétegye a különböző erőforrások között, csak adja meg a közzétenni kívánt erőforrásokat a beküldési erőforrással együtt a moduláris közzététel aktiválásához. Ezzel a megközelítéssel módosíthatja az erőforrásokat, és egyidejűleg közzéteheti őket a tömeges frissítés helyett, ahogyan az 1. módszerrel történik. A moduláris közzétételhez minden erőforrásra szükség van, kivéve a termékszintű adatokat (például lista, rendelkezésre állás, csomagok, viszonteladó) a terméktípusra vonatkozóan.

Mintakérés:

Ebben a példában a termék erőforrásai kifejezetten a moduláris közzététel, majd a beküldési erőforrás részeként jelennek meg.

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" }
              }
              ]
            }

Közzététel élőben

Miután tesztelte és ellenőrizte a módosításokat az előzetes verzióban, elküldheti a módosításokat élőben, ha elküld egy konfigurálási kérést az előnézeti beküldés azonosítójával, a "targetType" pedig "élő" értékre van állítva. Ha meg szeretné keresni az előnézeti beküldés azonosítóját, hogy belefoglaljon a konfigurálási kérelembe, olvassa el a beküldések lekérdezése című témakört.

Fontos

Az előzetes verzióban való közzétételtől eltérően nem lehet moduláris közzétételt végezni élő közzétételkor. Ezért fontos meggyőződni arról, hogy ellenőrizte az előzetes beküldést, mielőtt élőben szeretné elvégezni a módosításokat.

Mintakérés:

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" }
              }
              ]
            }

Kérés állapotának ellenőrzése

A konfigurálási kérelemben szereplő erőforrásoktól vagy a végrehajtott módosításoktól függetlenül röviddel a kérelem sikeres feldolgozása után vissza fog kapni egy konfigurálási állapotobjektumot a válaszban. A "jobID" fontos, mivel később a kérés állapotának ellenőrzésére használható.

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

Mintaválasz egy elküldött kérelemre:

            {
                "$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": []
            }

Függőben lévő kérelem állapota

Az állapotot lekérheti, amíg a feladat be nem fejeződik a következő hívással, és beírja a kérés "jobID" azonosítóját. Az objektum hibalistát is tartalmazhat, ha bármilyen probléma merült fel a kéréssel kapcsolatban.

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

Ne feledje, hogy a befejezési idő a kérés összetettségétől függően változhat,

Befejezett kérelem összegzése

Ha egy konfigurálási kérelemfeladat sikeresen vagy sikertelenül befejeződött, lekérheti a "jobID" használatával létrehozott vagy frissített erőforrások listáját.

Feljegyzés

Ha ezt a hívást a feladat befejezése előtt kezdeményezi, az sikertelen lesz. Emellett csak a sikeresen befejezett erőforrásokat adja vissza, illetve lemondás esetén csak a lemondás előtt befejezett erőforrásokat.

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

Mintakérés:

Az alábbi példában egy GET kérést használunk az új SaaS-terméket létrehozó korábbi példában használt konfigurálási kérelem összegző adatainak lekérésére. A válasz az a konfigurálási részletes objektum, amely tartalmazza a létrehozott termékerőforrást és annak tartós azonosítóját tartalmazó erőforrástömböt.

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

Mintaválasz:

            {
"$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"
              }
]
}

Konfigurációs kérés lemondása

A feladat befejezése előtt szükség esetén megpróbálhatja megszakítani. A hosszú ideig futó kérések, például az "előzetes verzióban" vagy az "élőben" való közzététel esetén a lemondási kérés elutasítható, ha a feladat elég messze van a teljes feldolgozás során.

Egy feladat megszakításához hozzon létre egy POST-hívást a megszakítási végponthoz, és adja meg a megszakítani kívánt kérés feladatazonosítóját.

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

Mintakérés:

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

Egy sikeres lemondási kérelem mintaválasza:

            {
                "$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": []
            }

Mintaválasz arra az esetre, ha a lemondás nem engedélyezett: HTTP Status code: 400

Tartalom:

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

Fontos

Ne feledje, hogy a lemondás csak azokra az erőforrásokra vonatkozik, amelyeket még nem dolgoztak fel. Előfordulhat, hogy egyes erőforrások már befejezték a feldolgozást, és a kérés lemondása ellenére is tükrözik a legújabb konfigurációs frissítéseket.

A lemondás után lekérheti a konfigurálási kérelem összegzését annak ellenőrzéséhez, hogy mely erőforrásokat (ha vannak ilyenek) már feldolgozták a lemondás előtt.

Privát célközönségek szinkronizálása

Élő termék esetén a piszkozatban, az előzetes verzióban és az élő környezetben lévő privát közönség frissítései egyszerre, közzététel nélkül is elvégezhetők. A privát célközönséget a "price-and-availability-update-private-audiences" erőforrással szinkronizálhatja, ha megadja, hogy mely célközönségeket szeretné hozzáadni vagy eltávolítani egy adott tervből. Ez szinkronizálja a piszkozatot, az előnézetet és az élő környezeteket, hogy ugyanazokkal a privát közönségértékekkel rendelkezzen. A privát közönség szinkronizálásakor nem kell megadnia a beküldési erőforrást.

A célközönségek vázlatának szerkesztéséhez használja a "price-and-availability-plan" erőforrást és a "privateAudiences" tulajdonságot. Ennek végig kell mennie a normál közzétételi folyamaton, hogy az értékek előnézetben és élőben legyenek beállítva.

Fontos

A támogatott célközönségtípusok az "előfizetés", az "ea", az "msdn" és a "bérlő", de ezek támogatása terméktípusonként eltérő. Ha a termék több azonosítótípust is támogat a privát célközönség konfigurálásához (például bérlőazonosítókat és előfizetés-azonosítókat egyaránt), teljes közzétételt kell végrehajtania, ha először ad meg új azonosítótípust. Ebben az esetben nem szinkronizálhatja a privát közönséget.

Mintakérés a privát célközönség konfigurációjának szinkronizálásához:

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"
                }
              ]
            }
          }
          ]
        }

Érdeklődők kezelésének konfigurálása

Csatlakoztassa az ügyfélkapcsolat-kezelő (CRM) rendszert a kereskedelmi piactéri termékhez, hogy megkapja az ügyfél kapcsolattartási adatait, amikor egy ügyfél érdeklődést jelez vagy üzembe helyezi a terméket. Ezt a kapcsolatot bármikor módosíthatja a termék létrehozása során vagy után. További információ: Ügyfél-érdeklődők lekérése.

Mintakérés az érdeklődők felügyeletének konfigurálásához:

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"
            }
          }  
          ]
        }

Erőforrás-életciklus állapotai

Ezt a térképet különböző műveletek is végrehajthatják egy erőforrás életciklus-állapotára. Nem minden erőforrás rendelkezik életciklus-állapottal, és nem minden életciklus-állapotot támogat az összes erőforrás. Annak megállapításához, hogy egy erőforrás rendelkezik-e életciklus-állapottal, és mely értékek támogatottak, ellenőrizheti az erőforrásséma "lifecycleState" tulajdonság meglétét. A különböző támogatott életciklus-állapotokat alább találja.

Törölve

Bizonyos erőforrások törléséhez frissítse az "lifecycleState" tulajdonságot "törölt" értékre. Csak olyan piszkozaterőforrásokat törölhet, amelyek még nem lettek közzétéve. Ez a művelet nem vonható vissza.

Mintakérés:

Az alábbi példában az "alapszintű" vázlatterv törlődik.

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"
            }
          ]
        }

Elavult

Az elavulás eltávolítja az erőforrást a kereskedelmi piactérről. Az elavultság megszüntetéséhez állítsa az "életciklusState" tulajdonságot "elavultra" az azt támogató erőforrásokon. Az elavulásnak különböző szintjei vannak. Minden terméktípus támogatja a teljes termék és a benne lévő egyéni csomagok elavulttá tévő elavulását. Ha később vissza szeretne állítani egy elavult erőforrást, tekintse meg az "általánosan elérhető" életciklus-állapotot.

Termékavulás mintakérelmét:

Az alábbi példában a termék élő beküldése elavultra van állítva. A módosítás alkalmazása után a rendszer automatikusan közzéteszi a módosítást, hogy életbe lépjen.

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"
                }
              ]
            }

A tervek elavultsága esetén az "életciklusState" tulajdonságot "elavultra" kell módosítani, majd a módosításokat közzé kell tenni az "előzetes verzióban", majd az "élőben" az elavulás érvénybe lépéséhez. Ez eltér a termékszintű elavulástól, amelyben az elavulás automatikusan konfigurálva lesz az élő környezetben.

Terv elavulásának mintakérelmét:

Az alábbi példában egy SaaS-terméken belüli terv elavultra van beállítva. Ne feledje, hogy a módosítás alkalmazásához később közzéteheti a beküldési erőforrást.

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"
                }
              ]
            }

A termék típusától függően más elavulási formák is léteznek. További információ az SaaS, a virtuális gépek és a tárolók elavulásáról.

Általánosan elérhető

generallyAvailable az összes erőforrás alapértelmezett életciklus-állapota. Ha egy erőforrás elavult, visszaállíthatja azt az "életciklusState" tulajdonság "általánosAvailable" értékre való visszaállításával. Az elavult termék visszaállításához közzé kell tennie a terméket az előzetes verzióban, majd élőben. Az SaaS-hez, virtuális gépekhez és tárolókhoz a megfelelő cikkekben találhat példákat.

Mintakérelem egy terv visszaállításáról:

Az alábbi példában egy terv visszaállítására szolgál. A módosítás alkalmazásához később közzé kell tennie a beküldési erőforrással való élő élethez szükséges összes lehetőséget.

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"
                }
              ]
            }

Resource API-referencia

Az alábbi sémaverziók csak előzetes verzióban érhetők el, és az API általános elérhetővé válása után módosulnak.

Feljegyzés

A meglévő elérhető erőforrásokat és azok verzióit itt tekintheti meg: resources-index

Erőforrás típusa	Leírás	Séma
azure-test-drive-technical-configuration	Technikai részletek, amelyek segítenek a Microsoft kereskedelmi piactérnek csatlakozni a tesztmeghajtó megoldásához.	https://schema.mp.microsoft.com/schema/azure-test-drive-technical-configuration/2022-03-01-preview3
kereskedelmi piactér beállítása	A kereskedelmi piactéren lévő termékek végrehajtható konfigurációját ismerteti.	https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2
ügyfél-érdeklődők	Lehetővé teszi a CRM-rendszerhez való csatlakozást az ügyfelek érdeklődőinek fogadásához.	https://schema.mp.microsoft.com/schema/customer-leads/2022-03-01-preview3
szövetszegély	Ez magában foglalja a termék leírását, amely a Microsoft kereskedelmi piactéri áruházaiban jelenik meg.	https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5
listing-asset	Képernyőképek és a listaerőforráshoz társított marketingeszközök.	https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5
listing-trailer	A listaerőforráshoz társított videoeszközök.	https://schema.mp.microsoft.com/schema/listing-trailer/2022-03-01-preview5
microsoft365-integráció	Microsoft 365-engedélyezés és típusválasztás.	https://schema.mp.microsoft.com/schema/microsoft365-integration/2022-03-01-preview2
terv	Tervek létrehozásához, amelyekre ezután hivatkozni fognak a konfigurált tervszintű erőforrások, például a tervlista.	https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2
tervlista	Adja meg a terv nevét és leírását, ahogyan azt szeretné, hogy megjelenjenek a kereskedelmi piactéren.	https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5
ár- és rendelkezésre állás-egyéni mérő	Határozza meg a csomagokban megosztott egyéni mérőket.	https://schema.mp.microsoft.com/schema/price-and-availability-custom-meter/2022-03-01-preview3
ár- és rendelkezésre állási ajánlat	Definiáljon egy korlátozott célközönséget, aki élő közzététel előtt áttekintheti a terméket.	https://schema.mp.microsoft.com/schema/price-and-availability-offer/2022-03-01-preview3
ár- és rendelkezésre állási terv	Konfigurálja a csomagot elérhető piacokat, a kívánt bevételezési modellt, árat és számlázási feltételeket.	https://schema.mp.microsoft.com/schema/price-and-availability-plan/2022-03-01-preview4
price-and-availability-update-private-audiences	A piszkozatban, az előzetes verzióban és az élő környezetekben lévő privát célközönségek frissítései egyszerre, közzététel nélkül is elvégezhetők.	https://schema.mp.microsoft.com/schema/price-and-availability-update-private-audiences/2022-03-01-preview3
private-and-availability-private-offer-plan	A magánajánlatban használt termék/csomag díjszabásának abszolút díjszabási részleteinek konfigurálására szolgál	https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2022-07-01
privát ajánlat	Meghatározza a magánajánlat nevét és típusát, az ajánlat feltételeit és részleteit, valamint a benne foglalt termékeket/csomagokat és azok díjszabását	https://schema.mp.microsoft.com/schema/private-offer/2022-07-01
termék	Ez a fő erőforrás, meghatározza a termék nevét és típusát, erre minden erőforrás hivatkozik.	https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3
ingatlan	Határozza meg az ajánlatra, az alkalmazás verziójára és a jogi szerződésekre vonatkozó kategóriákat és iparágakat.	https://schema.mp.microsoft.com/schema/property/2022-03-01-preview5
viszonteladó	Konfigurálja a Felhőszolgáltató (CSP) programban szereplő partnereket, akik számára elérhetővé szeretné tenni a terméket.	https://schema.mp.microsoft.com/schema/reseller/2022-03-01-preview2
erőforrásfa	A termék leírása az adott termék erőforrásainak listája a megadott célkörnyezet aktuális állapotában.	https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2
szoftver-mint-a-service-technical-configuration	Technikai részletek, amelyek segítenek a Microsoft kereskedelmi piactérnek a megoldáshoz való csatlakozásban.	https://schema.mp.microsoft.com/schema/software-as-a-service-technical-configuration/2022-03-01-preview3
meghódolás	Különböző műveleteket indíthat el a terméken, és jelezheti a termék közömbös környezeteinek közzétételi állapotát (piszkozat, előzetes verzió és élő).	https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2
tesztmeghajtó	Határozza meg, hogy szeretné-e, hogy az ügyfelek korlátozott ideig ingyenesen kipróbálják a terméket.	https://schema.mp.microsoft.com/schema/test-drive/2022-03-01-preview2
tesztmeghajtó-lista	Adja meg, hogy az ügyfelek hogyan próbálhatják ki a terméket.	https://schema.mp.microsoft.com/schema/test-drive-listing/2022-03-01-preview3
virtual-machine-plan-technical-configuration	A virtuális gépet és a kép helyét leíró technikai részletek.	https://schema.mp.microsoft.com/schema/virtual-machine-plan-technical-configuration/2022-03-01-preview3
virtual-machine-test-drive-technical-configuration	Technikai részletek, amelyek segítenek a Microsoft kereskedelmi piactérnek csatlakozni a tesztmeghajtó megoldásához.	https://schema.mp.microsoft.com/schema/virtual-machine-test-drive-technical-configuration/2022-03-01-preview2
container-plan-technical-configuration	A tárolórendszerkép tulajdonságait leíró technikai részletek.	https://schema.mp.microsoft.com/schema/container-plan-technical-configuration/2022-03-01-preview3

API-útmutató terméktípusonként

A Product Ingestion API a jövőben más terméktípusok számára is elérhetővé válik. Mivel több terméktípus támogatott, az egyes terméktípusokra vonatkozó további útmutatás is elérhetővé válik.

Termék típusa	Terméktípus-specifikus erőforrások
Privát ajánlatok	Privát ajánlatok létrehozása és kezelése a Product Ingestion API-val
SaaS	SaaS-ajánlatok létrehozása és kezelése a Product Ingestion API-val
Virtuális gépek	Virtuálisgép-ajánlatok létrehozása és kezelése a Product Ingestion API-val
Containers	Tárolóajánlatok létrehozása és kezelése a Product Ingestion API-val

API-verziók és -frissítések

Frissítés	Mi változott?
11-2023	Az összes sémavégpont frissült product-ingestion.azureedge.net-ről schema.mp.microsoft.com
12-2022	A PC Ingestion API 2022-03-01-preview3 új sémaverziója már elérhető az ügyfelek érdeklődői számára, amely elfogadja az ügyfélazonosítót és a clientSecretet, miközben konfigurálja az ügyfél-érdeklődőket, és leállítja a kiszolgálóazonosító és a kapcsolatfelvételi e-mail mezők rögzítését. Váltson az új verzióra, és adja meg az ügyfélazonosítót és a clientSecretet a Marketo-összekötő marketplace-ajánlatokhoz való konfigurálásához. Új séma URL-címe: https://``schema.mp.microsoft.com``/schema/customer-leads/2022-03-01-preview3
09-2022	A tároló előzetes verziója 2022-03-01-preview4 verzióként jelenik meg
08-2022	A szoftver mint szolgáltatás előzetes verzió támogatása a 2022-03-01-preview3 verzióban jelenik meg
08-2022	Nyilvános nyilvános nyilvános kiadás 2022-07-01-es verzióként
05-2022	A virtuális gépek előzetes verziójának támogatása a 2022-03-01-preview2 verzióban jelenik meg

Megosztás a következőn keresztül:

Product Ingestion API a kereskedelmi piactéren

Első lépések

1. lépés: Előfeltételek teljesítése

Microsoft Entra-alkalmazás társítása a Partnerközpont-fiókhoz

2. lépés: Microsoft Entra hozzáférési jogkivonat beszerzése

Fogalmak

Források

Tartós azonosító

Külső azonosító

API-metódusok

Egy tipikus munkafolyamat

Meglévő erőforráskonfigurációk lekérése

1. módszer: Erőforrásfa

2. módszer: Tartós azonosító

3. módszer: Lekérdezési sztringparaméterek

A beküldések lekérdezése

Új termékek és erőforrások létrehozása

Meglévő termékek és erőforrások módosítása

Konfigurációs kérelmek

Erőforráshivatkozások és függőségek

Hivatkozások

Függőségek

Beküldési erőforrás

Közzététel előzetes verzióban

1. módszer: Az összes piszkozaterőforrás közzététele

2. módszer: Adott vázlaterőforrások közzététele (más néven moduláris közzététel)

Közzététel élőben

Kérés állapotának ellenőrzése

Függőben lévő kérelem állapota

Befejezett kérelem összegzése

Konfigurációs kérés lemondása

Privát célközönségek szinkronizálása

Érdeklődők kezelésének konfigurálása

Erőforrás-életciklus állapotai

Törölve

Elavult

Általánosan elérhető

Resource API-referencia

API-útmutató terméktípusonként

API-verziók és -frissítések

Következő lépések

Visszajelzés

Visszajelzés

További források