API di inserimento prodotti per contenitori
L'API di inserimento prodotti è un'API modernizzata che unifica tutte le API di invio esistenti in tutti i prodotti del marketplace commerciale. Per informazioni dettagliate su come iniziare, vedere API di inserimento prodotti.
Questo articolo fornisce indicazioni su come usare le API in modo specifico per i contenitori.
Recuperare le configurazioni delle risorse esistenti
Recuperare tutte le risorse all'interno di un prodotto specifico in una singola chiamata API.
GET resource-tree/<product-durableID>?$version=<schema-version>
È possibile recuperare tutte le configurazioni delle risorse all'interno di un prodotto specifico usando il tipo di risorsa "albero delle risorse" insieme all'ID durevole del prodotto. La versione dello schema specificata viene usata come versione massima supportata per ognuna delle risorse applicabili del prodotto richiesto.
Nota
Se non si conosce l'ID durevole del prodotto, è possibile recuperare prima la risorsa del prodotto usando l'ID esterno del prodotto e l'esecuzione. Per altre informazioni, vedere PRODUCT API: Method 1: resource tree(API prodotto: Metodo 1: albero delle risorse).
Chiamata GET di esempio:
Risposta campione:
{
"$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.
{
...
}]
}
Sincronizza destinatari privati
Per un prodotto live, gli aggiornamenti ai destinatari privati nella bozza, nell'anteprima e negli ambienti live possono essere eseguiti contemporaneamente senza richiedere una pubblicazione. È possibile sincronizzare il gruppo di destinatari privato usando la risorsa "price-and-availability-update-private-audiences" specificando i gruppi di destinatari da aggiungere o rimuovere da un piano specifico. Verrà sincronizzata la bozza, l'anteprima e gli ambienti live in modo che abbiano gli stessi valori del gruppo di destinatari privati. Non è necessario fornire la risorsa di invio durante la sincronizzazione del gruppo di destinatari privato.
Per modificare i destinatari della bozza, usare la risorsa "price-and-availability-plan" e la proprietà "privateAudiences". Sarà necessario eseguire il normale flusso di pubblicazione per impostare i valori in anteprima e in tempo reale.
Importante
Se il prodotto supporta più tipi di identificatore per configurare il gruppo di destinatari privato (ad esempio, ID tenant e ID sottoscrizione), è necessario eseguire una pubblicazione completa se si specifica un nuovo tipo di identificatore per la prima volta. In questo caso non è possibile sincronizzare il gruppo di destinatari privato.
Richiesta di esempio per sincronizzare la configurazione del gruppo di destinatari privato:
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"
}
]
}
}
]
}
Configurare le proprietà
Definire le categorie e i settori applicabili al prodotto contenitore, alla versione dell'app e ai contratti legali. Assicurarsi di fornire dettagli completi e accurati sul prodotto nella risorsa Proprietà, in modo che venga visualizzato in modo appropriato e offerto al set corretto di clienti. Per altre informazioni, vedere Categorie di Appsource.
Corpo della richiesta di esempio che configura le proprietà:
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"
]
}
}
]
}
Configurare l'inserzione
Le informazioni fornite tramite l'inserzione delle risorse vengono visualizzate negli store online del marketplace commerciale Microsoft. Sono incluse le descrizioni del prodotto, gli screenshot e gli asset di marketing.
Corpo della richiesta di esempio che configura l'elenco:
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"
}
]
}
}
}
]
}
Configurare il gruppo di destinatari dell'anteprima
Se il prodotto contenitore viene venduto tramite il marketplace Microsoft, è necessario definire un gruppo di destinatari in anteprima, tramite ID sottoscrizione, che possono esaminare l'inserzione del prodotto prima che venga pubblicata.
Corpo della richiesta di esempio che configura il gruppo di destinatari dell'anteprima:
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"
}
]
}
]
}
Configurare un piano - Configurazione tecnica
Specificare un nome di tipo di estensione del cluster nel formato 'PublisherName.ApplicationName'. Il nome deve essere univoco in tutte le offerte e i piani. Non è possibile modificare questo valore dopo la pubblicazione del piano in anteprima. Per altre informazioni, vedere Impostare la configurazione tecnica del piano per un'offerta contenitore basata su applicazioni Kubernetes. Per altre informazioni, vedere Asset tecnici del contenitore di Azure.
Corpo della richiesta di esempio che configura la configurazione tecnica transazionabile:
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"
},
]
},
]
}
Configurare un piano : prezzo e disponibilità
Corpo della richiesta di esempio che configura un piano nascosto:
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"
}
]
}
Le offerte di contenitori supportano varie opzioni di fatturazione. Per altre informazioni sui modelli di fatturazione supportati, vedere Opzioni di licenza.
Versioni e aggiornamenti delle API
Aggiornamento | Cosa è cambiato? |
---|---|
1-2024 | Tutti gli endpoint dello schema sono stati aggiornati da product-ingestion.azureedge.net a schema.mp.microsoft.com |