Product List - List By Subscription
Geeft een lijst van producten waarop u zich kunt abonneren.
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-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
De id van het doelabonnement. De waarde moet een UUID zijn. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
|
$expand
|
query |
string |
Breidt gerelateerde entiteiten inline uit |
|
|
$filter
|
query |
string |
Filtert de resultaten op basis van een Booleaanse voorwaarde. Voorbeeld: $filter=productType eq 'VirtualMachine'. Velden waarop kan worden gefilterd zijn:
|
|
|
$order
|
query |
string |
Rangschikking van expressie voor de resultaten met behulp van OData-notatie. Vermijd het gebruik van orderby, tenzij dit essentieel is, omdat dit van invloed kan zijn op de latentie van uw verzoek. Voorbeeld: $orderby=displayName desc. Deze API ondersteunt alleen het bestellen op basis van een enkel veld. Velden die kunnen worden geordend op zijn:
|
|
|
$search
|
query |
string |
Optioneel zoeken op weergavenaam, weergavenaam van uitgever of trefwoorden. Voorbeeld $search=Microsoft |
|
|
$select
|
query |
string |
Selecteert welke eigenschappen in de resultaten moeten worden opgenomen. Voorbeeld: $select=weergavenaam |
|
|
exclude
|
query |
boolean |
Of openbare aanbiedingen en openbare plannen moeten worden uitgesloten van de reactie. Standaard is onwaar, wat betekent dat openbare aanbiedingen en openbare abonnementen zijn opgenomen in de reactie. Als je deze instelling op waar zet, worden alleen privéabonnementen geretourneerd. |
|
|
language
|
query |
string |
Taal om te zoeken, ISO 639-1 tweeletterige code, mogelijke waarden - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. De standaardinstelling is "en" |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
azure_auth
OAuth2-stroom voor Azure Active Directory.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
ProductList_ListBySubscription
Voorbeeldaanvraag
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
Voorbeeldrespons
{
"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..."
}
Definities
| Name | Description |
|---|---|
| Attribute |
Vertegenwoordigt een SKU-kenmerk, dat bestaat uit een sleutel en een waarde. De kenmerken kunnen verschillen tussen verschillende services. |
|
Discovery |
Foutdetails die worden geretourneerd in DiscoveryErrorPayload |
|
Discovery |
Fout-payload geretourneerd door Marketplace Discovery-API's |
|
Plan |
Aanvullende metagegevens |
|
Plan |
Retourneert een subset van plankenmerken |
|
Product |
Retourneert een subset van productkenmerken |
|
Product |
De aangepaste reactie van een lijstbewerking. |
Attribute
Vertegenwoordigt een SKU-kenmerk, dat bestaat uit een sleutel en een waarde. De kenmerken kunnen verschillen tussen verschillende services.
| Name | Type | Description |
|---|---|---|
| key |
string |
De kenmerktoets |
| value |
string |
De waarde van het kenmerk |
DiscoveryErrorDetails
Foutdetails die worden geretourneerd in DiscoveryErrorPayload
| Name | Type | Description |
|---|---|---|
| code |
string |
De HTTP-foutcode |
| message |
string |
Het foutbericht |
DiscoveryErrorPayload
Fout-payload geretourneerd door Marketplace Discovery-API's
| Name | Type | Description |
|---|---|---|
| error |
Het object met foutdetails |
PlanMetadata
Aanvullende metagegevens
| Name | Type | Description |
|---|---|---|
| altStackReference |
string |
Aanwijzen naar een planId die de alternatieve stackverwijzing bevat |
| generation |
string |
Het genereren van VM-installatiekopieën (alleen van toepassing op Virtual Machine-producten) |
PlanSummary
Retourneert een subset van plankenmerken
| Name | Type | Description |
|---|---|---|
| altArchitectureReference |
string |
De alternatieve architectuurreferentie |
| altStackReference |
string |
Alternatieve stackreferentie |
| categoryIds |
string[] |
Plan CategoryIds |
| cspState |
string |
Bepaalt de beschikbaarheid van het plan en de toegang van partners binnen het Microsoft Cloud Solution Provider (CSP)-programma.
|
| description |
string |
Plan / SKU beschrijving |
| displayName |
string |
Weergavenaam van het plan / sku |
| displayRank |
string |
De volgorde waarin het plan wordt weergegeven in de tabel 'Plannen' |
| hasProtectedArtifacts |
boolean |
Ingesteld op true als het plan artefacten bevat die moeten worden verborgen voor niet-geverifieerde gebruikers |
| hasRi |
boolean |
Indicatie of de SKU reserveringen ondersteunt |
| isPrivate |
boolean |
Indicatie dat het abonnement alleen toegankelijk is voor een beperkt publiek |
| metadata |
Uitgebreide plan-/SKU-metagegevens. |
|
| planId |
string |
Identificatie van het plan |
| planType |
string |
Hiermee geeft u het primaire implementatiemodel en de hostingarchitectuur voor het Marketplace-product op. Momenteel ondersteunde waarden zijn:
|
| pricingTypes |
string[] |
Geeft de factureringsmodellen en kostenstructuren aan die beschikbaar zijn voor het abonnement.
|
| skuId |
string |
De SKU-id |
| stackType |
string |
Type stapel : Klassiek, Gen1, Gen2 |
| summary |
string |
De samenvattende tekst van het plan |
| uniquePlanId |
string |
Unieke plan-ID die wordt voorafgegaan door een combinatie van uniqueProductId en PlanId zonder scheidingsteken ertussen |
| vmArchitectureType |
string |
Hiermee geeft u de architectuur en generatie van de processor van de virtuele machine op. Is uitsluitend van toepassing op producttypen van virtuele machines.
|
| vmSecuritytypes |
string[] |
Definieert het beveiligingsverbeteringsniveau voor implementaties van virtuele machines. Is uitsluitend van toepassing op producttypen van virtuele machines.
|
ProductSummary
Retourneert een subset van productkenmerken
| Name | Type | Description |
|---|---|---|
| applicableProducts |
string[] |
Productcategorieën waartoe het aanbod behoort |
| attributes |
Set productkenmerken |
|
| azureBenefit |
string |
Geeft aan of productaankopen meetellen voor de voordelen van Azure-verbruikstoezegging voor zakelijke klanten.
|
| badges |
string[] |
Geeft certificerings- en kwalificatiebadges weer die door het product zijn verdiend voor zichtbaarheid op de markt.
|
| categoryIds |
string[] |
Scala aan productcategorieën |
| cspLegalTermsUri |
string |
De wettelijke voorwaarden van het product voor de CSP |
| description |
string |
De tekst van de productbeschrijving |
| displayName |
string |
Weergavenaam van het product |
| hasMarketplaceFootprint |
boolean |
Indicatie of het product een vertegenwoordiging op de markt heeft |
| hasRiPlans |
boolean |
Indicatie of het product plannen heeft met voorbehoud |
| industryIds |
string[] |
Lijst met branche-ID's waartoe het item behoort |
| lastModifiedDateTime |
string |
Laatste updatedatum van het product |
| locations |
string[] |
Lijst van locaties die beschikbaar zijn op de SKU's |
| longSummary |
string |
Product lange samenvatting |
| operatingSystems |
string[] |
Informatie over het besturingssysteem voor dit product |
| plans |
Volledige set plan-/SKU-kenmerken |
|
| popularity |
number (double) |
Populariteit van het product |
| pricingTypes |
string[] |
Geeft de factureringsmodellen en kostenstructuren aan die beschikbaar zijn voor het abonnement.
|
| privacyPolicyUri |
string |
Het privacybeleid van het product |
| productFamily |
string |
Productfamilie |
| productId |
string |
De unieke id van het product |
| productSubType |
string |
Subtype product |
| productType |
string |
Hiermee geeft u het primaire implementatiemodel en de hostingarchitectuur op voor het Marketplace-product dat is opgeslagen in de Marketplace-catalogus.
|
| publisherDisplayName |
string |
Weergavenaam van uitgever |
| publisherId |
string |
Uitgever-id |
| publisherType |
string |
Identificeert de uitgeversrelatie met Microsoft voor ondersteuning en partnerschapsclassificatie.
|
| publishingStage |
string |
Geeft de beschikbaarheidsstatus van het product en het toegangsniveau van de klant aan binnen Azure Marketplace.
|
| ratingAverage |
number (double) |
Gemiddelde beoordeling voor de aanbieding |
| ratingBuckets |
string[] |
Categoriseert producten op basis van klantbeoordelingsdrempels voor het filteren en ontdekken van marktplaatsen.
|
| ratingCount |
integer (int32) |
Totaal aantal beoordelingen voor de aanbieding |
| service |
string |
De servicenaam van het product, zoals 'Virtual Machines' |
| serviceFamily |
string |
De servicefamilie van het product, zoals 'Compute' |
| smallIconUri |
string |
URI naar het kleine productpictogram |
| summary |
string |
Product samenvatting |
| supportedProducts |
string[] |
Kaarten naar de lijst met compatibele producten |
| uniqueProductId |
string |
Unieke productidentificatie |
ProductSummaryListResult
De aangepaste reactie van een lijstbewerking.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
De koppeling naar de volgende pagina met items |
| value |
De items op deze pagina |