Product List - List By Subscription
Listar produkter för prenumeration.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language={language}&excludePublicOffersAndPublicPlans={excludePublicOffersAndPublicPlans}&$filter={$filter}&$select={$select}&$expand={$expand}&$orderBy={$orderBy}&$search={$search}
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
ID för målprenumerationen. Värdet måste vara ett UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
|
$expand
|
query |
string |
Expanderar relaterade entiteter infogade |
|
|
$filter
|
query |
string |
Filtrerar resultatet baserat på ett booleskt villkor. Exempel: $filter=productType eq 'VirtualMachine'. Fält som kan filtreras efter är:
|
|
|
$order
|
query |
string |
Ordnande uttryck för resultaten med hjälp av OData-notation. Undvik att använda orderby om det inte är nödvändigt eftersom detta kan påverka svarstiden för din begäran. Exempel: $orderby=displayName desc. Det här API:et stöder endast sortering efter ett enda fält. Fält som kan sorteras efter är:
|
|
|
$search
|
query |
string |
Du kan också söka efter visningsnamn, utgivarens visningsnamn eller nyckelord. Exempel $search=Microsoft |
|
|
$select
|
query |
string |
Väljer vilka egenskaper som ska ingå i resultatet. Exempel: $select=displayName |
|
|
exclude
|
query |
boolean |
Om du vill undanta offentliga erbjudanden och offentliga planer från svaret. Standardvärdet är false, vilket innebär att offentliga erbjudanden och offentliga planer ingår i svaret. Om värdet är true returneras endast privata planer. |
|
|
language
|
query |
string |
Språk att söka i, ISO 639-1 tvåbokstavskod, möjliga värden - "en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant". Standard är "en" |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Begäran har slutförts. |
|
| Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2-flöde.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| user_impersonation | personifiera ditt användarkonto |
Exempel
ProductList_ListBySubscription
Exempelbegäran
GET https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$filter=productType eq 'SaaS'&$select=displayName,uniqueProductId,productType,publisherDisplayName
Exempelsvar
{
"value": [
{
"uniqueProductId": "microsoft.managedinstance_standard",
"displayName": "Azure SQL Managed Instance",
"publisherDisplayName": "Microsoft",
"productType": "SaaS"
}
],
"nextLink": "https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$select=displayName,uniqueProductId,productType,publisherDisplayName&$filter=productType eq 'SaaS'&$skiptoken=W3sid..."
}
Definitioner
| Name | Description |
|---|---|
| Attribute |
Representerar ett SKU-attribut som består av en nyckel och ett värde. Attributen kan skilja sig åt mellan olika tjänster. |
|
Discovery |
Felinformation som returneras i DiscoveryErrorPayload |
|
Discovery |
Felnyttolast som returneras av API:er för Marketplace Discovery |
|
Plan |
Ytterligare metadata |
|
Plan |
Returnerar en delmängd av Plan-attributen |
|
Product |
Returnerar en delmängd av Product attribut |
|
Product |
Det anpassade svaret för en liståtgärd. |
Attribute
Representerar ett SKU-attribut som består av en nyckel och ett värde. Attributen kan skilja sig åt mellan olika tjänster.
| Name | Typ | Description |
|---|---|---|
| key |
string |
Attributets nyckel |
| value |
string |
Attributets värde |
DiscoveryErrorDetails
Felinformation som returneras i DiscoveryErrorPayload
| Name | Typ | Description |
|---|---|---|
| code |
string |
HTTP-felkoden |
| message |
string |
Felmeddelandet |
DiscoveryErrorPayload
Felnyttolast som returneras av API:er för Marketplace Discovery
| Name | Typ | Description |
|---|---|---|
| error |
Objektet för felinformation |
PlanMetadata
Ytterligare metadata
| Name | Typ | Description |
|---|---|---|
| altStackReference |
string |
Peka på ett planId som innehåller den alternativa stackreferensen |
| generation |
string |
Generering av VM-avbildning (gäller endast för produkter för virtuella datorer) |
PlanSummary
Returnerar en delmängd av Plan-attributen
| Name | Typ | Description |
|---|---|---|
| altArchitectureReference |
string |
Referensen för alternativ arkitektur |
| altStackReference |
string |
Alternativ stackreferens |
| categoryIds |
string[] |
Planera CategoryIds |
| cspState |
string |
Styr planens tillgänglighet och partneråtkomst i Microsoft Cloud Solution Provider-programmet (CSP).
|
| description |
string |
Beskrivning av plan/SKU |
| displayName |
string |
Visningsnamn för planen/SKU:n |
| displayRank |
string |
Ordningen som planen visas i tabellen "Planer" |
| hasProtectedArtifacts |
boolean |
Ställ in på true om planen har artefakter som ska döljas för icke-autentiserade användare |
| hasRi |
boolean |
Indikation om SKU:n stöder reservationer |
| isPrivate |
boolean |
Indikation på att planen endast är tillgänglig för en begränsad publik |
| metadata |
Utökade metadata för plan/SKU. |
|
| planId |
string |
Identifierare för plan |
| planType |
string |
Anger den primära distributionsmodellen och värdarkitekturen för Marketplace-produkten. För närvarande stöds värden:
|
| pricingTypes |
string[] |
Anger de faktureringsmodeller och kostnadsstrukturer som är tillgängliga för planen.
|
| skuId |
string |
SKU-ID:t |
| stackType |
string |
Stacktyp: Klassisk, Gen1, Gen2 |
| summary |
string |
Sammanfattningstexten för planen |
| uniquePlanId |
string |
Unik planidentifierare som föregås av en kombination av uniqueProductId och PlanId utan någon avgränsare däremellan |
| vmArchitectureType |
string |
Anger processorarkitekturen och genereringen för den virtuella datorn. Gäller endast för produkttyper för virtuella datorer.
|
| vmSecuritytypes |
string[] |
Definierar säkerhetsförbättringsnivån för distributioner av virtuella datorer. Gäller endast för produkttyper för virtuella datorer.
|
ProductSummary
Returnerar en delmängd av Product attribut
| Name | Typ | Description |
|---|---|---|
| applicableProducts |
string[] |
Produktkategorier som erbjudandet tillhör |
| attributes |
Uppsättning av produktattribut |
|
| azureBenefit |
string |
Anger om produktköp räknas mot fördelarna med Azure-förbrukningsåtagande för företagskunder.
|
| badges |
string[] |
Visar certifierings- och kvalificeringsmärken som tjänats in av produkten för synlighet på Marketplace.
|
| categoryIds |
string[] |
Utbud av produktkategorier |
| cspLegalTermsUri |
string |
De juridiska villkoren för produkten för CSP |
| description |
string |
Texten i produktbeskrivningen |
| displayName |
string |
Namn på produktens display |
| hasMarketplaceFootprint |
boolean |
Indikation om produkten har en representation på marknaden |
| hasRiPlans |
boolean |
Uppgift om huruvida produkten har planer med reservationer |
| industryIds |
string[] |
Lista över bransch-ID:n som objektet tillhör |
| lastModifiedDateTime |
string |
Senaste uppdateringsdatum för produkten |
| locations |
string[] |
Lista över platser som är tillgängliga på SKU:erna |
| longSummary |
string |
Lång sammanfattning av produkten |
| operatingSystems |
string[] |
Information om operativsystemet för den här produkten |
| plans |
Fullständig uppsättning plan-/SKU-attribut |
|
| popularity |
number (double) |
Produktens popularitet |
| pricingTypes |
string[] |
Anger de faktureringsmodeller och kostnadsstrukturer som är tillgängliga för planen.
|
| privacyPolicyUri |
string |
Sekretesspolicyn för produkten |
| productFamily |
string |
Produktfamilj |
| productId |
string |
Produktens unika id |
| productSubType |
string |
Typ av produkt |
| productType |
string |
Anger den primära distributionsmodellen och värdarkitekturen för Marketplace-produkten som lagras i Marketplace-katalogen.
|
| publisherDisplayName |
string |
Utgivarens visningsnamn |
| publisherId |
string |
Utgivarens id |
| publisherType |
string |
Identifierar utgivarens relation till Microsoft för klassificering av support och partnerskap.
|
| publishingStage |
string |
Anger produktens tillgänglighetsstatus och kundåtkomstnivå i Azure Marketplace.
|
| ratingAverage |
number (double) |
Genomsnittligt betyg för erbjudandet |
| ratingBuckets |
string[] |
Kategoriserar produkter efter tröskelvärden för kundbetyg för filtrering och upptäckt på marknadsplatsen.
|
| ratingCount |
integer (int32) |
Totalt antal omdömen för erbjudandet |
| service |
string |
Tjänstnamnet på produkten, till exempel "Virtual Machines" |
| serviceFamily |
string |
Produktens tjänstfamilj, till exempel "Compute" |
| smallIconUri |
string |
URI till den lilla produktikonen |
| summary |
string |
Sammanfattning av produkten |
| supportedProducts |
string[] |
Mappar till listan över kompatibla produkter |
| uniqueProductId |
string |
Unik produktidentifierare |
ProductSummaryListResult
Det anpassade svaret för en liståtgärd.
| Name | Typ | Description |
|---|---|---|
| nextLink |
string |
Länken till nästa sida med objekt |
| value |
Objekten på den här sidan |