Ticari market için Ürün Alımı API'si

Makale
12/15/2023

Ü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. API, İş Ortağı Merkezi hesabınızda ürün ve planlarla ilişkili kaynakları oluşturmanıza, yayımlamanıza ve yönetmenize olanak tanır. İstek göndermek için bildirim temelli bir desen kullanır ve istenen duruma ulaşmak için tek tek adımları belirtmek yerine istenen durum belirtilir.

Bu makalede, herhangi bir ticari market teklif türü için API'leri kullanmaya başlama hakkında rehberlik sağlanır. Ürün Alımı API'si şu anda SaaS, VM'ler, Özel teklifler ve kapsayıcı teklifi türleri için desteklenmektedir ve önizleme aşamasındadır. Teklifinize özgü yönergeler için teklif türüne göre API kılavuzu sayfasını gözden geçirin.

Önemli

Azure Active Directory (Azure AD) Graph, 30 Haziran 2023 itibarıyla kullanım dışı bırakılmıştır. Bundan sonra Azure AD Graph'a başka yatırım yapmayız. Azure AD Graph API'lerinin güvenlikle ilgili düzeltmelerin ötesinde SLA veya bakım taahhüdü yoktur. Yeni özelliklere ve işlevlere yapılan yatırımlar yalnızca Microsoft Graph'ta yapılacaktır.

Uygulamalarınızı Microsoft Graph API'lerine geçirmek için yeterli zamanınız olması için Azure AD Graph'ı artımlı adımlarla kullanımdan alacağız. Duyuracağımız sonraki bir tarihte, Azure AD Graph kullanarak yeni uygulamaların oluşturulmasını engelleyeceğiz.

Daha fazla bilgi edinmek için bkz . Önemli: Azure AD Graph Kullanımdan Kaldırma ve PowerShell Modülü Kullanımdan Kaldırma.

Kullanmaya başlama

Ürün Alımı API'sine"product-ingestion" iş yükü adı altında MSGraph API'sini kullanarak erişilebilir. Temel URL'si şeklindedir https://graph.microsoft.com/rp/product-ingestion.

Ürün Alımı API'sini kullanmak için önce aşağıdakileri edinmeniz gerekir:

Bir Microsoft Entra Kimliği ve dizin için Genel yönetici izinlerine sahip olduğunuzdan emin olun
Microsoft Entra uygulaması
Microsoft Entra erişim belirteci

1. Adım: Önkoşulları tamamlama

Ürün Alımı API'sini çağırmak için kod yazmaya başlamadan önce aşağıdaki önkoşulları tamamladığınızdan emin olun.

Sizin (veya kuruluşunuzun) bir Microsoft Entra dizinine sahip olması ve dizin için Genel yönetici izniniz olması gerekir. Microsoft 365 veya Microsoft'un diğer iş hizmetlerini zaten kullanıyorsanız, Microsoft Entra dizininiz zaten vardır. Aksi takdirde, İş Ortağı Merkezi'nde ek ücret ödemeden yeni bir Microsoft Entra Kimliği oluşturabilirsiniz.
Bir Microsoft Entra uygulamasını İş Ortağı Merkezi hesabınızla ilişkilendirmeniz ve kiracı kimliğinizi, istemci kimliğinizi ve anahtarınızı almanız gerekir. Microsoft Store gönderim API'sine yapılan çağrılarda kullanacağınız Microsoft Entra erişim belirtecini almak için bunlara ihtiyacınız vardır.

Microsoft Entra uygulamasını İş Ortağı Merkezi hesabınızla ilişkilendirme

Ürün Alımı API'sini kullanmak için bir Microsoft Entra uygulamasını İş Ortağı Merkezi hesabınızla ilişkilendirmeniz, uygulamanın kiracı kimliğini ve istemci kimliğini almanız ve bir anahtar oluşturmanız gerekir. Microsoft Entra uygulaması, Ürün Alımı API'sini çağırmak istediğiniz uygulamayı veya hizmeti temsil eder. API'ye geçirmek üzere bir Microsoft Entra erişim belirteci almak için kiracı kimliğine, istemci kimliğine ve anahtara ihtiyacınız vardır.

Not

Bu görevi yalnızca bir kez gerçekleştirmeniz gerekir. Kiracı kimliğiniz, istemci kimliğiniz ve anahtarınız olduktan sonra, yeni bir Microsoft Entra erişim belirteci oluşturmanız gerektiğinde bunları yeniden kullanabilirsiniz.

İş Ortağı Merkezi'nde, kuruluşunuzun İş Ortağı Merkezi hesabını kuruluşunuzun Microsoft Entra diziniyle ilişkilendirin.
İş Ortağı Merkezi'nin Hesap ayarları bölümündeki Kullanıcılar sayfasından, İş Ortağı Merkezi hesabınızın gönderimlerine erişmek için kullanacağınız uygulamayı veya hizmeti temsil eden Microsoft Entra uygulamasını ekleyin. Bu uygulamaya Yönetici rolünü atadığınızdan emin olun. Uygulama henüz Microsoft Entra dizininizde yoksa İş Ortağı Merkezi'nde yeni bir Microsoft Entra uygulaması oluşturun. İş Ortağı Merkezi, uygulama için biri hizmet sorumlusu, diğeri de Microsoft Entra uygulama türü olarak iki tür girdi oluşturur.
Kullanıcılar sayfasına dönün, Microsoft Entra uygulamanızın adını seçerek uygulama ayarlarına gidin ve Kiracı Kimliği ile İstemci Kimliği değerlerini kopyalayın.
Yeni anahtar ekle'yi seçin. Aşağıdaki ekranda Anahtar değerini kopyalayın. Bu sayfadan ayrıldıktan sonra bu bilgilere yeniden erişemezsiniz. Daha fazla bilgi için bkz . Microsoft Entra uygulaması için anahtarları yönetme.

2. Adım: Microsoft Entra erişim belirtecini alma

Ürün Alımı API'sindeki yöntemlerden herhangi birini çağırmak için öncelikle API'deki her yöntemin Yetkilendirme üst bilgisine geçirmek üzere bir Microsoft Entra erişim belirteci edinmeniz gerekir. Erişim belirtecinin süresi vermeden 60 dakika sonra dolar. Bundan sonra, API'ye gelecek çağrılarda kullanabilmek için yenileyebilirsiniz.

Erişim belirtecini almak için, uç noktaya bir göndermek HTTP POST için İstemci Kimlik Bilgilerini Kullanarak Hizmete Hizmet Çağrıları başlığındaki https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token yönergeleri izleyin. Örnek bir istek aşağıda verilmiştir:

POST https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded;

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&scope=https://graph.microsoft.com/.default

POST URI'sindeki tenant_id değeri ile client_id ve client_secret parametreleri için, önceki bölümde İş Ortağı Merkezi'nden aldığınız kiracı kimliğini, istemci kimliğini ve uygulamanızın anahtarını belirtin. Kapsam parametresi için belirtmelisiniz https://graph.microsoft.com/.default.

Kavramlar

Başlamadan önce bazı temel kavramları anlamanız gerekir.

Kaynaklar

API, "$schema" özelliği tarafından başvurulduğu gibi her türün ayrılmış bir şema tanımı kullanılarak açıklandığı kaynak türleri etrafında yapılandırılmıştır. Şema, bu kaynağın yapılandırma özelliklerinden oluşur. Kaynaklar, belirli bir ürünün çeşitli yönlerinin yapılandırmasını oluşturma ve güncelleştirme konusunda temeldir. Kaynak türlerinin ve bunların şemalarının tam listesi için kaynak API'sinin başvurusuna bakın.

Dayanıklı Kimlik

Dayanıklı kimlik, herhangi bir kaynağı benzersiz olarak tanımlamak için kullanılan sistem tarafından oluşturulan genel tanımlayıcıdır. Her kaynağın, kaynak türü adıyla birleştirildiğinde kaynağın dayanıklı kimliğini oluşturan ilişkili bir "ID" özelliği vardır. Dayanıklı kimlik, almak veya değiştirmek için kaynaklara başvururken kullanılır.

Biçim:

\<resource-type>/\<id>

Örnek:

            { 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
                "id": "product/12345678-abcd-efgh-1234-12345678901", // durable ID
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo"
                },
                "type": "softwareAsAService", // Product types that can be specified include azureContainer, azureVirtualMachine, softwareAsAService
                "alias": "Contoso Image Resizing Service"
            }

Dış Kimlik

Dış kimlik , belirli ürünlere veya planlara başvurmak için kullanılabilecek başka bir benzersiz tanımlayıcıdır. Bu, dayanıklı kimliği kullanmak yerine bu kaynaklara başvurmanın alternatif bir yoludur. Bir ürünün dış kimliği "offerID"sine, planın dış kimliği ise "identity" özelliği altında oluşturulduklarında tanımlandığı gibi "planID"sine çevrilir.

Örnek:

            { 
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
                "id": "plan/12345678-abcd-efgh-1234-12345678901/4e0bfefa-b993-4b79-a426-871c3bf236a5",
                "identity": {
                  "externalID": "gold-annual"
                },
                "azureRegions": [
                    "azureGlobal"
                  ],
                "alias": "Gold - Annual payment",
                "product": "product/12345678-abcd-efgh-1234-12345678901",
            }

API Yöntemleri

Mevcut kaynakları sorgulama, yapılandırma güncelleştirmeleri yapma ve isteğin durumunu denetleme gibi farklı eylemler gerçekleştirmek için kullanılabilecek dört yönetim API'si vardır.

Not

Tüm istekler, yanıtın bir parçası olarak istediğiniz şema sürümünü ($version sorgu parametresi) ayarlamanızı gerektirir.

API türü	Açıklama	HTTP yöntemi ve yolu
Sorgu	Var olan kaynakları şu şekilde alır: -Yöntem 1: "resource-tree" kaynak türü -Yöntem 2: durable-id -Yöntem 3: sorgu dizesi parametreleri	-Yöntem 1: `GET resource-tree/<product-durableID>` -Yöntem 2: `GET <resource-durableID>` -Yöntem 3: `GET <resourceType>?<query parameters>`
Göndermeyi yapılandırma	Bir veya daha fazla kaynak oluşturma veya güncelleştirme istekleri gönderir. İşlem başarılı olduğunda, isteğin durumunu almak için kullanılabilecek bir jobID döndürülür. Bu API türü taslak durumunu güncelleştirmek ve değişiklikleri yayımlamak, özel hedef kitleleri eşitlemek ve kaynak yaşam döngüsü durumunu değiştirmek için kullanılabilir.	`POST configure`
Durumu yapılandırma	Bekleyen isteğin durumunu jobID aracılığıyla alır.	`GET configure/<jobID>/status`
Durum ayrıntılarını yapılandırma	jobID aracılığıyla güncelleştirilmiş kaynaklar da dahil olmak üzere tamamlanmış bir isteğin ayrıntılı özetini alır.	`GET configure/<jobID>`
Yapılandırmayı İptal Et	Belirtilen Yapılandırma işini iptal eder.	`POST configure/<jobID>/cancel`

Tipik bir iş akışı

Mevcut bir kaynağı güncelleştirmek için tipik bir iş akışı şu şekilde olabilir:

Var olan bir kaynak yapılandırmasını alma (API türü: Resource-tree aracılığıyla sorgu)*
Gerekli güncelleştirmeleri yapın ve ardından bir yapılandırma isteği gönderin (API türü: Göndermeyi yapılandırma)
İsteğin durumunu denetleyin (API türü: Durumu yapılandırma ve Durum ayrıntılarını yapılandırma)

*Yeni kaynaklar oluşturulurken aynı iş akışı uygulanabilir, ancak kaynakları almak yerine (1. Adım), oluşturduğunuz kaynak türü için geçerli şemayı kullandığınızdan emin olmak için Kaynak API'si başvuru tablosunu kullanın.

Özetlemek gerekirse, bu görüntüde, yeni bir kaynak oluştururken veya var olan bir kaynağı değiştirirken bir yapılandırma isteği göndermek için kullanılan tipik çağrı deseni gösterilir.

Screenshot illustrating the typical calling pattern used to submit a configuration request.

Not

Teklif türü başına API kılavuzu bölümüne bakarak yönettiğiniz teklif türüne özgü ek önkoşulları gözden geçirmeyi unutmayın.

Mevcut kaynak yapılandırmalarını alma

Mevcut kaynakları güncelleştirmeden önce en son yapılandırmaya sahip olduğunuzdan emin olmak için bunları almak önemlidir. GET çağrısı aracılığıyla kaynakları almanın çeşitli yolları vardır. Tek bir API çağrısında belirli bir üründeki tüm kaynakları almak için aşağıda ayrıntılı olarak yer alan Yöntem 1'e bakın.

Yöntem 1: Kaynak ağacı

Schema: https://``schema.mp.microsoft.com``/schema/resource-tree/2022-03-01-preview2

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.

Kullanılabilir en son şema sürümü her kaynak için farklı olabilir. Bir kaynak ağacı isteği gerçekleştirirken, belirtilen şema sürümü, üründeki her kaynak için hangi sürümün döndürüleceklerini belirler. Belirtilen sürüm, eşit veya daha düşük sürümdeki tüm kaynaklar için kullanılabilen en son şema sürümünü döndürmesi için "en yüksek" sürüm sınırı işlevi görür. Örneğin, kullanılabilir en son plan listeleme sürümü "2022-03-01-preview3" ise, kaynak ağacı GET isteğinde "2022-03-01-preview5" belirtmeniz durumunda yanıt bu sürümü gösterir. Ancak, kaynak ağacı sürümü olarak "2022-03-01-preview2" isteniyorsa, en son sürüm "2022-03-01-preview3" olsa bile bu, "2022-03-01-preview2" plan listeleme kaynağını döndürür. Güncelleştirilmiş şemayı yeni desteklenen özelliklerle kullandığınızdan emin olmak için her kaynağın kullanılabilir en son sürümünü kullanmanız önerilir.

Not

Ürünün dayanıklı kimliğini bilmiyorsanız, komutunu çalıştırarak GET product?externalID=<product-externalID>&$version=<product-schema-version>ürün kaynağını almak için ürünün dış kimliğini kullanabilirsiniz. Bu istek, aşağıdaki yöntem 3'te ayrıntılı olarak yer alan bir sorgu dizesi parametresinden yararlanıyor. Yanıt, ürünün gelecekteki istekler için kullanabileceğiniz dayanıklı kimliğini içerir.

Varsayılan olarak, "resource-tree" kullanarak bir GET çağrısı çalıştırdığınızda kaynaklarınızın taslak sürümünü geri alırsınız. Ancak, "targetType" sorgu parametresini geçirerek, "önizleme" veya "canlı" verileri almak için istenen hedefi belirtebilirsiniz. Aşağıdaki örnekte GET çağrısı, "12345678-abcd-efgh-1234-12345678901" ürünü altındaki tüm kaynaklar için önizleme ortamının yapılandırmasını döndürür.

Ö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": "ds-contoso-image-resize-demo"
            },
            "type": "softwareAsAService",
            "alias": "Contoso Image Resizing Service"
          },
          { 
            "$schema": "https://schema.mp.microsoft.com/schema/property/2022-03-01-preview3",
            "id": "property/12345678-abcd-efgh-1234-12345678901/public/main",
            "product": "product/12345678-abcd-efgh-1234-12345678901",
            "kind": "azureSaaS",
            "termsConditions": "false",
            "categories": {
          "developer-tools-saas": [
            "devService"
          ]
            }
          },
          {
            "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
            "id": "plan/12345678-abcd-efgh-1234-12345678901/4e0bfefa-b993-4b79-a426-871c3bf236a5",
            "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468",
          ...
          }, 
              // The response would include all existing resources within this product.
          {
              ...
          }]
        }

Yöntem 2: Dayanıklı Kimlik

GET <resource-durableID>?$version=<schema-version>

Dayanıklı kimliğini kullanarak belirli bir kaynağı alın. Kaynak oluşturulduktan sonra dayanıklı kimlik her zaman aynı kalır ve GET yöntemi çağrılarak bu kaynağın en son taslak değişikliklerini almak için kullanılabilir. Örneğin, aşağıdaki istek "2022-03-01-preview3" şema sürümünü kullanarak bu ürünün taslak yapılandırmasını döndürür.

GET product/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview3

Önemli

Bu yöntem yalnızca taslak yapılandırmasını almak için kullanılır. Önizleme veya canlı verileri almak isterseniz, yukarıda açıklandığı gibi "resource-tree" yöntemini kullanın.

Kaynaklarınızın dayanıklı kimliğini bulmak için şunları yapabilirsiniz:

Ürün içindeki tüm kaynakları ilgili dayanıklı kimlikleriyle birlikte getirmek için "resource-tree" yöntemini kullanın veya
İsteğin bir parçası olarak oluşturulan veya güncelleştirilen tüm kaynakların dayanıklı kimliklerini içeren tamamlanmış bir kaynak yapılandırma isteğinin ayrıntılarını alın.

"Id" özelliğinin ilgili kaynağın durable-id değeri olduğunu unutmayın.

Yöntem 3: Sorgu dizesi parametreleri

GET <resourceType>?<query parameters>&$version=<schema-version>

Bu yöntem, belirli bir hesapla ilişkili belirli kaynak türlerini sorgulamak için kullanılır. Örneğin, tek bir GET çağrısıyla belirli bir ürün türüne ait tüm ürünlerinizi alabilirsiniz. Sorgu dizesi parametreleri, ürünlerinize, planlarınıza veya gönderimlerinize ilişkin ayrıntıları sorgulamak için kullanılır.

Bu tablo, desteklenen kaynak türlerinin her biri için desteklenen sorgu parametrelerini gösterir. Tüm kaynak türleri sorgu parametrelerinin her birini desteklemez. Şu anda desteklenen sorgu dizelerinin tam listesi için bu tabloya başvurun.

Kaynak türü	Parametreler	Sorgu dizesi örnekleri
Plan	Ürün`` externalID $maxpagesize continuationToken$version``	`GET plan?product=<product-durableID>&$version=<schema-version>` `GET plan?product=<product-durableID>&externalID=<plan-externalID>&$version=<schema-version>` `GET plan?product=<product-durableID>&$maxpagesize=<#>&$version=<schema-version>` `GET plan?product=<product-durableID>&continuationToken=<token>&$version=<schema-version>`
Ürün	externalID Tür $maxpagesize continuationToken$version`*`	`GET product?externalID=<product-externalID>&$version=<schema-version>` `GET product?type=<product-type>&$version=<schema-version>` `GET product?$maxpagesize=<#>&$version=<schema-version>` `GET product?continuationToken=<token>&$version=<schema-version>`
Gönderme	Targettype $maxpagesize continuationToken$version`*`	`GET submission/<product-durableID>?targetType=<environment>&$version=<schema-version>` `GET submission/<product-id>?$maxpagesize=<#>&continuationToken=<token>&$version=<schema-version>`
kaynak ağacı	targetType$version`*`	`GET resource-tree/<product-durableID>?targetType=<environment>&$version=<schema-version>`

* Ürün ve $version parametreleri her zaman gereklidir.

Desteklenen sorgu parametrelerinin her birinin işlevselliği:

product – "plan" kaynak türü bağlamında "ürün" parametresini geçirirken, ilgili ürün içindeki tüm planları döndürür.
externalID – "externalID" parametresini bir ürün veya plan bağlamında geçirirken ilgili ürünün veya planın yapılandırmasını döndürür. "resource-tree" yönteminin aksine, bu sorgu dizesi parametresi içindeki tüm kaynakları değil, yalnızca bu kaynağın ayrıntılarını döndürür.
type – "type" parametresini "ürün" kaynak türü bağlamında geçirirken, hesabınızla ilişkili bu türdeki tüm ürünleri döndürür. Örneğin, "type=softwareAsAService" belirterek tüm SaaS ürünleriniz döndürülür.
targetType : Bu, kullanılan kaynak türü bağlamında belirli bir ortamın verilerini döndürür. Desteklenen "targetType" değerleri "taslak", "önizleme" veya "live" değerleridir.
$maxpagesize – Maksimum sayfa boyutu pozitif tamsayı biçiminde belirtilerek, bu parametre önceki gönderimlerinizi sorgularken aramanızın sonuçlarını sınırlamak için kullanılır.
continuationToken : Bu parametre, aramanızda kullanılabilen başka bir sonuç kümesini sorgulamak için "$maxpagesize" parametresiyle kullanılabilir. "continuationToken" değeri önceki sayfanın yanıtında sağlanır.
$version – Bu, tüm çağrılar için gerekli bir parametredir, yaptığınız istekten gelen yanıt için hangi şema sürümünü istediğinizi belirtir. Kullanılabilir en son şema sürümü her kaynak için farklı olabilir ve belirtilen sürüm "en yüksek" sürüm sınırı görevi görür. Sistem, varsa tam şema sürümünü veya istenen sürümden daha eski olan en yakın sürümü döndürür. Bu, daha yeni şema değişiklikleri olsa bile kodunuzun çalışmasını sağlamaya yardımcı olabilir, ancak en son özellikleri kullanmak için her şemanın kullanılabilir en son sürümünü kullanmanız önerilir.

Gönderimlerinizi sorgulama

yaparak GET submission/<product-durableID>mevcut ürün gönderimlerinizi alabilirsiniz. Varsayılan olarak, taslak başvurusu da dahil olmak üzere tüm etkin gönderimlerinizi geri alırsınız, ancak "targetType" sorgu parametresini kullanarak belirli bir ortamı sorgulayabilirsiniz: (GET submission/<product-durableID>?targetType=<environment>&$version=<version>).

Önemli

"Önizleme" gönderimi "Canlı" olarak gönderildiğinde, önceki "Canlı" gönderimin yerini alır. Bu durumda veriler artık "Önizleme" ve "Canlı" ortamlarını temsil eder ve "Önizleme" için yeni bir gönderim yayımlanır.

Örnek istek:

GET https://graph.microsoft.com/rp/product-ingestion/submission/12345678-abcd-efgh-1234-12345678901?$version=2022-03-01-preview2

Örnek yanıt:

Bu örnekte, "12345678-abcd-efgh-1234-12345678901" ürün kimliğiyle ilişkili etkin gönderimler için GET isteği gösterilmektedir. Etkin "Canlı" gönderimi (gönderim/12345678-abcd-efgh-1234-12345678901/1152921515689847470) önce ve sonra canlı olarak önizleme için yayımlandı. Bu gönderim 25 Ocak 2022'de canlı yayına gönderildiğinde, yeni bir önizleme gönderimi (gönderim/12345678-abcd-efgh-1234-12345678901/1152921515689848683) 4 Şubat 2022'de oluşturulana kadar hem önizlemeyi hem de canlı yayını temsil etti.

            {
              "value": [
                {
                  "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                  "id": "submission/12345678-abcd-efgh-1234-12345688901/0",
                  "product": "product/12345678-abcd-efgh-1234-12345678901",
                  "target": {
                    "targetType": "draft"
                  }
                },
                {
                  "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                  "id": "submission/12345678-abcd-efgh-1234-12345678901/1152921515689847470",
                  "product": "product/12345678-abcd-efgh-1234-12345678901",
                  "target": {
                    "targetType": "live"
                  },
                  "status": "completed",
                  "result": "succeeded",
                  "created": "2022-01-25T07:13:06.4408032Z"
                },
                {
                  "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                  "id": "submission/12345678-abcd-efgh-1234-12345678901/1152921515689848683",
                  "product": "product/12345678-abcd-efgh-1234-12345678901",
                  "target": {
                    "targetType": "preview"
                  },
                  "status": "completed",
                  "result": "succeeded",
                  "created": "2022-02-04T20:07:22.4220588Z"
                }
              ]
            }

Yeni ürünler ve kaynaklar oluşturma

Tek bir yapılandırma isteğinin parçası olarak yeni ürünler de dahil olmak üzere yeni kaynaklar oluşturabilirsiniz. Kaynak API'si başvuru tablosunu kullanarak, oluşturmak istediğiniz kaynak türünün şemasını alabilirsiniz. Bu, en son şemayı kullanmanızı ve bu nedenle kaynağı oluşturmak için gerekli tüm özellikleri yapılandırmanızı sağlar.

Yeni bir ürün oluşturuyorsanız gereksinimler ürün türüne göre farklılık gösterir. Bu nedenle farklı kaynaklar sağlamanız gerekir. İsteğinizdeki temel gereksinimleri yapılandırdığınızdan emin olmak için ilgili ürün türü için ilgili ticari market belgelerine başvurabilirsiniz. Alternatif olarak, yalnızca ürün kaynağını kullanarak bir yapılandırma isteğinde bulunabilirsiniz. Ürünü oluşturduktan sonra, oluşturulan ürün kaynağını almak ve kaynak ağacı Sorgu API'sini çağırmak için dayanıklı kimliğini bulmak için yapılandırma durumu ayrıntıları API'sini çağırın. Yanıt, oluşturduğunuz ürün türü için geçerli desteklenen kaynakları döndürür.

Benzer şekilde, mevcut bir ürün içinde yeni bir kaynak oluşturmak için, bu kaynak türünün en son şemasını da almanız gerekir. Kaynak bağımlılıklarını gözden geçirerek yapılandırma isteğinin bir parçası olarak bağımlı kaynakları sağladığından emin olun.

Şemaları kullanarak kaynaklarınızı yapılandırdıktan sonra yapılandırma isteğinde bulunmayı öğrenin.

Mevcut ürünleri ve kaynakları değiştirme

Yapılandırma yükünü kullanarak güncelleştirmeleri gönderebilirsiniz. Bu yük bir veya daha fazla kaynak türünden oluşur ve "$schema" özelliği başvurulmakta olan kaynak türünü gösterir.

İpucu

En son yapılandırmadan yararlandığınızdan emin olmak için güncelleştirmeleri yayımlamadan önce mevcut kaynakları almanızı öneririz.

Kaynaklarınızı değiştirdikten sonra yapılandırma isteğinde bulunmayı öğrenin.

Yapılandırma istekleri

Aynı yükte düzenleyebilir ve yayımlayabilirsiniz. Yapılandırma isteği göndermek için yapılandırma API'sinin HTTP POST yöntemini kullanın. Yapılandırma yükü, istenen değişiklikleri gösteren bir kaynak dizisini içerir. Taslak değişikliklerinizi yayımlamak için açıkça bir gönderim kaynağı gönderene kadar tüm düzenlemeler yalnızca taslak sürümü etkiler. Önizleme veya canlı yayın yaparken gönderim kaynağını ekleyin ve hedef ortamı belirtin. İstek göndermeden önce kaynaklara nasıl başvurabileceğinizi ve bağımlılıklarını nasıl anlayacağınızı bilmeniz gerekir.

Schema:<https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2>

Yapılandırma isteğinizi gönderdikten sonra, isteğinizin ilerleme durumunu ve sonuçlarını izlemek için kullanabileceğiniz jobID ile bir yapılandırma durumu nesnesi alırsınız.

Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>

Kaynak başvuruları ve bağımlılıkları

Başvurular

Yapılandırma isteğinde var olan bir kaynağa başvurmak için kaynağın "$schema" türünü kaynağın dayanıklı kimliğiyle birlikte sağlayın. Ürünler ve planlar söz konusu olduğunda, bu kaynaklara dış kimlikleri aracılığıyla da başvurabilirsiniz.

Dayanıklı kimlik , "Id" özelliğinde bulunabilir, örneğin başka bir kaynakta başvurmak istediğimiz ürün kaynağı buysa:

            { 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
                "id": "product/12345678-abcd-efgh-1234-12345678901",
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo"
                },
                "type": "softwareAsAService",
                "alias": "Contoso Image Resizing Service"
            }

Dayanıklı kimlik "product/071b135e-9faf-4ff7-b113-a3f25bb0f468" olabilir.

Dayanıklı kimlik, aşağıdaki liste kaynağı örneğinde aşağıdaki gibi "ürün" kaynak şeması özelliğinde ayarlanarak kullanılabilir:

            {
                "$schema": "https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5", 
                "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468", // product durable ID
                  ...
              }

Ürün ve plan kaynaklarının dış kimliği "identity" özelliği içinde tanımlanır.

            {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2", 
                "alias": "Gold - Annual payment",
                "identity": {"externalID": "gold-annual"},
                "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468",
                  ...
              }

Plan dış kimliği "altın yıllık" daha sonra aşağıdaki biçimde diğer kaynaklar tarafından başvurulabilir:

              {
                "$schema": "https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5", 
                "product": "product/071b135e-9faf-4ff7-b113-a3f25bb0f468"}
                "plan": {"externalID": "gold-annual"}
                  ...
              }

Örnek istek:

Bu örnekte yapılandırma yükü, dış kimliği "ds-contoso-image-resize-demo" olan yeni bir SaaS ürünü oluşturmak için kullanılır. Bu ürün oluşturulduktan sonra dayanıklı kimliğini veya dış kimliğini kullanarak bu ürüne başvurabilirsiniz.

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/product/2022-03-01-preview3",
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo"
                },
                "type": "softwareAsAService",
                "alias": " Contoso Image Resizing Service"
              }
              ]
            }

Örnek yanıt:

            {
  "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
  "jobID": "071b135e-9faf-4ff7-b113-a3f25bb0f468",
  "jobStatus": "running",
  "jobResult": "pending",
  "jobStart": "2022-08-18T16:35:56.5917185Z",
  "jobEnd": "0001-01-01T00:00:00",
  "errors": []
}

Ardından isteğinizin durumunu denetlemek için Durum Yapılandırma API'sini kullanarak jobID değerini kullanabilirsiniz.

Bağımlılıklar

Bazı kaynakların önkoşul olarak başka bir kaynağın oluşturulmasına bağımlılıkları vardır. Bu durumda, aynı istekte her ikisini de oluşturduğumuz için plan kaynağındaki ürün kaynağının bağımlılığını belirtmek için aynı yük içindeki "resourceName" özelliğini kullanıyoruz.

"resourceName" yalnızca yaptığınız yapılandırma isteğinin bir parçası olarak her kaynağı tanımlamak için kullanılır. Değer, kaynakların verilerinin bir parçası olmaz, depolanmaz ve müşterilere gösterilmez. Ayrıca, yapılandırma isteğinin bir parçası olarak herhangi bir hata varsa, hatanın ait olduğu kaynağı çağırmak için "resourceName" kullanılır.

Örnek istek:

Bu örnekte, ürün plandan önce oluşturulmalıdır ve bu nedenle "resourceName" özelliği kullanılır. Oluşturulan "myNewProduct" ürünü, "resourceName" için kullanılan ve bağımlı plan kaynağı içinde başvuruda bulunılan değer olacaktır.

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/product/2022-03-01-preview3", 
                "resourceName": "myNewProduct", 
                "alias": "Contoso Image Resizing Service",
                ...
              }, 
              {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2", 
                "alias": " Gold - Annual payment",
                "product": {"resourceName": "myNewProduct"}
                  ...
              }, 
              }]
            }

Gönderme kaynağı

"Önizleme" veya "canlı" olarak yayımlanıyorsa, isteğinize gönderme kaynağını ekleyin; bu kaynak şunları içerir:

Dayanıklı kimliği veya dış kimliği tarafından başvurulmakta olan ürünün belirtildiği "product" özelliği
Hedef ortamı belirten "targetType" özelliği

Canlı yayın yaparken, yayımlamak istediğiniz önizleme gönderiminin "kimliği":

              {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "id": "submission/12345678-abcd-efgh-1234-12345678901/11521167929065",    
                "product": "product/12345678-abcd-efgh-1234-12345678901", 
                "target": { "targetType": "live" }
              }

Not

Gönderim kaynağını eklemezseniz, değişiklikler yalnızca taslak durumunda yapılır.

Önizlemeye yayımlama

Ticari ürün türleri bir önizleme ortamını destekler ve canlı yayına geçmeden önce her güncelleştirmenin önizleme için yayımlanması gerekir. Doğrudan canlı yayın yapamazsınız.

Önemli

Bunun istisnası, planlarınızın özel hedef kitlesinde değişiklik yapmaktır. Güncelleştirmeleri özel olarak özel hedef kitleyle eşitlerken, bu değişiklikler aynı anda hem önizlemeye hem de canlı yayına yayılır.

Kaynaklarınızı önizleme ortamında yayımlamanın iki yolu vardır. Önizleme gönderiminde herhangi bir değişiklik yapılması gerekiyorsa, başka bir GET isteği yapın, gerekli değişiklikleri yapın ve değişiklikleri yeniden gönderin. İlk değişikliklerinizle canlı yayına geçmeniz gerekmez.

Yöntem 1: Tüm taslak kaynakları yayımlama

Yaptığınız her taslak değişikliğini yayımlamak istiyorsanız, önizleme ortamını "targetType" olarak ayarlayan bir gönderim kaynağıyla yapılandırma isteği gönderebilirsiniz. Aşağıdaki örnekte gösterildiği gibi, bu yöntem tüm değişiklikleri hedef ortamda yayımladığı için güncelleştirme gerektiren her kaynağı açıkça sağlamanız gerekmez. Bu örnekte önizleme kullanılır. Yalnızca API uç noktasını yapılandırma ve gönderme kaynağını sağlamanız gerekir.

Ö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": [
              {
            // Below is the submission resource to publish to preview
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "product": "product/12345678-abcd-efgh-1234-12345678901", // This is the product durable ID
                "target": { "targetType": "preview" }
              }
              ]
            }

Yöntem 2: Belirli taslak kaynakları yayımlama (modüler yayımlama olarak da bilinir)

Alternatif olarak, tüm taslak değişikliklerini çeşitli kaynaklar arasında yayımlamaya hazır değilseniz, modüler bir yayımlama tetiklemesini sağlamak için gönderim kaynağıyla birlikte yayımlamak istediğiniz kaynakları sağlamanız da gerekir. Bu yaklaşımı, Yöntem 1'de olduğu gibi, kaynaklarda değişiklik yapmak ve toplu güncelleştirme yerine aynı anda yayımlamak için de kullanabilirsiniz. Modüler yayımlama için, ürün türünüz için geçerli olan ürün düzeyi ayrıntıları (örneğin listeleme, kullanılabilirlik, paketler, bayi) dışında tüm kaynaklar gereklidir.

Örnek istek:

Bu örnekte, üründeki kaynaklar modüler yayımlamanın bir parçası olarak ve ardından gönderim kaynağının bir parçası olarak açıkça sağlanır.

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/product/2022-03-01-preview2", 
                "id": "product/12345678-abcd-efgh-1234-12345678901",
                ...
              },
              {
                "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2", 
                  ...
              }, 
              // additional resources
              {
                  ...
              },
              // Below is the submission resource to publish to preview
              {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "product": "product/12345678-abcd-efgh-1234-12345678901", // This is the product durable ID
                "target": { "targetType": "preview" }
              }
              ]
            }

Canlı yayımlama

Önizlemedeki değişiklikleriniz test edildikten ve doğrulandıktan sonra, önizleme gönderiminizin "kimliği" ve "targetType" değeri "live" olarak ayarlanmış bir yapılandırma isteği göndererek değişikliklerinizi canlı yayına gönderebilirsiniz. Yapılandırma isteğinize dahil etmek üzere önizleme gönderiminizin "kimliğini" bulmak için bkz . Gönderimlerinizi sorgulama.

Önemli

Önizlemede yayımlamanın aksine, canlı yayın yaparken modüler yayımlama gerçekleştirme seçeneği yoktur. Bu nedenle, değişikliklerinizle canlı yayına geçmeden önce önizleme gönderiminizi doğruladığınızdan emin olmanız önemlidir.

Ö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": [
              // Below is the submission resource, including the preview submission id, to publish to live.
              {
                "$schema": "https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2",
                "id": "submission/12345678-abcd-efgh-1234-12345678901/11521167929065",    
                "product": "product/12345678-abcd-efgh-1234-12345678901", // This is the product durable ID
                "target": { "targetType": "live" }
              }
              ]
            }

İsteğin durumunu denetleme

Yapılandırma isteğinize dahil edilen kaynaklardan veya yaptığınız değişikliklerden bağımsız olarak, başarıyla işlendiğinde bir istek gönderdikten kısa süre sonra yanıtta bir yapılandırma durumu nesnesi alırsınız. "jobID" daha sonra isteğin durumunu denetlemek için kullanılabildiğinden önemlidir.

Schema: <https://``schema.mp.microsoft.com``/schema/configure-status/2022-03-01-preview2>

Gönderilen bir isteğe örnek yanıt:

            {
                "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
                "jobID": "d4261631-c583-4949-a612-5150882632e9",
                "jobStatus": "notStarted",
                "jobResult": "pending",
                "jobStart": "2022-03-01T13:32:43.123456Z",
                "jobEnd": "0001-01-01T00:00:00",
                "errors": []
            }

Bekleyen isteğin durumu

Aşağıdaki çağrıyı kullanarak ve isteğin "jobID"sini girdikçe iş bitene kadar durumu alabilirsiniz. İsteğinizle ilgili herhangi bir sorun varsa nesne bir hata listesi de içerebilir.

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobID>/status?$version=2022-03-01-preview2

Tamamlanma süresinin isteğinizin karmaşıklık düzeyine bağlı olarak değişebileceğini unutmayın.

Tamamlanan isteğin özeti

Yapılandırma isteği işi başarıyla veya hatayla tamamlandıktan sonra, "jobID" kullanılarak oluşturulan veya güncelleştirilen kaynakların listesini alabilirsiniz.

Not

İş tamamlanmadan önce bu çağrıyı yaparsanız, başarısız olur. Buna ek olarak, yalnızca başarıyla tamamlanan kaynakları veya iptal durumunda yalnızca iptalden önce tamamlanan kaynakları döndürür.

Schema: <https://``schema.mp.microsoft.com``/schema/configure-detail/2022-03-01-preview2>

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobID>?$version=2022-03-01-preview2

Örnek istek:

Aşağıdaki örnekte, yeni bir SaaS ürünü oluşturan önceki örnekte kullanılan yapılandırma isteğinin özet ayrıntılarını almak için bir GET isteği kullanılır. Yanıt, dayanıklı kimliğiyle birlikte oluşturulan ürün kaynağını içeren resources dizisini içeren configure-detail nesnesidir.

GET https://graph.microsoft.com/rp/product-ingestion/configure/071b135e-9faf-4ff7-b113-a3f25bb0f468?$version=2022-03-01-preview2

Örnek yanıt:

            {
"$schema": "https://schema.mp.microsoft.com/schema/configure-detail/2022-03-01-preview2",
"resources": [
{ 
                "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview2",
                "id": "product/12345678-abcd-efgh-1234-12345678901",
                "identity": {
                  "externalID": "ds-contoso-image-resize-demo "
                },
                "type": "softwareAsAService",
                "alias": "Contoso Image Resizing Service"
              }
]
}

Yapılandırma isteğini iptal etme

bir iş tamamlanmadan önce, gerekirse iptal etmeye çalışabilirsiniz. "Önizleme" veya "canlı" olarak yayımlama gibi uzun süre çalışan istekler için, iş tamamen işlenecek kadar uzaktaysa iptal isteği reddedilebilir.

Bir işi iptal etmek için iptal uç noktasına post çağrısı yapın ve iptal etmek istediğiniz isteğin iş kimliğini belirtin.

POST https://graph.microsoft.com/rp/product-ingestion/configure<jobID>/cancel?$version=2022-03-01-preview2

Örnek istek:

POST <https://graph.microsoft.com/rp/product-ingestion/configure/d4261631-c583-4949-a612-5150882632e9/cancel?$version=2022-03-01-preview2>

Başarılı bir iptal isteğinin örnek yanıtı:

            {
                "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
                "jobID": "d4261631-c583-4949-a612-5150882632e9",
                "jobStatus": "completed",
                "jobResult": "cancelled",
                "jobStart": "2022-03-01-T13:32:43.123456Z",
                "jobEnd": "2022-03-01T17:34:21.5225132Z",
                "errors": []
            }

İptale izin verilmiyorsa örnek yanıt: HTTP Status code: 400

İçerik:

            {
              "error": {
                "code": "badRequest",
                "message": "Cannot cancel job, job has already completed.",
                "details": []
              }
}

Önemli

İptal işleminin yalnızca henüz işlenmemiş kaynaklar için geçerli olduğunu unutmayın. Bazı kaynaklar işlemeyi zaten tamamlamış olabilir ve isteğin iptali rağmen en son yapılandırma güncelleştirmelerini yansıtacaktır.

İptal işleminden önce hangi kaynakların (varsa) önceden işlendiğini doğrulamak için iptal işleminden sonra yapılandırma isteğinin özetini getirebilirsiniz.

Ö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

Desteklenen hedef kitle türleri "abonelik", "ea", "msdn" ve "kiracı" şeklindedir, ancak bunlar için destek ürün türüne göre değişir. Ü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-preview2",
            "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": "4c2bdcdc-f10e-468d-8a2a-0832e089215b",
                    "label": "test 1"
                  }
              ],
              "remove ":
              [
                {
            "type": "subscription",
                    "id": "412c45bf-c99a-4e96-b683-77b0aa2dd09e",
                    "label": "test 2"
                }
              ]
            }
          }
          ]
        }

Müşteri adayı yönetimini yapılandırma

Müşteri ilgi alanını ifade ettiğinde veya ürününüzü dağıttığında müşteri iletişim bilgilerini alabilmeniz için müşteri ilişkileri yönetimi (CRM) sisteminizi ticari market ürününüzle Bağlan. Bu bağlantıyı ürün oluşturma sırasında veya sonrasında istediğiniz zaman değiştirebilirsiniz. Daha fazla bilgi edinmek için bkz . Müşteri adaylarını alma.

Müşteri adayı yönetimini yapılandırmak 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/customer-leads/2022-03-01-preview3",
            "id": "customer-leads/a0c6484f-b4fb-4129-ac6b-35f2b5628089",
            "product": "product/a0c6484f-b4fb-4129-ac6b-35f2b5628089",
            "leadDestination": "httpsEndpoint",
            "httpsEndpointLeadConfiguration": {
              "httpsEndpointUrl": "https://www.your-crm.com/triggers/invoke"
            }
          }  
          ]
        }

Kaynak yaşam döngüsü durumları

Bu eşlemeyi bir kaynağın yaşam döngüsü durumuna göre gerçekleştirebileceğiniz farklı eylemler vardır. Tüm kaynakların yaşam döngüsü durumu yoktur ve tüm yaşam döngüsü durumları tüm kaynaklar tarafından desteklenmez. Bir kaynağın yaşam döngüsü durumuna sahip olup olmadığını ve hangi değerlerin desteklendiğini bulmak için kaynak şemasını "lifecycleState" özelliğinin varlığını de kontrol edebilirsiniz. Desteklenen çeşitli yaşam döngüsü durumları aşağıda ayrıntılı olarak belirtilmiştir.

Silinme

"lifecycleState" özelliğini "deleted" olarak güncelleştirerek belirli kaynakları silebilirsiniz. Yalnızca daha önce yayımlanmamış taslak kaynakları silebilirsiniz. Bu eylem geri alınamaz.

Örnek istek:

Aşağıdaki örnekte , "temel" taslak plan silinmiştir.

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/plan/2022-03-01-preview2",
            "id": "plan/9f8af57f-ab07-461b-8404-50e10e5e80fb/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b",
            "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
            "identity": { "externalID": "basic" },
            "alias": "basic plan"
            "lifecycleState": "deleted"
            }
          ]
        }

Kullanım Dışı

Kullanımdan kaldırma işlemi, kaynağı ticari marketten kaldırır. Kullanımdan kaldırılacak şekilde, "lifecycleState" özelliğini destekleyen kaynaklarda "kullanım dışı" olarak ayarlayın. Çeşitli kullanımdan kaldırma düzeyleri vardır. Tüm ürün türleri, ürünün tamamının ve içindeki tek tek planların kullanımdan kaldırılıp kullanım dışı bırakılıp kaldırılamını destekler. Kullanım dışı bırakılmış bir kaynağı daha sonra geri yüklemek için "generallyAvailable" yaşam döngüsü durumuna bakın.

Bir ürünün kullanımdan kaldırılması için örnek istek:

Aşağıdaki örnekte ürünün canlı gönderimi kullanımdan kaldıracak şekilde ayarlanmıştır. Bu değişiklik uygulandıktan sonra, geçerli olmak üzere canlı yayına otomatik olarak yayımlanır.

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/submission/2022-03-01-preview2 ",
                "id": "submission/9f8af57f-ab07-461b-8404-50e10e5e80fb/1152921515689848683",
                "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
                "target": {
                    "targetType": "live"
                  },
                "lifecycleState": "deprecated"
                }
              ]
            }

Planlar kullanım dışı bırakıldığında , "lifecycleState" özelliğinin "kullanım dışı" olarak değiştirilmesi ve değişikliklerin kullanımdan kaldırılması için "önizleme" ve ardından "canlı" olarak yayımlanması gerekir. Bu, kullanımdan kaldırmanın canlı ortamda otomatik olarak yapılandırılacağı bir ürün düzeyi kullanımdan kaldırmadan farklıdır.

Bir planın kullanımdan kaldırılması için örnek istek:

Aşağıdaki örnekte, SaaS ürünü içindeki bir plan kullanımdan kaldıracak şekilde ayarlanmıştır. Bu değişikliği uygulamak için daha sonra gönderim kaynağını kullanarak yayımlayabileceğinizi unutmayı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/plan/2022-03-01-preview2 ",
                "id": "plan/9f8af57f-ab07-461b-8404-50e10e5e80fb/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b",
                "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
                "identity": { "externalID": "basic" },
                "alias": "basic plan"
                "lifecycleState": "deprecated"
                }
              ]
            }

Ürün türüne bağlı olarak değişen başka kullanımdan kaldırma biçimleri de vardır. SaaS, sanal makineler ve kapsayıcıların kullanımdan kaldırılması hakkında daha fazla bilgi edinin.

Genel kullanılabilir

generallyAvailable tüm kaynaklar için varsayılan yaşam döngüsü durumudur. Bir kaynak kullanım dışı bırakıldıktan sonra, "lifecycleState" özelliğini "generallyAvailable" olarak değiştirerek geri yükleyebilirsiniz. Kullanım dışı bırakılmış bir ürünü geri yüklemek için ürünü yayımlayıp önizleme aşamasında canlı olarak görüntülemeniz gerekir. SaaS, VM'ler ve kapsayıcılar için örnekleri ilgili makalelerinde bulabilirsiniz.

Plan geri yükleme için örnek istek:

Aşağıdaki örnekte, bir planın geri yüklenmesi amaçlanmıştır. Bu değişikliği uygulamak için, daha sonra gönderim kaynağını kullanarak tüm yaşam boyunca yayımlamanız gerekir.

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/plan/2022-03-01-preview2",
                "id": "plan/9f8af57f-ab07-461b-8404-50e10e5e80fb/7e70b11f-809e-4c45-ae2f-1fb3ceaca33b",
                "product": "product/9f8af57f-ab07-461b-8404-50e10e5e80fb",
                "identity": { "externalID": "basic" },
                "alias": "basic plan"
                "lifecycleState": "generallyAvailable"
                }
              ]
            }

Kaynak API'si başvurusu

Aşağıdaki şema sürümleri yalnızca önizleme için geçerlidir ve API genel kullanıma sunulduğunda değişir.

Not

Mevcut kaynakları ve bunların sürümlerini burada görüntüleyebilirsiniz: resources-index

Kaynak türü	Açıklama	Şema
azure-test-drive-technical-configuration	Microsoft ticari marketinin test sürüşü çözümünüzle bağlantı kurmasına yardımcı olan teknik ayrıntılar.	https://schema.mp.microsoft.com/schema/azure-test-drive-technical-configuration/2022-03-01-preview3
ticari-market-kurulumu	Ticari marketteki ürünlerin işlem yapılabilir yapılandırmasını açıklar.	https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2
müşteri adayları	Müşteri müşteri adaylarını almak için CRM sistemine bağlanmaya izin verir.	https://schema.mp.microsoft.com/schema/customer-leads/2022-03-01-preview3
Liste	Bu, Microsoft ticari market vitrinlerinde görüntülenecek olan ürününüzün açıklamalarını içerir.	https://schema.mp.microsoft.com/schema/listing/2022-03-01-preview5
listing-asset	Listeleme kaynağına bağlı ekran görüntüleri ve pazarlama varlıklarınız.	https://schema.mp.microsoft.com/schema/listing-asset/2022-03-01-preview5
listing-trailer	Listeleme kaynağına bağlı video varlıkları.	https://schema.mp.microsoft.com/schema/listing-trailer/2022-03-01-preview5
microsoft365 tümleştirmesi	Microsoft 365 etkinleştirme ve tür seçimi.	https://schema.mp.microsoft.com/schema/microsoft365-integration/2022-03-01-preview2
Plan	Plan oluşturmak için plan listesi gibi yapılandırdığınız plan düzeyi kaynakları tarafından başvurulacaktır.	https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2
plan listesi	Plan adını ve açıklamasını ticari markette görünmesini istediğiniz şekilde tanımlayın.	https://schema.mp.microsoft.com/schema/plan-listing/2022-03-01-preview5
price-and-availability-custom-meter	Planlarınız arasında paylaşılan özel ölçümleri tanımlayın.	https://schema.mp.microsoft.com/schema/price-and-availability-custom-meter/2022-03-01-preview3
fiyat ve kullanılabilirlik teklifi	Canlı olarak yayımlamadan önce ürününüzü gözden geçirebilecek sınırlı bir hedef kitle tanımlayın.	https://schema.mp.microsoft.com/schema/price-and-availability-offer/2022-03-01-preview3
fiyat ve kullanılabilirlik planı	Bu planın kullanılabilir olduğu pazarları, istenen para kazanma modelini, fiyatı ve faturalama koşullarını yapılandırın.	https://schema.mp.microsoft.com/schema/price-and-availability-plan/2022-03-01-preview4
price-and-availability-update-private-audiences	Taslak, önizleme ve canlı ortamlardaki özel hedef kitlelere Güncelleştirmeler, yayımlama gerektirmeden aynı anda gerçekleştirilebilir.	https://schema.mp.microsoft.com/schema/price-and-availability-update-private-audiences/2022-03-01-preview3
private-and-availability-private-offer-plan	Özel teklifte kullanılan bir ürün/plan fiyatlandırmasının mutlak fiyatlandırma ayrıntılarını yapılandırmak için kullanılır	https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2022-07-01
özel teklif	Özel teklifin adını ve türünü, teklif koşulları ve ayrıntılarıyla, ürünler/plan dahil ve bunların fiyatlandırmalarıyla birlikte tanımlar	https://schema.mp.microsoft.com/schema/private-offer/2022-07-01
Ürün	Bu ana kaynaktır, ürünün adını ve türünü tanımlar, tüm kaynaklar buna başvurur.	https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3
property	Teklifiniz, uygulama sürümünüz ve yasal sözleşmeleriniz için geçerli kategorileri ve sektörleri tanımlayın.	https://schema.mp.microsoft.com/schema/property/2022-03-01-preview5
Bayi	Ürününüzün kullanılabilmesini istediğiniz Bulut Çözümü Sağlayıcısı s (CSP) programındaki iş ortaklarını yapılandırın.	https://schema.mp.microsoft.com/schema/reseller/2022-03-01-preview2
kaynak ağacı	Ürüne, belirtilen hedef ortam için geçerli durumdaki bu ürünün kaynaklarının listesini açıklar.	https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2
hizmet olarak yazılım-teknik-yapılandırması	Microsoft ticari marketinin çözümünüzle bağlantı kurmasına yardımcı olan teknik ayrıntılar.	https://schema.mp.microsoft.com/schema/software-as-a-service-technical-configuration/2022-03-01-preview3
Gönderme	Ürününüzde farklı eylemleri tetikleme ve ürününüzün kayıtsız ortamlarının (taslak, önizleme ve canlı) yayımlama durumunu belirtmek için kullanılabilir.	https://schema.mp.microsoft.com/schema/submission/2022-03-01-preview2
Test	Müşterilerinizin ürünü sınırlı bir süre için ücretsiz olarak denemesine izin vermek isteyip istemediğinizi tanımlayın.	https://schema.mp.microsoft.com/schema/test-drive/2022-03-01-preview2
test sürüşü listeleme	Müşterilerin ürününüzü nasıl deneyebileceğiyle ilgili ayrıntıları tanımlayın.	https://schema.mp.microsoft.com/schema/test-drive-listing/2022-03-01-preview3
virtual-machine-plan-technical-configuration	Sanal makineyi ve görüntü konumunu açıklayan teknik ayrıntılar.	https://schema.mp.microsoft.com/schema/virtual-machine-plan-technical-configuration/2022-03-01-preview3
virtual-machine-test-drive-technical-configuration	Microsoft ticari marketinin test sürüşü çözümünüzle bağlantı kurmasına yardımcı olan teknik ayrıntılar.	https://schema.mp.microsoft.com/schema/virtual-machine-test-drive-technical-configuration/2022-03-01-preview2
kapsayıcı planı-teknik-yapılandırma	Kapsayıcı görüntüsü özelliklerini açıklayan teknik ayrıntılar.	https://schema.mp.microsoft.com/schema/container-plan-technical-configuration/2022-03-01-preview3

Ürün türü başına API kılavuzu

Ürün Alımı API'si gelecekte diğer ürün türlerinin kullanımına sunulacaktır. Daha fazla ürün türü desteklendiği için, her ürün türüne özgü daha fazla kılavuz kullanıma sunulacaktır.

Ürün türü	Ürün türüne özgü kaynaklar
Özel teklifler	Ürün Alımı API'sini kullanarak özel teklifler oluşturma ve yönetme
SaaS	Ürün Alımı API'sini kullanarak SaaS tekliflerini oluşturma ve yönetme
Sanal makineler	Ürün Alımı API'sini kullanarak sanal makine teklifleri oluşturma ve yönetme
Konteynerler	Ürün Alımı API'sini kullanarak kapsayıcı teklifleri oluşturma ve yönetme

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

Güncelleştirme	Neler değişti?
11-2023	Tüm şema uç noktaları product-ingestion.azureedge.net schema.mp.microsoft.com güncelleştirildi
12-2022	Müşteri adayları için BILGISAYAR Alımı API'sinin yeni şema sürümü 2022-03-01-preview3 artık müşteri müşteri adaylarını yapılandırırken clientID ve clientSecret kabul eden ve sunucu KIMLIĞI ile iletişim e-posta alanlarını yakalamayı durduran kullanılabilir. Marketo bağlayıcısını market teklifleri için yapılandırmaya devam etmek için yeni sürüme geçin ve clientID ile clientSecret'i sağlayın. Yeni şema URL'si: https://``schema.mp.microsoft.com``/schema/customer-leads/2022-03-01-preview3
09-2022	Kapsayıcı önizleme desteği sürüm 2022-03-01-preview4 olarak yayımlandı
08-2022	Hizmet olarak yazılım önizleme desteği sürüm 2022-03-01-preview3 olarak yayımlandı
08-2022	Sürüm 2022-07-01 olarak özel teklif genel sürümü
05-2022	Sanal makine önizleme desteği sürüm 2022-03-01-preview2 olarak yayımlandı

Ticari market için Ürün Alımı API'si

Kullanmaya başlama

1. Adım: Önkoşulları tamamlama

Microsoft Entra uygulamasını İş Ortağı Merkezi hesabınızla ilişkilendirme

2. Adım: Microsoft Entra erişim belirtecini alma

Kavramlar

Kaynaklar

Dayanıklı Kimlik

Dış Kimlik

API Yöntemleri

Tipik bir iş akışı

Mevcut kaynak yapılandırmalarını alma

Yöntem 1: Kaynak ağacı

Yöntem 2: Dayanıklı Kimlik

Yöntem 3: Sorgu dizesi parametreleri

Gönderimlerinizi sorgulama

Yeni ürünler ve kaynaklar oluşturma

Mevcut ürünleri ve kaynakları değiştirme

Yapılandırma istekleri

Kaynak başvuruları ve bağımlılıkları

Başvurular

Bağımlılıklar

Gönderme kaynağı

Önizlemeye yayımlama

Yöntem 1: Tüm taslak kaynakları yayımlama

Yöntem 2: Belirli taslak kaynakları yayımlama (modüler yayımlama olarak da bilinir)

Canlı yayımlama

İsteğin durumunu denetleme

Bekleyen isteğin durumu

Tamamlanan isteğin özeti

Yapılandırma isteğini iptal etme

Özel hedef kitleleri eşitleme

Müşteri adayı yönetimini yapılandırma

Kaynak yaşam döngüsü durumları

Silinme

Kullanım Dışı

Genel kullanılabilir

Kaynak API'si başvurusu

Ürün türü başına API kılavuzu

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

Sonraki adımlar

Geri Bildirim

Geri Bildirim

Ek kaynaklar