Bagikan melalui

API Penyerapan Produk untuk kontainer

  • Artikel

API Penyerapan Produk adalah API modern yang menyatukan semua API pengiriman yang ada di semua produk marketplace komersial. Lihat API Penyerapan Produk untuk detail tentang cara memulai.

Artikel ini menyediakan panduan tentang cara menggunakan API khusus untuk kontainer.

Mengambil konfigurasi sumber daya yang ada

Ambil semua sumber daya dalam produk tertentu dalam satu panggilan API.

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

Anda dapat mengambil semua konfigurasi sumber daya dalam produk tertentu dengan menggunakan jenis sumber daya "pohon sumber daya" bersama dengan ID tahan lama produk. Versi skema yang Anda berikan digunakan sebagai versi maks yang didukung untuk setiap sumber daya yang berlaku dari produk yang diminta.

Catatan

Jika Anda tidak mengetahui ID produk yang tahan lama, Anda dapat mengambil sumber daya produk terlebih dahulu dengan menggunakan ID eksternal produk sebagai gantinya dan berjalan. Untuk mempelajari lebih lanjut, lihat PRODUCT API: Metode 1: pohon sumber daya.

Contoh panggilan GET:

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

Respons sampel:

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

Menyinkronkan audiens privat

Untuk produk langsung, pembaruan untuk audiens privat di draf, pratinjau, dan lingkungan langsung dapat dilakukan secara bersamaan tanpa memerlukan penerbitan. Anda dapat menyinkronkan audiens privat menggunakan sumber daya "price-and-availability-update-private-audiences" dengan menentukan audiens mana yang ingin Anda tambahkan atau hapus dari paket tertentu. Ini akan menyinkronkan draf, pratinjau, dan lingkungan langsung untuk memiliki nilai audiens privat yang sama. Anda tidak perlu menyediakan sumber daya pengiriman saat menyinkronkan audiens privat.

Untuk mengedit draf audiens, gunakan sumber daya "harga dan paket ketersediaan" dan properti "privateAudiences". Ini harus melalui alur penerbitan reguler agar nilai diatur dalam pratinjau dan langsung.

Penting

Jika produk Anda mendukung lebih dari satu jenis pengidentifikasi untuk mengonfigurasi audiens privat (misalnya, ID penyewa dan ID langganan), Anda harus melakukan penerbitan penuh jika menyediakan jenis pengidentifikasi baru untuk pertama kalinya. Anda tidak dapat menyinkronkan audiens privat dalam kasus ini.

Contoh permintaan untuk menyinkronkan konfigurasi audiens privat:

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

Mengonfigurasi Properti

Tentukan kategori dan industri yang berlaku untuk produk kontainer, versi aplikasi, dan kontrak hukum Anda. Pastikan untuk memberikan detail lengkap dan akurat tentang produk Anda di sumber daya Properti, sehingga ditampilkan dengan tepat dan ditawarkan kepada sekumpulan pelanggan yang tepat. Untuk mempelajari selengkapnya, lihat Kategori appsource.

Contoh isi permintaan yang mengonfigurasi properti:

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

Mengonfigurasi daftar

Informasi yang Anda berikan melalui sumber daya daftar ditampilkan di toko online marketplace komersial Microsoft. Ini termasuk deskripsi produk, cuplikan layar, dan aset pemasaran Anda.

Contoh isi permintaan yang mengonfigurasi daftar:

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

Mengonfigurasi audiens pratinjau

Jika produk kontainer Anda dijual melalui marketplace Microsoft, Anda perlu menentukan audiens pratinjau, melalui ID langganan, yang dapat meninjau daftar produk Anda sebelum ditayangkan.

Contoh isi permintaan yang mengonfigurasi audiens pratinjau:

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

Mengonfigurasi paket - konfigurasi teknis

Berikan nama jenis ekstensi kluster dalam format 'PublisherName.ApplicationName'. Nama harus unik di semua penawaran dan paket Anda. Anda tidak dapat mengubah nilai ini setelah paket diterbitkan ke Pratinjau. Untuk mempelajari lebih lanjut, lihat Mengatur konfigurasi teknis paket untuk penawaran Kontainer berbasis aplikasi Kubernetes. Untuk mempelajari selengkapnya, lihat Aset teknis kontainer Azure.

Contoh isi permintaan mengonfigurasi konfigurasi teknis yang dapat ditransaksikan:

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": "537d2130-be25-451e-b3ff-c5b469a13e2d",
          "resourceGroupName": "TestResources",
          "registryName": "testregistry",
          "repositoryName": "containerrepo",
   "tag": "1.0.4",
          "digest": "sha256:000193bfefde1e9"
        },
      ]
    },
  ]
}

Mengonfigurasi paket - harga dan ketersediaan

Contoh isi permintaan yang mengonfigurasi rencana tersembunyi:

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

Kontainer menawarkan dukungan berbagai opsi penagihan. Untuk mempelajari selengkapnya tentang model penagihan yang didukung, lihat Opsi lisensi.

Versi dan pembaruan API

Pembaruan Apa yang telah berubah?
1-2024 Semua titik akhir skema telah diperbarui dari product-ingestion.azureedge.net ke schema.mp.microsoft.com

Konten terkait