容器的產品擷取 API

發行項
06/14/2024

產品擷取 API 是現代化 API，可統一所有商業市集產品的所有現有提交 API。如需如何開始使用的詳細資訊，請參閱產品擷取 API。

本文提供如何特別針對容器使用 API 的指引。

擷取現有的資源組態

在單一 API 呼叫中擷取特定產品中的所有資源。

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

您可以使用「資源樹狀結構」資源類型，以及產品的耐久標識符，擷取特定產品內的所有資源組態。您提供的架構版本會作為所要求產品每個適用資源的最大支援版本。

注意

如果您不知道產品的耐久標識符，您可以改為使用產品的外部標識碼並執行，先擷取產品資源。若要深入瞭解，請參閱產品 API：方法 1：資源樹狀結構。

範例 GET 呼叫：

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

範例回應：

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

同步處理私人適用對象

針對實時產品，可以同時執行草稿、預覽和實時環境的私用物件更新，而不需要發佈。您可以使用「price-and-availability-update-private-audiences」資源同步處理私人物件，方法是指定要從特定方案中新增或移除哪些物件。這會同步草稿、預覽和實時環境，以擁有相同的私人物件值。同步處理私人物件時，您不需要提供提交資源。

若要編輯草稿物件，請使用“price-and-availability-plan” 資源和 “privateAudiences” 屬性。這需要經過一般發佈流程，才能在預覽和實時中設定值。

重要

如果您的產品支援多個識別碼類型來設定私人物件（例如，租使用者標識碼和訂用帳戶標識碼），則第一次提供新的標識符類型時，您必須執行完整發佈。在此情況下，您無法同步處理私人物件。

同步私人物件設定的範例要求：