Products - List
Ottieni un elenco di prodotti pubblici commerciali.
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&storefront={storefront}&language={language}&locations={locations}&market={market}&hideKeys={hideKeys}&select={select}&filter={filter}&expand={expand}&orderby={orderby}
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versione dell'API REST usata per la richiesta. |
|
expand
|
query |
string[] |
Espande le entità correlate inline. Esempio: 'expand=startingPrice' |
|
|
filter
|
query |
string |
Filtra i risultati in base a una condizione booleana. Esempio: 'filter=productType eq "VirtualMachine"'. I campi che possono essere filtrati in base a sono:
|
|
|
hide
|
query |
string[] |
Questa chiave viene utilizzata per recuperare i prodotti in anteprima e viene generata all'interno del Centro per i partner durante il processo di pubblicazione dell'offerta. |
|
|
language
|
query |
string |
Lingua per la ricerca, codice ISO 639-1 a due lettere, valori possibili : 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Il valore predefinito è "en" |
|
|
locations
|
query |
string[] |
Restituisce i prodotti disponibili nella posizione selezionata. Enumerazione delle aree del data center di Azure. Fare riferimento a https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Valore di mercato del prodotto (la risposta includerà solo i prodotti che possono essere venduti nel mercato specificato) I valori possibili sono disponibili in https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Esempio: 'US' |
|
|
orderby
|
query |
string |
Espressione di ordinamento per i risultati usando la notazione OData. Evitare di usare orderby, a meno che questo non influisca sulla latenza della richiesta. Esempio: 'orderby=displayName desc'. Questa API supporta solo l'ordinamento in base a un singolo campo. I campi che possono essere ordinati in base a sono:
|
|
|
select
|
query |
string[] |
Seleziona le proprietà da includere nei risultati. Esempio: 'select=displayName' |
|
|
storefront
|
query |
string |
Restituire i prodotti disponibili nel portale di Azure Marketplace, in AppSource o nel portale di Azure Marketplace. I valori possibili sono:
|
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| X-API-Key | True |
string |
Usare la chiave API fornita dal team del catalogo del Marketplace come parametro fornito nell'intestazione |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
Restituisce un elenco di prodotti pubblici o di anteprima |
|
| Other Status Codes |
Risposte di errore:
Intestazioni x-ms-error-code: string |
Esempio
List_Products
Esempio di richiesta
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Risposta di esempio
{
"items": [
{
"displayName": "productDisplayName",
"popularity": 1,
"categoryIds": [
"monitoring-and-diagnostics",
"virtualMachine"
],
"industryIds": [
"consumer-goods",
"retailers"
],
"publisherId": "Microsoft",
"azureBenefit": "Eligible",
"badges": [
"ExternalPurchase"
],
"publisherType": "Microsoft",
"publishingStage": "Public",
"uniqueProductId": "uniqueProductId",
"productType": "VirtualMachine",
"productSubType": "Azure",
"operatingSystems": [
"windows.others"
],
"pricingTypes": [
"Payg"
],
"publisherDisplayName": "Microsoft",
"longSummary": "longSummary",
"summary": "summary",
"smallIconUri": "SomeIconUri",
"description": "productDescription",
"ratingBuckets": [
"AboveOne"
],
"ratingAverage": 0,
"ratingCount": 0,
"plans": [
{
"planId": "plan1Id",
"uniquePlanId": "uniquePlan1Id",
"displayName": "displayName",
"vmArchitectureType": "X64Gen1",
"cspState": "SelectiveOptIn",
"metadata": {
"generation": null,
"altStackReference": null
},
"altStackReference": "altStackReference",
"stackType": "Classic",
"altArchitectureReference": "altArchitectureReference",
"categoryIds": [],
"hasProtectedArtifacts": false,
"pricingTypes": [
"Payg"
],
"vmSecuritytypes": [
"None"
],
"summary": "PlanSummary",
"description": "plan description",
"skuId": "0001",
"planType": "VirtualMachine",
"displayRank": "2147483647",
"isPrivate": false
}
],
"supportedProducts": [
"suportedProduct1"
],
"applicableProducts": [
"applicableProduct1"
],
"locations": [
"EU North"
],
"serviceFamily": "service family",
"service": "service name",
"productId": "product id",
"hasMarketplaceFootprint": true,
"attributes": null,
"lastModifiedDateTime": "2022-02-14T23:31:25.5733368+00:00"
},
{
"displayName": "display name",
"popularity": 0,
"publisherId": "Microsoft",
"azureBenefit": "NotEligible",
"publisherType": "Microsoft",
"productType": "AzureServices",
"productSubType": "Azure",
"pricingTypes": [],
"publisherDisplayName": "Microsoft",
"description": "description",
"locations": [
"US West 2",
"UK South",
"BR South"
],
"serviceFamily": "Compute",
"service": "Virtual Machines",
"productId": "product id",
"hasMarketplaceFootprint": false,
"attributes": [
{
"key": "attr1",
"value": "val1"
}
]
}
],
"nextPageLink": "https://catalogapi.azure.com/products?api-version=2023-05-01-preview&$skiptoken=W3s..."
}
Definizioni
| Nome | Descrizione |
|---|---|
| Attribute |
Rappresenta un attributo SKU, costituito da una chiave e un valore. Gli attributi possono variare in diversi servizi. |
|
Azure |
Idoneità per il vantaggio dell'impegno a consumo di Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valori possibili:
|
| Badge |
Tipo di badge |
|
Catalog |
Pagina di risposta composta da un elenco di oggetti Product (che include subset di attributi del prodotto) insieme a un collegamento di pagina successivo. In genere, gli attributi del prodotto restituiti nell'elenco vengono usati per creare riquadri del prodotto per La raccolta di Marketplace. Nota: il numero massimo di elementi restituiti per pagina è 100. In casi specifici per l'ottimizzazione delle prestazioni, contattare il team di Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Valore che indica se il piano è disponibile per l'acquisto tramite il canale CSP. Valori possibili:
|
|
Error |
Oggetto risposta errore API |
|
Error |
Oggetto dettagli risposta errore API |
| Metadata |
Metadati di piano/SKU espansi. |
|
Plan |
Puntamento a un oggetto SKU correlato |
|
Plan |
Restituisce un subset di attributi di piano |
|
Plan |
Tipo di piano modello applicazione gestita o soluzione (applicabile solo al prodotto Applicazioni di Azure). Valori possibili:
|
|
Pricing |
Tipo di prezzi |
|
Product |
Restituisce un subset di attributi Product |
|
Product |
Metodo di recapito o modello di distribuzione. Valori possibili:
|
|
Publisher |
Valore che indica se si tratta di un prodotto Microsoft o di terze parti. Valori possibili:
|
|
Publishing |
Fase di pubblicazione del prodotto. Valori possibili:
|
|
Rating |
Bucket classificazione |
| Sku |
Lo SKU |
|
Starting |
Prezzo al dettaglio del piano più economico del prodotto |
|
Vm |
Tipo di architettura della macchina virtuale. Applicabile solo ai prodotti macchina virtuale. Valori possibili:
|
|
Vm |
Tipo di sicurezza della macchina virtuale. Applicabile solo ai prodotti macchina virtuale. Valori possibili:
|
Attribute
Rappresenta un attributo SKU, costituito da una chiave e un valore. Gli attributi possono variare in diversi servizi.
| Nome | Tipo | Descrizione |
|---|---|---|
| key |
string |
Chiave dell'attributo |
| value |
string |
Valore dell'attributo |
AzureBenefit
Idoneità per il vantaggio dell'impegno a consumo di Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valori possibili:
-
Eligible: il prodotto è idoneo per il vantaggio impegno per il consumo di Azure -
NotEligible: il prodotto non è idoneo per il vantaggio impegno per il consumo di Azure
| Valore | Descrizione |
|---|---|
| Eligible | |
| NotEligible |
Badge
Tipo di badge
| Valore | Descrizione |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Pagina di risposta composta da un elenco di oggetti Product (che include subset di attributi del prodotto) insieme a un collegamento di pagina successivo. In genere, gli attributi del prodotto restituiti nell'elenco vengono usati per creare riquadri del prodotto per La raccolta di Marketplace. Nota: il numero massimo di elementi restituiti per pagina è 100. In casi specifici per l'ottimizzazione delle prestazioni, contattare il team di Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Nome | Tipo | Descrizione |
|---|---|---|
| items |
Elenco di elementi restituiti |
|
| nextPageLink |
string (uri) |
Collegamento alla pagina successiva in cui la richiesta restituisce più di una singola pagina di risultati |
CspState
Valore che indica se il piano è disponibile per l'acquisto tramite il canale CSP. Valori possibili:
-
OptIn- Pianificare il consenso esplicito del programma CSP configurato per qualsiasi partner nel programma CSP -
Optout- Pianificare il rifiuto esplicito del programma CSP configurato -
SelectiveOptIn: pianificare il consenso esplicito del programma CSP configurato per partner specifici nel programma CSP ISV seleziona. Per altre informazioni, vedere https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Valore | Descrizione |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Oggetto risposta errore API
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Dettagli della risposta dell'API |
ErrorResponseDetails
Oggetto dettagli risposta errore API
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Descrizione del codice di errore. Ad esempio code=InternalError |
| message |
string |
Messaggio di errore. Ad esempio message=Errore interno del server |
Metadata
Metadati di piano/SKU espansi.
| Nome | Tipo | Descrizione |
|---|---|---|
| altStackReference |
string |
Puntando a un planId che contiene il riferimento dello stack alternativo |
| generation |
string |
Generazione di immagini della macchina virtuale (applicabile solo ai prodotti macchina virtuale). Vedere https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Puntando a un planId di piani correlati a questo piano |
PlanSkuRelation
Puntamento a un oggetto SKU correlato
| Nome | Tipo | Descrizione |
|---|---|---|
| relationType |
string |
Tipo di relazione |
| sku |
Lo SKU |
PlanSummary
Restituisce un subset di attributi di piano
| Nome | Tipo | Descrizione |
|---|---|---|
| altArchitectureReference |
string |
Informazioni di riferimento sull'architettura alternativa |
| altStackReference |
string |
Informazioni di riferimento sullo stack alternativo |
| categoryIds |
string[] |
Pianificare CategoryIds |
| cspState |
Valore che indica se il piano è disponibile per l'acquisto tramite il canale CSP. Valori possibili:
|
|
| description |
string |
Descrizione piano/SKU |
| displayName |
string |
Nome visualizzato del piano/SKU |
| displayRank |
string |
L'ordine in cui il piano viene visualizzato nella tabella "Piani" (come configurato dall'editore) |
| hasProtectedArtifacts |
boolean |
Impostare su true se il piano include elementi che devono essere nascosti per gli utenti non autenticati |
| hasRI |
boolean |
Indica se lo SKU supporta le prenotazioni |
| isPrivate |
boolean |
Indicazione che il piano è accessibile solo ai destinatari limitati |
| metadata |
Metadati di piano/SKU espansi. |
|
| planId |
string |
ID piano |
| planType |
Tipo di piano modello applicazione gestita o soluzione (applicabile solo al prodotto Applicazioni di Azure). Valori possibili:
|
|
| pricingTypes |
Elenco dei tipi di prezzi per i quali è designato questo piano (i valori possibili sono uguali a quello a livello di prodotto) |
|
| skuId |
string |
ID SKU |
| stackType |
string |
Tipo di stack: classico, Gen1, Gen2 |
| summary |
string |
Testo di riepilogo del piano |
| uniquePlanId |
string |
ID piano univoco preceduto dalla combinazione di uniqueProductId e PlanId senza separatore tra |
| vmArchitectureType |
Tipo di architettura della macchina virtuale. Applicabile solo ai prodotti macchina virtuale. Valori possibili:
|
|
| vmSecuritytypes |
Tipo di sicurezza della macchina virtuale. Applicabile solo ai prodotti macchina virtuale. Valori possibili:
|
PlanType
Tipo di piano modello applicazione gestita o soluzione (applicabile solo al prodotto Applicazioni di Azure). Valori possibili:
-
SolutionTemplate- Tipo di piano del modello di soluzione (applicabile solo alle applicazioni di Azure) -
ManagedApplication- Tipo di piano dell'applicazione gestita (applicabile solo alle applicazioni di Azure)
PricingType
Tipo di prezzi
| Valore | Descrizione |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Restituisce un subset di attributi Product
| Nome | Tipo | Descrizione |
|---|---|---|
| applicableProducts |
string[] |
Categorie di prodotti a cui appartiene l'offerta |
| attributes |
Set di attributi di prodotti (varia per tipo di prodotto), dove ogni attributo è rappresentato da una coppia di chiavi (nome attributo) e value(valore attributo) |
|
| azureBenefit |
Idoneità per il vantaggio dell'impegno a consumo di Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Valori possibili:
|
|
| badges |
Badge[] |
Sono disponibili i badge di prodotto seguenti: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Matrice di categorie di prodotti, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Ad esempio "Produttività" |
| cspLegalTermsUri |
string |
Condizioni legali del prodotto per il CSP |
| description |
string |
Testo della descrizione del prodotto |
| displayName |
string |
Nome visualizzato prodotto |
| hasMarketplaceFootprint |
boolean |
Indicazione se il prodotto ha una rappresentazione nel marketplace |
| hasRIPlans |
boolean |
Indicazione se il prodotto ha piani con prenotazioni |
| industryIds |
string[] |
Elenco degli ID del settore a cui appartiene l'elemento |
| lastModifiedDateTime |
string (date-time) |
Data di aggiornamento più recente del prodotto |
| linkedAddInsTypes |
object |
Tipi di componenti aggiuntivi collegati |
| locations |
string[] |
Elenco delle posizioni disponibili negli SKU |
| longSummary |
string |
Riepilogo lungo prodotto |
| operatingSystems |
string[] |
Informazioni sul sistema operativo per questo prodotto |
| plans |
Elenco dei piani disponibili per questo prodotto |
|
| popularity |
number (double) |
Popolarità del prodotto |
| pricingTypes |
Elenco dei tipi di prezzi per cui è designata l'offerta. Valori possibili:
|
|
| privacyPolicyUri |
string |
Informativa sulla privacy del prodotto |
| productFamily |
string |
Famiglia di prodotti |
| productId |
string |
ID univoco del prodotto |
| productSubType |
string |
Sottotipo prodotto |
| productType |
Metodo di recapito o modello di distribuzione. Valori possibili:
|
|
| publisherDisplayName |
string |
Nome visualizzato del server di pubblicazione |
| publisherId |
string |
ID server di pubblicazione |
| publisherType |
Valore che indica se si tratta di un prodotto Microsoft o di terze parti. Valori possibili:
|
|
| publishingStage |
Fase di pubblicazione del prodotto. Valori possibili:
|
|
| ratingAverage |
number (double) |
Valutazione media per l'offerta |
| ratingBuckets |
Bucket di valutazione, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Numero totale di valutazioni per l'offerta |
| service |
string |
Nome del servizio del prodotto, ad esempio "Macchine virtuali" |
| serviceFamily |
string |
Famiglia di servizi del prodotto, ad esempio "Calcolo" |
| smallIconUri |
string |
URI per l'icona del prodotto di piccole dimensioni |
| startingPrice |
Prezzo al dettaglio del piano più economico del prodotto |
|
| summary |
string |
Riepilogo del prodotto |
| supportedProducts |
string[] |
Esegue il mapping all'elenco di prodotti compatibili forniti dall'editore |
| uniqueProductId |
string |
Identificatore univoco del prodotto |
ProductType
Metodo di recapito o modello di distribuzione. Valori possibili:
-
SaaS: il prodotto è una soluzione software acquistata con pagamento in base al consumo da un provider di servizi cloud -
VirtualMachine- Il prodotto è istanze del servizio immagini con prezzi basati sull'utilizzo -
AzureApplication: prodotti pubblicati come modelli di soluzione (ST) o piani di App gestite di Azure (AMA) che distribuiscono le risorse di Azure nel tenant del cliente -
DynamicsCE- Tutti i prodotti Dynamics ad eccezione di DynamicsBC e DynamicsOps -
DynamicsBC- Dynamics 365 Business Central -
Container: il prodotto viene distribuito come contenitore -
DynamicsOps- App Dynamics 365 Operations -
None: tipo di prodotto restituito per servizi di Azure, estensioni contenitore ed estensioni di macchina virtuale -
IotEdgeModules: la risorsa viene distribuita come modulo IoT Edge -
ContainerApps: la risorsa viene distribuita come app contenitore -
ConsultingServicesServizi di consulenza (disponibili solo in Azure Marketplace come offerte di presentazione) -
ManagedServices: il prodotto viene distribuito come servizio gestito -
PowerBI- Prodotti Power BI -
CosellOnly- Prodotti disponibili solo nell'ambito del programma Co-Sell -
PowerBIVisuals- Prodotti visivi di Power BI -
Office365- Prodotti Office 365 -
DevService- Servizio di sviluppo -
AADApps- Applicazioni Azure Active Directory -
VisualStudioExtension- Estensioni di Visual Studio -
SolutionTemplate- Tipo di piano del modello di soluzione (applicabile solo alle applicazioni di Azure) -
ManagedApplication- Tipo di piano dell'applicazione gestita (applicabile solo alle applicazioni di Azure) -
MicrosoftProduct- Prodotto Azure di prima parte
| Valore | Descrizione |
|---|---|
| None | |
| DevService | |
| ManagedApplication | |
| VirtualMachine | |
| AzureApplication | |
| Container | |
| SaaS | |
| SolutionTemplate | |
| IotEdgeModules | |
| ManagedServices | |
| ContainerApps | |
| VisualStudioExtension | |
| DynamicsOps | |
| DynamicsCE | |
| DynamicsBC | |
| PowerBI | |
| ConsultingServices | |
| CosellOnly | |
| CoreVirtualMachine | |
| PowerBIVisuals | |
| Office365 | |
| AADApps | |
| AzureServices | |
| AppService | |
| LogAnalytics | |
| MicrosoftProduct |
PublisherType
Valore che indica se si tratta di un prodotto Microsoft o di terze parti. Valori possibili:
-
Microsoft- Prodotto pubblicato da Microsoft (prodotto di prima parte) -
Third Party- Il prodotto viene pubblicato dal fornitore di terze parti
| Valore | Descrizione |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Fase di pubblicazione del prodotto. Valori possibili:
-
Preview- Il prodotto è disponibile per il pubblico con restrizioni -
Public- Il prodotto è disponibile pubblicamente nel Marketplace
| Valore | Descrizione |
|---|---|
| Preview | |
| Public |
RatingBucket
Bucket classificazione
| Valore | Descrizione |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Lo SKU
| Nome | Tipo | Descrizione |
|---|---|---|
| generation |
string |
Generazione |
| identity |
string |
Identità |
| name |
string |
Nome |
StartingPrice
Prezzo al dettaglio del piano più economico del prodotto
| Nome | Tipo | Descrizione |
|---|---|---|
| currency |
string |
Valuta per il prezzo |
| market |
string |
Mercato per il quale viene calcolato il prezzo iniziale |
| meterUnits |
string |
Unità del modello di determinazione prezzi dei contatori |
| minMeterPrice |
number |
Prezzo dei contatori a partire (minimo) |
| minTermPrice |
number |
Prezzo dei termini iniziale (minimo) |
| termUnits |
string |
Le unità del modello tariffario dei termini |
VmArchitectureType
Tipo di architettura della macchina virtuale. Applicabile solo ai prodotti macchina virtuale. Valori possibili:
-
Arm64: l'architettura dell'immagine della macchina virtuale del piano è Arm64 -
X64Gen1: l'architettura dell'immagine della macchina virtuale del piano è X64 Generation1 -
X64Gen2: l'architettura dell'immagine della macchina virtuale del piano è X64 Generation2
| Valore | Descrizione |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Tipo di sicurezza della macchina virtuale. Applicabile solo ai prodotti macchina virtuale. Valori possibili:
- Standard - Livello di sicurezza di base per la macchina virtuale
- Attendibile: protegge da attacchi persistenti e avanzati nelle macchine virtuali Gen2 con funzionalità configurabili come l'avvio della sicurezza e il virtual Trusted Platform Module (vTPM)
- Riservato: oltre all'avvio attendibile, le macchine virtuali riservate offrono una maggiore riservatezza e integrità garantita con l'ambiente di esecuzione attendibile basato su hardware
| Valore | Descrizione |
|---|---|
| None | |
| Trusted | |
| Confidential |