Sdílet prostřednictvím

Rozhraní API pro příjem produktů pro kontejnery

Rozhraní Product Ingestion API je modernizované rozhraní API, které sjednocuje všechna existující rozhraní API pro odesílání napříč všemi produkty na komerčním trhu. 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 kontejnery.

Načtení existujících konfigurací prostředků

Získejte všechny prostředky konkrétního produktu jediným voláním API.

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

Všechny konfigurace zdrojů v rámci konkrétního produktu můžete načíst pomocí typu zdroje "resource-tree" spolu s perzistentním ID produktu. Verze schématu, kterou zadáte, se používá 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 spustit ho. Další informace najdete v tématu Rozhraní API produktu : Metoda 1: strom zdrojů.

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

Synchronizace privátních cílových skupin

Pro živý produkt lze aktualizace soukromých cílových skupin v konceptu, náhledu a živých prostředích provádět zároveň bez nutnosti publikování. Privátní cílovou skupinu můžete synchronizovat pomocí prostředku "cena a dostupnost-aktualizace-privátní-cílová skupina" zadáním cílových skupin, které chcete přidat nebo odebrat z konkrétního plánu. Tím se synchronizuje návrh, náhled a živé prostředí, aby měly stejné hodnoty soukromého publika. 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. Bude potřeba projít běžným tokem publikování, aby se hodnoty nastavily ve verzi Preview a živě.

Důležitý

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á žádost o 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-preview3",
    "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": " c0cab000-5c00-2ae9-acbe-f5f0bb264498 ",
           "label": "test 1"
         }
      ],
      "remove ":
      [
        {
    "type": "tenant",
           "id": " d1cab000-6c06-4ae9-acbe-b5f0bb264498 ",
           "label": "test 2"
        }
      ]
    }
  }
 ]
}

Konfigurace vlastností

Definujte kategorie a odvětví, které se vztahují na váš produkt kontejneru, verzi vaší aplikace a právní smlouvy. Nezapomeňte uvést kompletní a přesné podrobnosti o vašem produktu v prostředku Vlastnosti, aby se zobrazil správně a nabídl správné sadě zákazníků. Další informace najdete v kategoriích appsource.

Ukázkové tělo požadavku konfigurování vlastností:

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/property/2022-03-01-preview5",
      "id": "property/a8b48be1-a630-41b5-b5a5-c2a9f7789922/public/main",
      "product": "product/a8b48be1-a630-41b5-b5a5-c2a9f7789922",
      "kind": "azureContainer",
      "termsConditions": "standardMicrosoft",
      "categories": {
        "containers": [
          "container-apps",
   "container-images"
        ]
      }
    }
 ]
}

Nastavení výpisu

Informace, které zadáte při výpisu zdrojů, se zobrazí v online obchodech Microsoft komerčního tržiště. Patří sem popisy vašeho produktu, snímků obrazovky a marketingové prostředky.

vzorový text požadavku, který konfiguruje výpis:

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/listing/2022-03-01-preview5",
      "id": "listing/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b/public/main/default/en-us",
      "product": "product/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b",
      "kind": "azureContainer",
      "title": "ContainerCM0815",
      "description": "<div>This offer is in the early stages of development and not for general public consumption. Use is restricted to a limited audience, and has no commercial purpose beyond the testing for which it is intended.</div>",
      "searchResultSummary": "Container product",
      "shortDescription": "This offer is in the early stages of development and not for general public consumption",
      "privacyPolicyLink": "https://www.company.com/privacy",
      "generalLinks": [
 {
   "displayText": "Product link",
   "link": "https://www.company.com/mkt",
 }
      ],
      "globalSupportWebsite": "https://testprivacyurl.com",
      "governmentSupportWebsite": "https://testprivacyurl.com",
      "supportContact": {
        "name": "Support",
        "email": "support@company.com",
        "phone": "4255555555"
      },
      "engineeringContact": {
        "name": "Engineering",
        "email": "john@company.com",
        "phone": "4255555555"
      },
      "cloudSolutionProviderContact": {
        "name": "CSP",
        "email": "csp@company.com",
        "phone": "4255555555"
      },
      "languageID": "en-us"
    },
    {
      "$schema": "https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5",
      "product": "product/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b",
      "kind": "azure",
      "listing": "listing/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b/public/main/default/en-us",
      "type": "azureLogoScreenshot",
      "languageID": "en-us",
      "description": "Image caption",
      "displayOrder": 0,
      "fileName": "test.png",
      "friendlyName": "test.png",
      "url": "https://company.com/12345/test.png"
    },
    {
      "$schema":  "https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5",
      "product": "product/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b",
      "kind": "azure",
      "listing": "listing/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b/public/main/default/en-us",
      "type": "azureLogoLarge",
      "languageID": "en-us",
      "description": "",
      "displayOrder": 0,
      "fileName": "216x216.png",
      "friendlyName": "216x216.png",
      "url": "https://company.com/12345/216x216.png"
    },
    {
      "$schema": "https://schema.mp.microsoft.com/schema/listing-trailer/2022-03-01-preview5",
      "product": "product/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b",
      "kind": "azure",
      "listing": "listing/6d50c7bd-eb19-4d4c-b2f0-beb14aee084b/public/main/default/en-us",
      "streamingUrl": "https://www.youtube.com/watch?v=123",
      "assets": {
        "en-us": {
          "title": "Video",
          "imageList": [
            {
              "url": "https://company.com/12345/trailer.png"
            }
          ]
        }
      }
    }
  ]
}

Konfigurace cílové skupiny ve verzi Preview

Pokud se váš kontejnerový produkt prodává přes Microsoft Marketplace, musíte definovat cílovou skupinu ve verzi Preview prostřednictvím ID předplatných, kteří můžou váš výpis produktů zkontrolovat, než začne fungovat.

textu ukázkové žádosti, který konfiguruje cílové skupiny verze Preview:

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-offer/2022-03-01-preview3",
     "id": "price-and-availability-offer/a8b48be1-a630-41b5-b5a5-c2a9f7789922",
     "product": "product/a8b48be1-a630-41b5-b5a5-c2a9f7789922",
     "previewAudiences": [
       {
        "type": "subscription",
        "id": "c2d12fa0-c012-33b0-b0a0-c0a0a0011222",
        "label": "Test Subscription"
       }
     ]
    }
  ]
}

Konfigurace plánu – technická konfigurace

Zadejte název typu rozšíření clusteru ve formátu PublisherName.ApplicationName. Název by měl být jedinečný pro všechny vaše nabídky a plány. Tuto hodnotu nemůžete změnit, jakmile je plán publikovaný ve verzi Preview. cs-CZ: Další informace najdete v tématu Nastavení technické konfigurace plánu pro nabídku kontejnerů založenou na aplikaci Kubernetes. Další informace najdete v tématu technické zdroje kontejnerů Azure.

ukázka těla požadavku pro konfigurování transakčního technického nastavení:

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/container-plan-technical-configuration/2022-03-01-preview3",
      "id": "container-plan-technical-configuration/a8b48be1-a630-41b5-b5a5-c2a9f7789922",
      "product": "product/a8b48be1-a630-41b5-b5a5-c2a9f7789922",
      "plan": "plan/a8b48be1-a630-41b5-b5a5-c2a9f7789922/4db792e6-8e10-439d-9db2-a0e98fa7e174",
      "payloadType": " cnab",
      "clusterExtensionType": " unique.extension.type",
      "cnabReferences": [
 {
          "tenantID": "421c00000-ac12-451e-b3ff-c5b469a13e2d",
          "subscriptionID": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
          "resourceGroupName": "TestResources",
          "registryName": "testregistry",
          "repositoryName": "containerrepo",
   "tag": "1.0.4",
          "digest": "sha256:000193bfefde1e9"
        },
      ]
    },
  ]
}

Konfigurace plánu – cena a dostupnost

Ukázkový text požadavku, který konfiguruje skrytý plá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/price-and-availability-plan/2022-03-01-preview4",
      "product": "product/a8b48be1-a630-41b5-b5a5-c2a9f7789922",
      "plan": "plan/a8b48be1-a630-41b5-b5a5-c2a9f7789922/0abbe45b-c405-4c08-bb14-ec485002084e",
      "visibility": "hidden",
      "audience": "public"
    }
  ]
}

Kontejner nabízí podporu různých možností fakturace. Další informace o podporovaných fakturačních modelech najdete v tématu Možnosti licencování.

Verze a aktualizace rozhraní API

Aktualizace Co se změnilo?
1–2024 Všechny koncové body schématu byly aktualizovány z product-ingestion.azureedge.net na schema.mp.microsoft.com

Související obsah