Aracılığıyla paylaş

Kapsayıcılar için Ürün Alımı API'si

  • Makale

Ürün Alımı API'si, tüm ticari market ürünlerinde mevcut tüm gönderim API'lerini birleştiren modernleştirilmiş bir API'dir. Kullanmaya başlama hakkında ayrıntılı bilgi için Ürün Alımı API'sine bakın.

Bu makalede, API'lerin özellikle kapsayıcılar için nasıl kullanılacağına ilişkin yönergeler sağlanır.

Mevcut kaynak yapılandırmalarını alma

Tek bir API çağrısında belirli bir ürün içindeki tüm kaynakları alın.

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

"Kaynak ağacı" kaynak türünü ve ürünün dayanıklı kimliğini kullanarak belirli bir üründeki tüm kaynak yapılandırmalarını alabilirsiniz. Sağladığınız şema sürümü, istenen ürünün geçerli kaynaklarının her biri için desteklenen en yüksek sürüm olarak kullanılır.

Not

Ürünün dayanıklı kimliğini bilmiyorsanız, bunun yerine ürünün dış kimliğini kullanıp çalıştırarak önce ürün kaynağını alabilirsiniz. Daha fazla bilgi edinmek için bkz . Ürün API'si: Yöntem 1: kaynak ağacı.

Örnek GET çağrısı:

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

Örnek yanıt:

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

Özel hedef kitleleri eşitleme

Canlı bir ürün için taslak, önizleme ve canlı ortamlardaki özel hedef kitlelere yönelik güncelleştirmeler, yayımlama gerektirmeden aynı anda gerçekleştirilebilir. Belirli bir plana hangi hedef kitleleri eklemek veya kaldırmak istediğinizi belirterek "price-and-availability-update-private-audiences" kaynağını kullanarak özel hedef kitleyi eşitleyebilirsiniz. Bu işlem taslak, önizleme ve canlı ortamları aynı özel hedef kitle değerlerine sahip olacak şekilde eşitler. Özel hedef kitleyi eşitlerken gönderim kaynağını sağlamanız gerekmez.

Taslak hedef kitleleri düzenlemek için "price-and-availability-plan" kaynağını ve "privateAudiences" özelliğini kullanın. Değerlerin önizlemede ve canlı olarak ayarlanması için normal yayımlama akışından geçmesi gerekir.

Önemli

Ürününüz özel hedef kitleyi (örneğin, hem kiracı kimlikleri hem de abonelik kimlikleri) yapılandırmak için birden fazla tanımlayıcı türünü destekliyorsa, ilk kez yeni bir tanımlayıcı türü sağlıyorsanız tam yayımlama gerçekleştirmeniz gerekir. Bu durumda özel hedef kitleyi eşitleyemezsiniz.

Özel hedef kitle yapılandırmasını eşitlemek için örnek istek:

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

Özellikleri Yapılandırma

Kapsayıcı ürününüz, uygulama sürümünüz ve yasal sözleşmeleriniz için geçerli kategorileri ve endüstrileri tanımlayın. Ürününüzün uygun şekilde görüntülenmesi ve doğru müşteri kümesine sunulması için Özellikler kaynağında ürününüzle ilgili tam ve doğru ayrıntıları sağladığınızdan emin olun. Daha fazla bilgi için bkz . Appsource kategorileri.

Örnek istek gövdesi yapılandırma özellikleri:

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

Listelemeyi yapılandırma

Listeleme kaynakları aracılığıyla sağladığınız bilgiler Microsoft ticari market çevrimiçi mağazalarında görüntülenir. Buna ürününüzün açıklamaları, ekran görüntüleri ve pazarlama varlıklarınız dahildir.

Örnek istek gövdesi yapılandırma listesi:

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

Önizleme hedef kitlesini yapılandırma

Kapsayıcı ürününüz Microsoft market üzerinden satılırsa, abonelik kimlikleri aracılığıyla bir önizleme hedef kitlesi tanımlamanız gerekir. Bu hedef kitle, ürün listelemenizi canlı yayına geçmeden önce inceleyebilir.

Önizleme hedef kitlesini yapılandıran örnek istek gövdesi:

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

Plan yapılandırma - teknik yapılandırma

'PublisherName.ApplicationName' biçiminde bir küme uzantısı türü adı sağlayın. Ad, tüm teklif ve planlarınızda benzersiz olmalıdır. Plan Önizleme'de yayımlandıktan sonra bu değeri değiştiremezsiniz. Daha fazla bilgi edinmek için bkz . Kubernetes uygulama tabanlı Kapsayıcı teklifi için plan teknik yapılandırmasını ayarlama. Daha fazla bilgi edinmek için bkz . Azure kapsayıcısı teknik varlıkları.

İşlem yapılabilir teknik yapılandırmayı yapılandıran örnek istek gövdesi:

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

Plan yapılandırma - fiyat ve kullanılabilirlik

Gizli planı yapılandıran örnek istek gövdesi:

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

Kapsayıcı çeşitli faturalama seçeneklerini destekler. Desteklenen faturalama modelleri hakkında daha fazla bilgi edinmek için bkz . Lisanslama seçenekleri.

API sürümleri ve güncelleştirmeleri

Güncelleştirme Neler değişti?
1-2024 Tüm şema uç noktaları product-ingestion.azureedge.net schema.mp.microsoft.com güncelleştirildi

İlgili içerik