Rozhraní API pro příjem dat produktů pro SaaS
Rozhraní API pro příjem dat produktů je modernizované rozhraní API, které sjednocuje všechna existující rozhraní API pro odesílání napříč všemi produkty komerčního marketplace. Podrobnosti o tom, jak začít, najdete v rozhraní API pro příjem dat produktů.
Tento článek obsahuje pokyny k používání rozhraní API speciálně pro typ nabídky SaaS.
Načtení existujících konfigurací prostředků
Před aktualizací existujících prostředků je důležité je nejprve načíst, abyste měli jistotu, že máte nejnovější konfiguraci. Prostředky můžete načíst několika způsoby prostřednictvím volání GET. V následující části metoda 1 najdete informace o načtení všech prostředků v rámci konkrétního produktu v rámci jednoho volání rozhraní API.
Metoda 1: Strom prostředků
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. Verze schématu, kterou zadáte, se použije jako maximální podporovaná verze pro všechny příslušné prostředky požadovaného produktu.
Poznámka:
Pokud neznáte trvalé ID produktu, můžete nejprve načíst prostředek produktu pomocí externího ID produktu a spuštěním GET product?externalID=<product-externalID>&$version=<product-schema-version>. Tento požadavek využívá parametr řetězce dotazu, který je podrobně popsaný v metodě 3. Odpověď bude obsahovat trvalé ID produktu, které můžete použít pro budoucí požadavky.
Když ve výchozím nastavení spustíte volání GET pomocí "resource-tree", získáte zpět koncept verze vašich 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 prostředí Preview pro všechny prostředky v rámci produktu "12345678-abcd-eryth-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": "product_external_id_example"
},
"type": "softwareAsAService",
"alias": "product_example"
},
{
"$schema": "https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2",
"id": "commercial-marketplace-setup/12345678-abcd-efgh-1234-12345678901",
"product": "product/12345678-abcd-efgh-1234-12345678901",
"sellThroughMicrosoft": true,
"useMicrosoftLicenseManagementService": false
},
{
"$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
"id": "plan/12345678-abcd-efgh-1234-12345678901/98756328-04e9-55ae-9403-52b6c971a956
...
},
// The response would include all existing resources within this product.
{
...
}]
}
Stavy životního cyklu prostředků
Existují různé akce, které můžete provést namapovat na stav ž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. Zkontrolujte schéma prostředků existence vlastnosti lifecycleState a zjistěte, jestli má prostředek stav životního cyklu a jaké hodnoty jsou podporovány. Následuje několik příkladů nastavení stavu životního cyklu prostředků pro typ nabídky SaaS.
Zastaralé
Vyřazení odebere prostředek z komerčního marketplace. Pokud chcete přestat používat, nastavte vlastnost lifecycleState na zastaralé prostředky, které ji podporují. Různé úrovně vyřazení se podporují v závislosti na typu produktu. Například pro produkty SaaS můžete přestat používat plány nebo celý produkt. Při vyřazení plánů se musí změnit "lifecycleState" a změny se pak musí publikovat ve verzi Preview, aby se vyřazení projevilo. Toto se liší od vyřazení na úrovni produktu, při kterém toto nastavení automaticky spustí vyřazení v živém prostředí. 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í 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"
}
]
}
Ukázkový požadavek na vyřazení produktu:
V následujícím příkladu je živé odeslání produktu nastavené na vyřazení. Po použití této změny se automaticky publikuje, aby se projevila.
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"
}
]
}
Obecně dostupné
Obecně k dispozici 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 obecněavailable. Pokud chcete obnovit zastaralý produkt, musíte ho publikovat ještě jednou, abyste mohli zobrazit náhled a pak ho živě publikovat.
Plán ukázkové žádosti o obnovení:
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 veškerý způsob, jak žít pomocí prostředku 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"
}
]
}