Poznámka
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Rozhraní API pro zadávání produktů je modernizované rozhraní API, které sjednocuje všechna existující rozhraní API pro odesílání napříč všemi produkty komerčního tržiště. Rozhraní API umožňuje vytvářet, publikovat a spravovat prostředky přidružené k produktům a plánům v rámci vašeho účtu v Partnerském centru. Používá deklarativní vzor k odesílání požadavků, ve kterém je požadovaný stav označen jako rozdíl od určení jednotlivých kroků pro dosažení požadovaného stavu.
Tento článek obsahuje pokyny, jak začít s rozhraními API pro jakýkoli typ nabídky komerčního marketplace. Rozhraní API pro příjem dat produktů je aktuálně podporované pro SaaS, virtuální počítače, privátní nabídky a typy nabídek kontejnerů a je ve verzi Preview. Pokyny specifické pro vaši nabídku najdete v pokynech k rozhraní API pro jednotlivé typy nabídek.
Důležité
Azure Active Directory (Azure AD) Graph je od 30. června 2023 zastaralý. V budoucnosti do Azure AD Graph neplánujeme žádné další investice. Rozhraní Azure AD Graph APIs nemají žádné závazky SLA ani údržby nad rámec oprav souvisejících s bezpečností. Investice do nových funkcí a funkcí budou provedeny pouze v Microsoft Graphu.
Azure AD Graph vyřadíme v přírůstkových krocích, abyste měli dostatek času na migraci aplikací do rozhraní Microsoft Graph API. Později, kdy budeme oznamovat, zablokujeme vytváření nových aplikací pomocí Azure AD Graphu.
Další informace najdete v tématu Důležité: Ukončení Azure AD Graphu a modulu PowerShellu.
Začínáme
K rozhraní Product Ingestion API lze přistupovat pomocí rozhraní MSGraph API https://graph.microsoft.com/rp/product-ingestion.
Pokud chcete použít rozhraní API pro příjem dat produktů, musíte nejprve získat následující:
Microsoft Entra ID
Aplikace Microsoft Entra
Přístupový token Microsoft Entra
Krok 1: Dokončení požadavků
Než začnete psát kód pro volání rozhraní API pro příjem dat produktů, ujistěte se, že jste dokončili následující požadavky.
- Vy (nebo vaše organizace) musíte mít adresář Microsoft Entra. Pokud už používáte Microsoft 365 nebo jiné obchodní služby od Microsoftu, už máte adresář Microsoft Entra. Jinak můžete vytvořit nové ID Microsoft Entra v Partnerském centru bez dalších poplatků.
- Aplikaci Microsoft Entra musíte přidružit k účtu Partnerského centra a získat ID tenanta, ID klienta a klíč. Budete je potřebovat k získání přístupového tokenu Microsoft Entra, který používáte při volání rozhraní API pro odesílání do Microsoft Store.
Přidružení aplikace Microsoft Entra k účtu Partnerského centra
Pokud chcete použít rozhraní API pro příjem produktů, musíte přidružit aplikaci Microsoft Entra k účtu Partnerského centra, načíst ID tenanta a ID klienta aplikace a vygenerovat klíč. Aplikace Microsoft Entra představuje aplikaci nebo službu, ze které chcete volat rozhraní API pro příjem produktů. K získání přístupového tokenu Microsoft Entra do rozhraní API potřebujete ID tenanta, ID klienta a klíč.
Poznámka:
Tuto úlohu musíte provést jenom jednou. Jakmile budete mít ID tenanta, ID klienta a klíč, můžete je kdykoli znovu použít k vytvoření nového přístupového tokenu Microsoft Entra.
- V Partnerském centru přidružte účet Partnerského centra vaší organizace k adresáři Microsoft Entra vaší organizace.
- Na stránce Uživatelé v části Nastavení účtu Partnerského centra přidejte aplikaci Microsoft Entra, která představuje aplikaci nebo službu, kterou používáte pro přístup k odeslání pro váš účet v Partnerském centru. Ujistěte se, že této aplikaci přiřadíte roli Správce . Pokud aplikace ještě v adresáři Microsoft Entra neexistuje, vytvořte novou aplikaci Microsoft Entra v Partnerském centru. Partnerské centrum vytvoří pro aplikaci dva typy záznamů: jeden jako "service principal" a druhý jako typ aplikace Microsoft Entra.
- Vraťte se na stránku Uživatelů, vyberte název své aplikace Microsoft Entra, přejděte do nastavení aplikace a zkopírujte hodnoty Tenant ID a Client ID.
- Vyberte Přidat nový klíč. Na následující obrazovce zkopírujte hodnotu klíče . Po opuštění této stránky nebudete mít přístup k informacím znovu. Další informace naleznete v tématu Správa klíčů pro aplikaci Microsoft Entra.
Krok 2: Získání přístupového tokenu Microsoft Entra
Pokud chcete volat kteroukoli z metod v API pro ingest produktů, musíte nejprve získat přístupový token Microsoft Entra, aby bylo možné předat do autorizační hlavičky každé metody v API. Platnost přístupového tokenu vyprší 60 minut po vystavení. Potom ho můžete aktualizovat, abyste ho mohli použít v budoucích voláních rozhraní API.
Pokud chcete získat přístupový token, postupujte podle pokynů v Volání služeb pomocí přihlašovacích údajů klienta a odešlete jej na koncový HTTP POST bod. Tady je ukázkový požadavek:
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
Jako hodnotu tenant_id v identifikátoru POST URI a parametrech client_id a client_secret zadejte ID tenanta, ID klienta a klíč pro vaši aplikaci, kterou jste získali z Partnerského centra v předchozí části. Pro parametr oboru je nutné zadat https://graph.microsoft.com/.default.
Koncepty
Než začnete, musíte porozumět některým základním konceptům.
Zdroje informací
Rozhraní API je strukturované kolem typů prostředků, kde každý typ je popsán pomocí vyhrazené definice schématu, jak odkazuje vlastnost "$schema". Schéma se skládá z vlastností konfigurace daného prostředku. Prostředky jsou zásadní při vytváření a aktualizaci konfigurace různých aspektů daného produktu. Úplný seznam typů prostředků a jejich schémat najdete v referenčních informacích k rozhraní API prostředků.
Stálé ID
Durable ID je systémový vygenerovaný globální identifikátor sloužící k jedinečné identifikaci jakéhokoli prostředku. Každý prostředek má přidruženou vlastnost ID, která v kombinaci s názvem typu prostředku tvoří trvalé ID prostředku. Trvalé identifikátory (ID) se používají při odkazování na zdroje pro načtení nebo úpravy.
Formát:
\<resource-type>/\<id>
Příklad:
{
"$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"
}
Externí ID
Externí ID je další jedinečný identifikátor, který lze použít k odkazování na konkrétní produkty nebo plány. Toto je alternativní způsob, jak odkazovat na tyto prostředky místo použití trvalého ID. Externí ID produktu se přeloží na jeho "offerID" a externí ID plánu se přeloží na jeho "planID", jak je definováno při vytvoření ve vlastnosti "identita".
Příklad:
{
"$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",
}
Metody rozhraní API
Existují čtyři rozhraní API pro správu, která se dají použít k provádění různých akcí, jako je dotazování stávajících prostředků, provádění aktualizací konfigurace a kontrola stavu žádosti.
Poznámka:
Všechny požadavky vyžadují, abyste v rámci odpovědi nastavili požadovanou verzi schématu (parametr dotazu $version).
| Typ rozhraní API | Popis | Metoda a cesta HTTP |
|---|---|---|
| Dotaz | Načte existující prostředky podle: -Metoda 1: Typ prostředku "resource-tree" -Metoda 2: trvalé ID -Metoda 3: Parametry řetězce dotazu |
-Metoda 1: GET resource-tree/<product-durableID>-Metoda 2: GET <resource-durableID>-Metoda 3: GET <resourceType>?<query parameters> |
| Konfigurace odeslání | Odešle žádosti o vytvoření nebo aktualizaci jednoho nebo více prostředků. Po úspěšném zpracování se vrátí ID úlohy, které lze použít k načtení stavu požadavku. Tento typ rozhraní API lze použít k aktualizaci stavu konceptu a publikování změn, synchronizaci soukromých cílových skupin a úpravě stavu životního cyklu prostředků. | POST configure |
| Konfigurace stavu | Načte stav čekajícího požadavku prostřednictvím identifikátoru úlohy. | GET configure/<jobID>/status |
| Konfigurace podrobností o stavu | Načte podrobný souhrn dokončeného požadavku, včetně aktualizovaných prostředků, použitím ID úlohy. | GET configure/<jobID> |
| Zrušit konfiguraci | Zruší zadanou úlohu Konfigurace. | POST configure/<jobID>/cancel |
Typický pracovní postup
Chcete-li aktualizovat existující prostředek, obvyklý postup je:
- Načtení existující konfigurace prostředků (typ rozhraní API: Dotazování prostřednictvím stromu prostředků)*
- Proveďte potřebné aktualizace a pak odešlete požadavek na konfiguraci (typ rozhraní API: Konfigurace odeslání)
- Zkontrolujte stav požadavku (typ rozhraní API: Konfigurace stavu a Konfigurace podrobností o stavu)
* Stejný pracovní postup lze použít při vytváření nových prostředků, ale místo načítání prostředků (krok 1) použijte referenční tabulku rozhraní RESOURCE API, abyste zajistili, že používáte aktuální schéma pro typ prostředku, který vytváříte.
Tento obrázek shrnuje typický model volání použitý k odeslání žádosti o konfiguraci bez ohledu na to, jestli vytváříte nový nebo upravujete existující prostředek.
Poznámka:
Nezapomeňte si projít všechny další požadavky specifické pro typ nabídky, který spravujete, odkazem na pokyny k rozhraní API podle jednotlivých typů nabídek v oddílu.
Načtení existujících konfigurací prostředků
Před aktualizací existujících prostředků je důležité je nejprve získat, abyste měli jistotu, že máte nejnovější konfiguraci. Prostředky lze načíst několika způsoby prostřednictvím volání GET. Podívejte se na Metodu 1 k načtení všech zdrojů v konkrétním produktu jedním voláním API.
Metoda 1: Strom prostředků
Schema: https://``schema.mp.microsoft.com``/schema/resource-tree/2022-03-01-preview2
GET resource-tree/<product-durableID>?$version=<schema-version>
Všechny konfigurace prostředků v rámci konkrétního produktu můžete načíst pomocí typu prostředku "resource-tree" spolu s trvalým ID produktu.
Nejnovější dostupná verze schématu se může pro každý prostředek lišit. Při provádění požadavku stromu prostředků určuje zadaná verze schématu, která verze se vrátí pro každý prostředek v produktu. Zadaná verze slouží jako limit maximální verze v tom, že vrací nejnovější verzi schématu dostupnou pro všechny prostředky stejné nebo nižší verze. Pokud je například k dispozici nejnovější dostupná verze výpisu plánu 2022-03-01-preview3, zobrazí odpověď tuto verzi, pokud jste v požadavku GET stromu prostředků zadali "2022-03-01-preview5". Pokud ale jako verzi stromu prostředků požadujete "2022-03-01-preview2", se v seznamu prostředků vrátí plán "2022-03-01-preview2", i když je dostupná nejnovější verze "2022-03-01-preview3". Doporučujeme použít nejnovější verzi každého prostředku, abyste měli jistotu, že používáte aktualizované schéma s nově podporovanými funkcemi.
Poznámka:
Pokud neznáte trvalé ID produktu, můžete pomocí externího ID produktu načíst prostředek produktu spuštěním GET product?externalID=<product-externalID>&$version=<product-schema-version>. Tento požadavek používá parametr řetězce dotazu, který je podrobně popsán v metodě 3. Odpověď zahrnuje trvalé ID produktu, které můžete použít pro budoucí požadavky.
Standardně, když spustíte volání GET pomocí stromu prostředků, získáte konceptovou verzi svých prostředků. Předáním parametru dotazu targetType však můžete zadat požadovaný cíl pro načtení dat "preview" nebo "live". V následujícím příkladu volání GET vrátí konfiguraci náhledového prostředí pro všechny prostředky pod produktem "12345678-abcd-efgh-1234-12345678901".
Ukázkové volání GET:
GET https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType="preview"&$version=2022-03-01-preview5
Ukázková odpověď:
{
"$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.
{
...
}]
}
Metoda 2: Durable ID
GET <resource-durableID>?$version=<schema-version>
Načtěte konkrétní prostředek pomocí jeho trvalého identifikátoru. Po vytvoření prostředku zůstane trvalé ID vždy stejné a dá se použít k načtení nejnovějších změn konceptu tohoto prostředku voláním metody GET. Například následující požadavek vrátí koncept konfigurace tohoto konkrétního produktu pomocí verze schématu 2022-03-01-preview3.
GET product/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview3
Důležité
Tato metoda se používá pouze k načtení konfigurace návrhu. Pokud chcete načíst náhled nebo živá data, použijte metodu „stromu prostředků“, jak je popsáno výše.
Chcete-li najít trvalé ID pro své prostředky, můžete:
- Pomocí metody "resource-tree" můžete načíst všechny prostředky spolu s jejich příslušnými trvalými identifikátory v rámci produktu, nebo
- Načtěte podrobnosti o dokončené žádosti o konfiguraci prostředků, která zahrnuje trvalé ID všech prostředků vytvořených nebo aktualizovaných jako součást požadavku.
Nezapomeňte, že vlastnostIDje trvalé ID příslušného prostředku.
Metoda 3: Parametry dotazovacího řetězce
GET <resourceType>?<query parameters>&$version=<schema-version>
Tato metoda slouží k dotazování určitých typů prostředků přidružených ke konkrétnímu účtu. Pomocí jednoho volání GET můžete například načíst všechny produkty konkrétního typu produktu. Parametry řetězce dotazu se používají k dotazování podrobností týkajících se vašich produktů, plánů nebo odeslání.
Tato tabulka zobrazuje podporované parametry dotazu pro každý z podporovaných typů prostředků. Ne všechny typy prostředků podporují každý z parametrů dotazu. V této tabulce najdete úplný seznam aktuálně podporovaných řetězců dotazů.
| Typ prostředku | Parametry | Příklady řetězců dotazů |
|---|---|---|
| plán | výrobek*Externí ID $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> |
| výrobek | Externí ID typ $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> |
| podání | typ cíle $maxpagesize continuationToken$version * |
GET submission/<product-durableID>?targetType=<environment>&$version=<schema-version>GET submission/<product-id>?$maxpagesize=<#>&continuationToken=<token>&$version=<schema-version> |
| strom prostředků | targetType$version* |
GET resource-tree/<product-durableID>?targetType=<environment>&$version=<schema-version> |
* Parametry produktu a $version jsou vždy povinné.
Funkce jednotlivých podporovaných parametrů dotazu:
- product – Při předávání parametru "product" v kontextu typu zdroje "plán" vrátí všechny plány v rámci daného produktu.
- externalID – Při předávání parametru externalID v kontextu produktu nebo plánu vrátí konfiguraci příslušného produktu nebo plánu. Na rozdíl od metody "resource-tree" tento parametr řetězce dotazu vrátí pouze podrobnosti o tomto prostředku, ne všechny prostředky v něm.
- type – Při předávání parametru "type" v kontextu typu prostředku "product" vrátí všechny produkty tohoto typu přidružené k vašemu účtu. Například zadáním "type=softwareAsAService", vrátí se všechny produkty SaaS.
- targetType – Vrátí data konkrétního prostředí v kontextu použitého typu prostředku. Podporované hodnoty targetType jsou koncept, náhled nebo živě.
- $maxpagesize – Zadáním maximální velikosti stránky ve formě kladného celého čísla se tento parametr používá k omezení výsledků hledání při dotazování předchozích odeslání.
- continuationToken – Tento parametr lze použít s parametrem "$maxpagesize" k dotazování na jinou sadu výsledků dostupných ve vyhledávání. Hodnota "continuationToken" je k dispozici v odpovědi předchozí stránky.
- $version – Jedná se o povinný parametr pro všechna volání, určuje, jakou verzi schématu chcete pro odpověď z požadavku, který jste provedli. Nejnovější dostupná verze schématu může být pro každý prostředek odlišná a zadaná verze slouží jako limit maximální verze. Systém vrátí buď přesnou verzi schématu, pokud je k dispozici, nebo nejbližší verzi, která je starší než požadovaná verze. To může pomoct udržet kód funkční i v případě, že dojde k novějším změnám schématu, ale pokud chcete využívat nejnovější funkce, doporučujeme použít nejnovější dostupnou verzi každého schématu.
Dotazování na vaše odeslané dokumenty
Stávající odeslané produkty můžete získat provedením GET submission/<product-durableID>. Ve výchozím nastavení získáte zpět všechna aktivní odeslání včetně konceptu odkazu, ale můžete také dotazovat konkrétní prostředí pomocí parametru dotazu targetType: (GET submission/<product-durableID>?targetType=<environment>&$version=<version>).
Důležité
Jakmile je "Náhled" odeslání přesunuto do "Živé", nahradí předchozí odeslání "Živé". V takovém případě teď data představují prostředíPreviewa prostředíLive, dokud se nové odeslání nepublikuje doPreview.
Ukázkový požadavek:
GET https://graph.microsoft.com/rp/product-ingestion/submission/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview2
Ukázková odpověď:
Tento příklad ukazuje požadavek GET pro aktivní odeslání spojené s ID produktu "12345678-abcd-efgh-1234-12345678901." Aktivní "Live" odeslání (odeslání/12345678-abcd-efgh-1234-12345678901/1152921515689847470) bylo nejprve publikováno k náhledu a poté naživo. Když bylo toto podání zveřejněno živě 25. ledna 2022, představovalo jak náhled, tak živé vysílání, dokud nebylo 4. února 2022 vytvořeno nové podání pro náhled (submission/12345678-abcd-efgh-1234-12345678901/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"
}
]
}
Vytváření nových produktů a prostředků
V rámci jednoho požadavku na konfiguraci můžete vytvořit nové prostředky, včetně nových produktů. Pomocí referenční tabulky rozhraní API prostředků můžete načíst schéma pro typ prostředku, který chcete vytvořit. Tím zajistíte, že používáte nejnovější schéma, a proto nakonfigurujete všechny potřebné vlastnosti pro vytvoření prostředku.
Pokud vytváříte nový produkt, požadavky se liší podle typu produktu. Proto potřebujete poskytnout různé prostředky. Můžete odkazovat na odpovídající dokumentaci ke komerčnímu marketplace pro příslušný typ produktu, abyste měli jistotu, že konfigurujete základní požadavky ve své žádosti. Případně můžete vytvořit žádost o konfiguraci pouze pomocí prostředku produktu. Po vytvoření produktu zavolejte rozhraní API pro podrobnosti o stavu konfigurace pro získání vytvořeného prostředku produktu a najděte jeho trvalé ID k volání rozhraní API pro dotazy stromu prostředků. Odpověď vrátí příslušné podporované prostředky pro typ produktu, který jste vytvořili.
Podobně pokud chcete vytvořit nový prostředek v rámci existujícího produktu, musíte také načíst nejnovější schéma tohoto konkrétního typu prostředku. Ujistěte se, že v rámci požadavku na konfiguraci zadáte závislé prostředky, a to kontrolou závislostí prostředků.
Po vytvoření prostředků pomocí schémat se dozvíte, jak vytvořit požadavek na konfiguraci.
Úprava existujících produktů a prostředků
Aktualizace můžete odeslat pomocí konfigurace datové části. Tato datová část se skládá z jednoho nebo více typů prostředků a vlastnost "$schema" označuje typ prostředku, na který se odkazuje.
Návod
Doporučujeme, abyste před zveřejněním aktualizací nejprve stáhli aktuální zdroje, aby bylo zajištěno, že používáte nejnovější konfiguraci.
Po úpravě prostředků se naučíte, jak vytvořit požadavek na konfiguraci.
Požadavky na konfiguraci
Můžete upravovat a publikovat ve stejném payloadu současně. Pokud chcete odeslat požadavek na konfiguraci, použijte metodu HTTP POST pro rozhraní API konfigurace. Datová část konfigurace se skládá z kolekce prostředků, které určují požadované změny. Všechny úpravy ovlivní pouze koncept, dokud výslovně neodešlete zdroj pro publikování změn konceptu. Při publikování do náhledu nebo naživo zahrňte zdroj odeslání a zadejte cílové prostředí. Před odesláním žádosti potřebujete vědět, jak odkazovat na prostředky a porozumět jejich závislostem.
Schema:<https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2>
Po odeslání žádosti o konfiguraci získáte zpět objekt stavu konfigurace s ID úlohy, který můžete použít ke sledování průběhu a výsledků vaší žádosti.
Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>
Odkazy na prostředky a závislosti
Reference
Pokud chcete odkazovat na existující prostředek v požadavku konfigurace, zadejte typ "$schema" prostředku spolu s trvalým ID prostředku. U produktů a plánů můžete na tyto prostředky odkazovat také prostřednictvím jejich externího ID.
Trvalé ID lze najít ve vlastnosti "ID", například pokud se jedná o prostředek produktu, na který chceme odkazovat v jiném prostředku.
{
"$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"
}
Trvalé ID by bylo "produkt/071b135e-9faf-4ff7-b113-a3f25bb0f468."
Trvalé ID se pak dá použít v následujícím příkladu výpisu prostředku tak, že ho nastavíte ve vlastnosti schématu prostředku product takto:
{
"$schema": "https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5",
"product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468", // product durable ID
...
}
Externí ID prostředků produktu a plánu je definováno v rámci vlastnosti identity.
{
"$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
"alias": "Gold - Annual payment",
"identity": {"externalID": "gold-annual"},
"product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468",
...
}
Na externí ID plánu "gold-annual" se pak dají odkazovat dalšími dalšími zdroji v následujícím formátu:
{
"$schema": "https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5",
"product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468"}
"plan": {"externalID": "gold-annual"}
...
}
Ukázkový požadavek:
V tomto příkladu se konfigurační datový balíček používá k vytvoření nového produktu SaaS s externím IDds-contoso-image-resize-demo. Po vytvoření tohoto produktu můžete později na tento produkt odkazovat pomocí jeho trvalého ID nebo externího 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"
}
]
}
Ukázková odpověď:
{
"$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": []
}
Id úlohy pak můžete použít prostřednictvím rozhraní API pro konfiguraci stavu ke kontrole stavu vaší žádosti.
Závislosti
Některé prostředky mají závislosti na vytvoření jiného prostředku jako předpokladu. V této situaci používáme vlastnost "resourceName" ve stejné datové části k označení závislosti prostředku produktu v prostředku plánu, protože oba vytváříme ve stejném požadavku.
"resourceName" se používá pouze k identifikaci každého prostředku jako součást konfiguračního požadavku, který provádíte. Hodnota není součástí dat prostředků, neukládá se ani není vystavená zákazníkům. Pokud v rámci požadavku konfigurace dojde k nějakým chybám, použije se "resourceName" k označení prostředku, ke kterému chyba patří.
Ukázkový požadavek:
V tomto příkladu musí být produkt vytvořen před plánem, a proto se použije vlastnost "resourceName". Vytvářený produkt, "myNewProduct," je hodnota použitá pro "resourceName" a je zmíněna v rámci závislé zdrojové položky plánu.
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"}
...
},
}]
}
Zdroj pro podání
Pokud publikujete na "preview" nebo "live", zahrňte do své žádosti zdroj odeslání, který obsahuje:
- Vlastnost "product", označující produkt, který je aktualizován, jak je uvedeno jeho trvalým ID nebo externím ID.
- Vlastnost targetType označující cílové prostředí
Při publikování naživo použijte „ID“ odeslání verze Preview, kterou chcete publikovat:
{
"$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" }
}
Poznámka:
Pokud zdroj pro odeslání nezahrnete, změny se provedou pouze ve stavu konceptu.
Publikování ve verzi Preview
Komerční typy produktů podporují prostředí ve verzi Preview a každá aktualizace musí být před zahájením provozu nejprve publikovaná ve verzi Preview. Nemůžete publikovat přímo naživo.
Důležité
Výjimkou je, když provádíte změny v soukromé cílové skupině vašich plánů. Při synchronizaci aktualizací pro privátní cílovou skupinu se tyto změny konkrétně rozšíří současně jak do testovací verze, tak i naživo.
Prostředky můžete publikovat ve verzi Preview dvěma způsoby. Pokud je potřeba provést nějaké změny v náhledu, proveďte další požadavek GET, proveďte potřebné změny a změny odešlete znovu. Nemusíte nejprve nasadit své počáteční změny.
Metoda 1: Publikování všech návrhů zdrojů
Pokud chcete publikovat všechny provedené změny konceptu, můžete odeslat žádost o konfiguraci s prostředkem pro odeslání, který nastaví prostředí preview na "targetType". Jak je znázorněno v následujícím příkladu, nemusíte explicitně zadávat všechny prostředky, které vyžadují aktualizaci, protože tato metoda publikuje všechny změny v cílovém prostředí, což v tomto případě je ve verzi Preview. Stačí zadat pouze koncový bod rozhraní API a prostředek odeslání.
Ukázkový požadavek:
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" }
}
]
}
Metoda 2: Publikování konkrétních konceptů zdrojů (označovaných také jako modulární publikování)
Případně pokud nejste připravení publikovat všechny koncepty změn v různých prostředcích, stačí poskytnout prostředky, které chcete publikovat, společně s prostředkem pro odeslání, aby se aktivovalo modulární publikování. Tento přístup můžete použít také k provádění změn prostředků a jejich publikování ve stejnou dobu místo jako součást hromadné aktualizace, jak je to provedeno prostřednictvím metody 1. U modulárního publikování se vyžadují všechny prostředky s výjimkou podrobností na úrovni produktu (například výpis, dostupnost, balíčky, prodejce), které platí pro váš typ produktu.
Ukázkový požadavek:
V tomto příkladu jsou prostředky v produktu explicitně poskytovány jako součást modulárního publikování následované zdrojem odeslání.
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" }
}
]
}
Publikování naživo
Po otestování a ověření změn ve verzi Preview můžete změny odeslat do provozu odesláním konfigurační žádosti s "ID" vašeho odeslání Preview a nastavením "targetType" na hodnotu "live". Pokud chcete najít "ID" vašeho odeslání Preview, které se má začlenit do vaší konfigurační žádosti, viz Dotazování vašich odeslání.
Důležité
Na rozdíl od publikování ve verzi Preview není možné při publikování v reálném prostředí provádět modulární publikování. Proto je důležité zajistit, že jste ověřili odeslání náhledu před zveřejněním vašich změn.
Ukázkový požadavek:
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" }
}
]
}
Kontrola stavu žádosti
Bez ohledu na prostředky, které jsou součástí vaší žádosti o konfiguraci nebo provedené změny, dostanete objekt stavu konfigurace zpět v odpovědi krátce po odeslání požadavku po úspěšném zpracování. Id úlohy je důležité, protože ho můžete později použít ke kontrole stavu požadavku.
Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>
Ukázková odpověď na odeslanou žádost:
{
"$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": []
}
Stav čekající žádosti
Stav můžete načíst, dokud se úloha nedokončí, pomocí následujícího volání a zadáním "id úlohy" požadavku. Objekt může také obsahovat seznam chyb, pokud došlo k problémům s vaším požadavkem.
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobID>/status?$version=2022-03-01-preview2
Mějte na paměti, že doba dokončení se může lišit v závislosti na složitosti vaší žádosti.
Souhrn dokončené žádosti
Po dokončení úlohy konfigurační žádosti, ať už úspěšně nebo s chybou, můžete získat seznam prostředků vytvořených nebo aktualizovaných pomocí ID úlohy.
Poznámka:
Pokud toto volání provedete před dokončením úlohy, selže. Navíc vrátí pouze prostředky, které byly úspěšně dokončeny, nebo v případě zrušení pouze ty, které byly dokončeny před zrušením.
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
Ukázkový požadavek:
V následujícím příkladu se požadavek GET používá k načtení souhrnných podrobností o konfiguraci požadavku použitého v předchozím příkladu, který vytvořil nový produkt SaaS. Odpovědí je objekt s podrobnou konfigurací s polem zdrojů, které obsahuje zdroj produktu vytvořený spolu s jeho trvanlivým ID.
GET https://graph.microsoft.com/rp/product-ingestion/configure/071b135e-9faf-4ff7-b113-a3f25bb0f468?$version=2022-03-01-preview2
Ukázková odpověď:
{
"$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"
}
]
}
Zrušení žádosti o konfiguraci
Před dokončením úlohy se můžete pokusit ji v případě potřeby zrušit. U dlouhotrvajících požadavků, jako je publikování na "preview" nebo "live", může být žádost o zrušení zamítnuta, pokud je úloha už ve fázi dokončování.
Pokud chcete zrušit úlohu, proveďte volání POST do koncového bodu zrušení a zadejte ID úlohy požadavku, který chcete zrušit.
POST https://graph.microsoft.com/rp/product-ingestion/configure<jobID>/cancel?$version=2022-03-01-preview2
Ukázkový požadavek:
POST <https://graph.microsoft.com/rp/product-ingestion/configure/d4261631-c583-4949-a612-5150882632e9/cancel?$version=2022-03-01-preview2>
Ukázková odpověď úspěšné žádosti o zrušení:
{
"$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": []
}
Ukázková odpověď v případě, že zrušení není povolené: HTTP Status code: 400
Obsah:
{
"error": {
"code": "badRequest",
"message": "Cannot cancel job, job has already completed.",
"details": []
}
}
Důležité
Nezapomeňte, že zrušení platí jenom pro prostředky, které ještě nebyly zpracovány. Některé prostředky už možná dokončily zpracování a odrážely nejnovější aktualizace konfigurace, a to i přes zrušení požadavku.
Můžete načíst souhrn žádosti o konfiguraci po zrušení a ověřit, které prostředky (pokud nějaké) už byly před zrušením zpracovány.
Synchronizace privátních cílových skupin
U živého produktu lze aktualizace pro soukromé cílové skupiny v konceptech, náhledu a produkčním prostředí provádět současně a není nutné je publikovat. Privátní cílovou skupinu můžete synchronizovat pomocí prostředku "price-and-availability-update-private-audiences" zadáním cílových skupin, které chcete přidat nebo odebrat z konkrétního plánu. Tím se synchronizují koncept, náhled a živé prostředí, aby měly stejné hodnoty pro privátní cílovou skupinu. Při synchronizaci privátní cílové skupiny nemusíte zadávat prostředek odeslání.
Pokud chcete upravit koncepty cílových skupin, použijte prostředek price-and-availability-plan a vlastnost privateAudiences. Aby se hodnoty nastavily v náhledové verzi a živě, musí to projít běžným publikačním procesem.
Důležité
Podporované typy cílových skupin jsou "předplatné", "ea", "msdn" a "tenant", ale podpora těchto typů se liší podle typu produktu. Pokud váš produkt podporuje více než jeden typ identifikátoru pro konfiguraci privátní cílové skupiny (například ID tenanta i ID předplatného), musíte provést úplné publikování, pokud poprvé zadáte nový typ identifikátoru. V tomto případě nemůžete synchronizovat privátní cílovou skupinu.
Ukázkový požadavek na synchronizaci konfigurace privátní cílové skupiny:
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"
}
]
}
}
]
}
Konfigurace správy potenciálních zákazníků
Připojte svůj systém pro správu vztahů se zákazníky (CRM) s produktem komerčního marketplace, abyste mohli dostávat kontaktní informace zákazníků, když zákazník vyjadřuje zájem nebo nasadí váš produkt. Toto připojení můžete kdykoli změnit během vytváření produktu nebo po jeho vytvoření. Další informace najdete v tématu Získání potenciálních zákazníků.
Ukázkový požadavek na konfiguraci správy potenciálních zájemců:
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"
}
}
]
}
Stavy životního cyklu prostředků
Existují různé akce, které můžete provést a které lze přiřadit ke stavu životního cyklu prostředku. Ne všechny prostředky mají stav životního cyklu a ne všechny stavy životního cyklu jsou podporovány všemi prostředky. Pokud chcete zjistit, jestli má prostředek stav životního cyklu a které hodnoty jsou podporovány, můžete zkontrolovat schéma prostředku pro existenci vlastnosti "lifecycleState." Různé podporované stavy životního cyklu jsou podrobně popsány později.
Odstraněné
Konkrétní zdroje můžete odstranit aktualizací vlastnosti "lifecycleState" na "odstraněno." Můžete odstranit jenom koncepty zdrojů, které ještě nebyly publikovány. Tuto akci nelze vrátit zpět.
Ukázkový požadavek:
V následujícím příkladu je "základní" návrh plánu vymazán.
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"
}
]
}
Zastaralé
Vyřazení odebere prostředek z komerčního marketplace. Pokud chcete ukončit podporu, nastavte vlastnost lifecycleState na zastaralé u prostředků, které ji podporují. Existují různé úrovně vyřazení. Všechny typy produktů podporují vyřazení celého produktu a individuálních plánů v rámci tohoto produktu. Pokud chcete později obnovit zastaralý prostředek, přečtěte si stav životního cyklu "obecně k dispozici".
Ukázkový požadavek na vyřazení produktu:
V následujícím příkladu je plánováno ukončení živého odesílání produktu. Jakmile je tato změna použita, automaticky se publikuje a projeví se okamžitě.
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"
}
]
}
Při vyřazení plánů je nutné změnit vlastnost "lifecycleState" na "deprecated" a změny se pak musí publikovat ve verzi Preview a poté na live, aby se vyřazení projevilo. Liší se od vyřazení na úrovni produktu, ve kterém se vyřazení automaticky konfiguruje v živém prostředí.
Ukázkový požadavek na vyřazení plánu:
V následujícím příkladu je plán v rámci produktu SaaS nastavený na vyřazení. Nezapomeňte, že pokud chcete tuto změnu použít, můžete později publikovat pomocí prostředku pro odeslání.
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"
}
]
}
Existují další formy vyřazení, které se liší v závislosti na typu produktu. Přečtěte si další informace o vyřazení SaaS, virtuálních počítačů a kontejnerů.
Obecně dostupné
generallyAvailable je výchozí stav životního cyklu pro všechny prostředky. Jakmile je prostředek zastaralý, můžete ho obnovit tak, že změníte vlastnost "lifecycleState" zpět na "generallyAvailable". Pokud chcete obnovit zastaralý produkt, musíte ho nejprve publikovat do náhledu a poté do živého provozu. Příklady pro SaaS, virtuální počítače a kontejnery najdete v příslušných článcích.
Ukázkový požadavek na obnovení plánu:
V následujícím příkladu je plán určený k obnovení. Pokud chcete tuto změnu použít, budete později muset publikovat celý proces, až do fáze nasazení, pomocí zdroje pro odeslání.
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"
}
]
}
Referenční informace k rozhraní API prostředků
Následující verze schématu platí pouze pro náhled a dojde ke změnám, až bude rozhraní API obecně dostupné.
Poznámka:
Existující dostupné prostředky a jejich verze můžete zobrazit tady: resources-index
| Typ prostředku | Popis | Schéma |
|---|---|---|
| nastavení komerčního marketplace | Popisuje transakční konfiguraci produktů na komerčním marketplace. | https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2 |
| zákaznické kontakty | Umožňuje připojení k systému CRM pro příjem potenciálních zákazníků. | https://schema.mp.microsoft.com/schema/customer-leads/2022-03-01-preview3 |
| inzerát | Patří sem popisy vašeho produktu, které se zobrazují v obchodech komerčního marketplace Microsoftu. | https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5 |
| výpis majetku | Snímky obrazovky a marketingové prostředky spojené se zdrojem inzerátu. | https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5 |
| náhled inzerátů | Video soubory propojené se zdrojem seznamu. | https://schema.mp.microsoft.com/schema/listing-trailer/2022-03-01-preview5 |
| integrace Microsoft 365 | Aktivace a výběr typu Microsoft 365 | https://schema.mp.microsoft.com/schema/microsoft365-integration/2022-03-01-preview2 |
| plán | Chcete-li vytvořit plány, které pak budou referenčními body pro prostředky na úrovni plánu, které nakonfigurujete, jako je například seznam plánů. | https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2 |
| seznam plánů | Definujte název a popis plánu tak, jak chcete, aby se zobrazovaly na komerčním marketplace. | https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5 |
| cena-a-dostupnost-vlastní-metr | Definujte vlastní měřiče sdílené napříč vašimi plány. | https://schema.mp.microsoft.com/schema/price-and-availability-custom-meter/2022-03-01-preview3 |
| nabídka cen a dostupnosti | Před publikováním produktu definujte omezenou cílovou skupinu, která může produkt zkontrolovat. | https://schema.mp.microsoft.com/schema/price-and-availability-offer/2022-03-01-preview3 |
| plán cen a dostupnosti | Nakonfigurujte trhy, ve které je tento plán dostupný, v požadovaném modelu zpeněžení, cenách a fakturačních podmínkách. | https://schema.mp.microsoft.com/schema/price-and-availability-plan/2022-03-01-preview4 |
| aktualizace-cen-a-dostupnosti-pro-soukromá-publika | Aktualizace soukromých cílových skupin v koncepčních návrzích, náhledu a živých prostředích lze provádět současně bez nutnosti publikování. | https://schema.mp.microsoft.com/schema/price-and-availability-update-private-audiences/2022-03-01-preview3 |
| plán soukromé nabídky a dostupnosti | Slouží ke konfiguraci absolutních cenových podrobností o cenách produktů/plánů používaných v rámci privátní nabídky. | https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2022-07-01 |
| soukromá nabídka | Definuje název a typ privátní nabídky s podmínkami a podrobnostmi nabídky spolu s zahrnutými produkty/plánem a jejich cenami. | https://schema.mp.microsoft.com/schema/private-offer/2022-07-01 |
| výrobek | Toto je hlavní prostředek, definuje název a typ produktu, všechny prostředky na to odkazují. | https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3 |
| vlastnost | Definujte kategorie a odvětví, které se vztahují na vaši nabídku, verzi vaší aplikace a právní smlouvy. | https://schema.mp.microsoft.com/schema/property/2022-03-01-preview5 |
| distributor | Nakonfigurujte partnery v programu Cloud Solution Provider (CSP), pro který chcete produkt zpřístupnit. | https://schema.mp.microsoft.com/schema/reseller/2022-03-01-preview2 |
| strom prostředků | Popisuje seznam prostředků pro daný produkt v aktuálním stavu pro zadané cílové prostředí. | https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2 |
| software jako služba – technická konfigurace | Technické podrobnosti, které pomáhají komerčnímu marketplace Microsoftu připojit se k vašemu řešení | https://schema.mp.microsoft.com/schema/software-as-a-service-technical-configuration/2022-03-01-preview3 |
| podání | Lze použít k aktivaci různých akcí u vašeho produktu a k označení stavu publikování vašeho produktu v různých prostředích (koncept, náhled a živé). | https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2 |
| virtuální-strojový-plán-technická-konfigurace | Technické podrobnosti popisující virtuální počítač a umístění image | https://schema.mp.microsoft.com/schema/virtual-machine-plan-technical-configuration/2022-03-01-preview3 |
| technická konfigurace plánu kontejneru | Technické podrobnosti popisující vlastnosti kontejnerového obrazu | https://schema.mp.microsoft.com/schema/container-plan-technical-configuration/2022-03-01-preview3 |
Doprovodné materiály k rozhraní API pro jednotlivé typy produktů
Rozhraní API pro příjem dat produktů bude v budoucnu dostupné i pro další typy produktů. Vzhledem k tomu, že se podporuje více typů produktů, jsou k dispozici další pokyny specifické pro každý typ produktu.
| Typ produktu | Zdroje specifické pro typ produktu |
|---|---|
| Soukromé nabídky | Vytváření a správa privátních nabídek prostřednictvím rozhraní API pro příjem dat produktů |
| Využití služeb SaaS | Vytváření a správa nabídek SaaS prostřednictvím rozhraní API pro příjem dat produktů |
| Virtual Machines | Vytváření a správa nabídek virtuálních počítačů prostřednictvím rozhraní API pro příjem dat produktů |
| Kontejnery | Vytváření a správa nabídek kontejnerů prostřednictvím rozhraní API pro příjem dat produktů |
Verze a aktualizace rozhraní API
| Aktualizace | Co se změnilo? |
|---|---|
| 11-2023 | Všechny koncové body schématu byly aktualizovány z product-ingestion.azureedge.net na schema.mp.microsoft.com |
| 12-2022 | K dispozici je nová verze schématu 2022-03-01-preview3 API pro příjem potenciálních zákazníků, která při konfiguraci potenciálních zákazníků přijímá clientID a clientSecret a přestane zachytávat pole serverID a pole kontaktního e-mailu. Přejděte na novou verzi a zadejte ID klienta a clientSecret a pokračujte v konfiguraci konektoru Marketo pro nabídky marketplace. Nová adresa URL schématu: https://``schema.mp.microsoft.com``/schema/customer-leads/2022-03-01-preview3 |
| 09-2022 | Podpora verze Preview kontejneru je vydaná ve verzi 2022-03-01-preview4. |
| 08-2022 | Podpora verze Preview softwaru jako služby je vydána ve verzi 2022-03-01-preview3 |
| 08-2022 | Veřejná verze privátní nabídky ve verzi 2022-07-01 |
| 05-2022 | Podpora pro náhled virtuálního počítače je vydána ve verzi 2022-03-01-preview2. |