다음을 통해 공유


컨테이너에 대한 제품 수집 API

제품 수집 API는 모든 상업용 Marketplace 제품에서 모든 기존 제출 API를 통합하는 현대화된 API입니다. 시작하는 방법에 대한 자세한 내용은 제품 수집 API를 참조하세요.

이 문서에서는 컨테이너에 특별히 API를 사용하는 방법에 대한 지침을 제공합니다.

기존 리소스 구성 검색

단일 API 호출에서 특정 제품 내의 모든 리소스를 검색합니다.

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

제품의 지속성 ID와 함께 "리소스 트리" 리소스 유형을 사용하여 특정 제품 내의 모든 리소스 구성을 검색할 수 있습니다. 제공하는 스키마 버전은 요청된 제품의 적용 가능한 각 리소스에 대해 지원되는 최대 버전으로 사용됩니다.

참고 항목

제품의 지속성 ID를 모르는 경우 제품의 외부 ID를 대신 사용하고 실행하여 먼저 제품 리소스를 검색할 수 있습니다. 자세한 내용은 Product 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" 리소스를 사용하여 개인 대상 그룹을 동기화할 수 있습니다. 이렇게 하면 초안, 미리 보기 및 라이브 환경이 동기화되어 개인 대상 그룹 값이 동일합니다. 비공개 대상 그룹을 동기화할 때 제출 리소스를 제공할 필요가 없습니다.

초안 대상 그룹을 편집하려면 "가격 및 가용성 계획" 리소스 및 "privateAudiences" 속성을 사용합니다. 미리 보기 및 라이브로 설정되는 값에 대한 일반 게시 흐름을 거쳐야 합니다.

Important

제품이 비공개 대상 그룹을 구성하는 데 여러 식별자 유형을 지원하는 경우(예: 테넌트 ID와 구독 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/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"
        }
      ]
    }
  }
 ]
}

속성 구성

컨테이너 제품, 앱 버전 및 법적 계약에 적용되는 범주 및 산업을 정의합니다. 속성 리소스에서 제품에 대한 완전하고 정확한 세부 정보를 제공하여 적절한 고객 집합에 적절하게 표시되도록 해야 합니다. 자세한 내용은 Appsource 범주를 참조하세요.

속성 구성 샘플 요청 본문:

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

목록 구성

목록 리소스를 통해 제공하는 정보는 Microsoft 상업용 Marketplace 온라인 스토어에 표시됩니다. 여기에는 제품, 스크린샷 및 마케팅 자산에 대한 설명이 포함됩니다.

샘플 요청 본문 구성 목록:

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

미리 보기 대상 구성

컨테이너 제품이 Microsoft Marketplace를 통해 판매되는 경우 구독 ID를 통해 미리 보기 대상 그룹을 정의해야 합니다. 구독 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/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"
       }
     ]
    }
  ]
}

계획 구성 - 기술 구성

클러스터 확장 유형 이름을 'PublisherName.ApplicationName' 형식으로 제공합니다. 이름은 모든 제안 및 계획에서 고유해야 합니다. 계획이 미리 보기에 게시되면 이 값을 수정할 수 없습니다. 자세한 내용은 Kubernetes 애플리케이션 기반 컨테이너 제품에 대한 계획 기술 구성 설정을 참조 하세요. 자세한 내용은 Azure 컨테이너 기술 자산을 참조 하세요.

트랜잭션 가능한 기술 구성을 구성하는 샘플 요청 본문:

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

플랜 구성 - 가격 및 가용성

숨겨진 계획을 구성하는 샘플 요청 본문:

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

컨테이너는 다양한 청구 옵션을 지원합니다. 지원되는 청구 모델에 대한 자세한 내용은 라이선스 옵션을 참조 하세요.

API 버전 및 업데이트

Update 무엇이 변경되었나요?
1-2024 모든 스키마 엔드포인트가 product-ingestion.azureedge.net schema.mp.microsoft.com 업데이트되었습니다.