Products - List
Rufen Sie eine Liste kommerzieller börsennotierter Produkte ab.
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}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version der REST-API, die für die Anforderung verwendet wird. |
|
expand
|
query |
string[] |
Erweitert verwandte Entitäten inline. Beispiel: 'expand=startingPrice' |
|
|
filter
|
query |
string |
Filtert die Ergebnisse basierend auf einer booleschen Bedingung. Beispiel: 'filter=productType eq "VirtualMachine"'. Felder, nach denen gefiltert werden kann, sind:
|
|
|
hide
|
query |
string[] |
Dieser Schlüssel wird verwendet, um Vorschauprodukte abzurufen und während des Angebotsveröffentlichungsprozesses im Partner Center generiert zu werden. |
|
|
language
|
query |
string |
Sprache für die Suche, ISO 639-1-Code mit zwei Buchstaben, mögliche Werte - "en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant". Der Standardwert ist "en" |
|
|
locations
|
query |
string[] |
Gibt Produkte zurück, die an ausgewähltem Speicherort verfügbar sind. Enumeration der Azure-Rechenzentrumsregionen. Siehe https://azure.microsoft.com/regions/. |
|
|
market
|
query |
string |
Produktmarktwert (die Antwort enthält nur Produkte, die auf dem angegebenen Markt verkauft werden können) Mögliche Werte finden Sie unter https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Beispiel: 'US' |
|
|
orderby
|
query |
string |
Sortierungsausdruck für die Ergebnisse mithilfe der OData-Schreibweise. Vermeiden Sie die Verwendung von "orderby", es sei denn, dies kann sich auf die Latenz Ihrer Anforderung auswirken. Beispiel: 'orderby=displayName desc'. Diese API unterstützt nur die Sortierung nach einem einzelnen Feld. Felder, nach denen sortiert werden kann, sind:
|
|
|
select
|
query |
string[] |
Wählt aus, welche Eigenschaften in die Ergebnisse einbezogen werden sollen. Beispiel: 'select=displayName' |
|
|
storefront
|
query |
string |
Gibt Produkte zurück, die im Azure Portal Marketplace-, AppSource- oder Azure Marketplace-Portal verfügbar sind. Mögliche Werte sind:
|
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| X-API-Key | True |
string |
Verwenden des api-Schlüssels, der vom Marketplace Catalog Team als Parameter im Header bereitgestellt wird |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Gibt eine Liste von öffentlichen oder Vorschauprodukten zurück. |
|
| Other Status Codes |
Fehlerantworten:
Header x-ms-error-code: string |
Beispiele
List_Products
Beispielanforderung
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Beispiel für eine Antwort
{
"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..."
}
Definitionen
| Name | Beschreibung |
|---|---|
| Attribute |
Stellt ein SKU-Attribut dar, das aus einem Schlüssel und Wert besteht. Die Attribute können sich in verschiedenen Diensten unterscheiden. |
|
Azure |
Anspruch auf Azure-Nutzungsverpflichtungsvorteil (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Mögliche Werte:
|
| Badge |
Signaltyp |
|
Catalog |
Antwortseite, die aus einer Liste von Produktobjekten (einschließlich Teilmenge von Produktattributen) zusammen mit einem Link zur nächsten Seite besteht. In der Regel werden produktattribute, die in der Liste zurückgegeben werden, verwendet, um Produktkacheln für Marketplace Gallery zu erstellen. Hinweis:Hinweis: Die maximale Anzahl der pro Seite zurückgegebenen Elemente beträgt 100. In bestimmten Fällen zur Leistungsoptimierung wenden Sie sich bitte an das Microsoft Marketplace-Team MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Wert, der anzeigt, ob der Plan über den CSP-Kanal zum Kauf verfügbar ist. Mögliche Werte:
|
|
Error |
Das API-Fehlerantwortobjekt |
|
Error |
Das API-Fehlerantwort-Detailobjekt |
| Metadata |
Erweiterte Plan-/SKU-Metadaten. |
|
Plan |
Verweisen auf ein verwandtes SKU-Objekt |
|
Plan |
Gibt eine Teilmenge von Plan-Attributen zurück. |
|
Plan |
Plantyp für verwaltete Anwendungen oder Lösungsvorlagen (gilt nur für Azure Applications-Produkte). Mögliche Werte:
|
|
Pricing |
Preisart |
|
Product |
Gibt eine Teilmenge von Produktattributen zurück. |
|
Product |
Die Übermittlungsmethode oder das Bereitstellungsmodell. Mögliche Werte:
|
|
Publisher |
Ein Wert, der angibt, ob es sich um ein Microsoft- oder Drittanbieterprodukt handelt. Mögliche Werte:
|
|
Publishing |
Produktveröffentlichungsphase. Mögliche Werte:
|
|
Rating |
Bewertungs-Bucket |
| Sku |
Die Sku |
|
Starting |
Verkaufspreis des billigsten Plans des Produkts |
|
Vm |
VM-Architekturtyp. Gilt nur für Produkte des virtuellen Computers. Mögliche Werte:
|
|
Vm |
VM-Sicherheitstyp. Gilt nur für Produkte des virtuellen Computers. Mögliche Werte:
|
Attribute
Stellt ein SKU-Attribut dar, das aus einem Schlüssel und Wert besteht. Die Attribute können sich in verschiedenen Diensten unterscheiden.
| Name | Typ | Beschreibung |
|---|---|---|
| key |
string |
Der Attributschlüssel |
| value |
string |
Der Attributwert |
AzureBenefit
Anspruch auf Azure-Nutzungsverpflichtungsvorteil (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Mögliche Werte:
-
Eligible– Das Produkt ist für den Azure-Verbrauchsverpflichtungsvorteil berechtigt. -
NotEligible– Das Produkt ist nicht für den Azure-Verbrauchsverpflichtungsvorteil berechtigt.
| Wert | Beschreibung |
|---|---|
| Eligible | |
| NotEligible |
Badge
Signaltyp
| Wert | Beschreibung |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Antwortseite, die aus einer Liste von Produktobjekten (einschließlich Teilmenge von Produktattributen) zusammen mit einem Link zur nächsten Seite besteht. In der Regel werden produktattribute, die in der Liste zurückgegeben werden, verwendet, um Produktkacheln für Marketplace Gallery zu erstellen. Hinweis:Hinweis: Die maximale Anzahl der pro Seite zurückgegebenen Elemente beträgt 100. In bestimmten Fällen zur Leistungsoptimierung wenden Sie sich bitte an das Microsoft Marketplace-Team MKPL_Platform_API_DL@microsoft.com
| Name | Typ | Beschreibung |
|---|---|---|
| items |
Die Liste der zurückgegebenen Elemente |
|
| nextPageLink |
string (uri) |
Link zur nächsten Seite, auf der die Anforderung mehr als eine einzelne Seite mit Ergebnissen zurückgibt |
CspState
Wert, der anzeigt, ob der Plan über den CSP-Kanal zum Kauf verfügbar ist. Mögliche Werte:
-
OptIn– Planen der konfigurierten CSP-Programm-Opt-Ins für jeden Partner im CSP-Programm -
Optout– Planen der deaktivierung des CSP-Programms -
SelectiveOptIn– Plan konfigurierte CSP-Programm-Opt-In für bestimmte Partner im CSP-Programm ISV wählt aus. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Wert | Beschreibung |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Das API-Fehlerantwortobjekt
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Die API-Antwortdetails |
ErrorResponseDetails
Das API-Fehlerantwort-Detailobjekt
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Die Fehlercodebeschreibung. Beispiel: Code=InternalError |
| message |
string |
Die Fehlermeldung. Beispiel: message=Interner Serverfehler |
Metadata
Erweiterte Plan-/SKU-Metadaten.
| Name | Typ | Beschreibung |
|---|---|---|
| altStackReference |
string |
Verweisen auf eine planId, die den alternativen Stapelverweis enthält |
| generation |
string |
Die VM-Imagegenerierung (gilt nur für Produkte des virtuellen Computers).Siehe https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Verweisen auf eine planId von Plänen, die mit diesem Plan zusammenhängen |
PlanSkuRelation
Verweisen auf ein verwandtes SKU-Objekt
| Name | Typ | Beschreibung |
|---|---|---|
| relationType |
string |
Beziehungstyp |
| sku |
Die Sku |
PlanSummary
Gibt eine Teilmenge von Plan-Attributen zurück.
| Name | Typ | Beschreibung |
|---|---|---|
| altArchitectureReference |
string |
Die Referenz zur alternativen Architektur |
| altStackReference |
string |
Alternativer Stapelverweis |
| categoryIds |
string[] |
Planen von CategoryIds |
| cspState |
Wert, der anzeigt, ob der Plan über den CSP-Kanal zum Kauf verfügbar ist. Mögliche Werte:
|
|
| description |
string |
Plan/Sku-Beschreibung |
| displayName |
string |
Anzeigename des Plans /sku |
| displayRank |
string |
Die Reihenfolge, in der der Plan in der Tabelle "Pläne" angezeigt wird (wie vom Herausgeber konfiguriert) |
| hasProtectedArtifacts |
boolean |
Auf "true" festlegen, wenn der Plan Artefakte enthält, die für nicht authentifizierte Benutzer ausgeblendet werden sollen |
| hasRI |
boolean |
Angeben, ob die SKU Reservierungen unterstützt |
| isPrivate |
boolean |
Hinweis, dass der Plan nur für eingeschränkte Benutzergruppen zugänglich ist |
| metadata |
Erweiterte Plan-/SKU-Metadaten. |
|
| planId |
string |
Plan-ID |
| planType |
Plantyp für verwaltete Anwendungen oder Lösungsvorlagen (gilt nur für Azure Applications-Produkte). Mögliche Werte:
|
|
| pricingTypes |
Die Liste der Preistypen, für die dieser Plan festgelegt ist (Mögliche Werte sind identisch mit der Produktebene) |
|
| skuId |
string |
Die SKU-ID |
| stackType |
string |
Stapeltyp: Klassisch, Gen1, Gen2 |
| summary |
string |
Der Zusammenfassungstext des Plans |
| uniquePlanId |
string |
Eindeutige Plan-ID, die durch Kombinieren von uniqueProductId und PlanId ohne Trennzeichen dazwischen vorangestellt wird |
| vmArchitectureType |
VM-Architekturtyp. Gilt nur für Produkte des virtuellen Computers. Mögliche Werte:
|
|
| vmSecuritytypes |
VM-Sicherheitstyp. Gilt nur für Produkte des virtuellen Computers. Mögliche Werte:
|
PlanType
Plantyp für verwaltete Anwendungen oder Lösungsvorlagen (gilt nur für Azure Applications-Produkte). Mögliche Werte:
-
SolutionTemplate– Plantyp der Lösungsvorlage (gilt nur für Azure-Anwendungen) -
ManagedApplication– Typ des verwalteten Anwendungsplans (gilt nur für Azure-Anwendungen)
PricingType
Preisart
| Wert | Beschreibung |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Gibt eine Teilmenge von Produktattributen zurück.
| Name | Typ | Beschreibung |
|---|---|---|
| applicableProducts |
string[] |
Produktkategorien, zu der das Angebot gehört |
| attributes |
Gruppe von Produktattributen (variiert je nach Produkttyp), wobei jedes Attribut durch ein Schlüsselpaar (Attributname) und Wert(Attributwert) dargestellt wird. |
|
| azureBenefit |
Anspruch auf Azure-Nutzungsverpflichtungsvorteil (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Mögliche Werte:
|
|
| badges |
Badge[] |
Die folgenden Produkt-Badges sind verfügbar: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Array von Produktkategorien, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. z. B. "Produktivität" |
| cspLegalTermsUri |
string |
Die rechtlichen Bestimmungen des Produkts für den CSP |
| description |
string |
Der Text der Produktbeschreibung |
| displayName |
string |
Produktanzeigename |
| hasMarketplaceFootprint |
boolean |
Angabe, ob das Produkt eine Vertretung auf dem Markt hat |
| hasRIPlans |
boolean |
Angabe, ob das Produkt Pläne mit Reservierungen hat |
| industryIds |
string[] |
Liste der Branchen-IDs, zu der das Element gehört |
| lastModifiedDateTime |
string (date-time) |
Neuestes Updatedatum des Produkts |
| linkedAddInsTypes |
object |
Verknüpfte Add-In-Typen |
| locations |
string[] |
Liste der Speicherorte, die auf den SKUs verfügbar sind |
| longSummary |
string |
Lange Produktzusammenfassung |
| operatingSystems |
string[] |
Betriebssysteminformationen für dieses Produkt |
| plans |
Liste der Pläne, die für dieses Produkt verfügbar sind |
|
| popularity |
number (double) |
Beliebtheit des Produkts |
| pricingTypes |
Die Liste der Preistypen, für die dieses Angebot festgelegt ist. Mögliche Werte:
|
|
| privacyPolicyUri |
string |
Die Datenschutzrichtlinie des Produkts |
| productFamily |
string |
Produktfamilie |
| productId |
string |
Die eindeutige ID des Produkts |
| productSubType |
string |
Produktuntertyp |
| productType |
Die Übermittlungsmethode oder das Bereitstellungsmodell. Mögliche Werte:
|
|
| publisherDisplayName |
string |
Anzeigename des Herausgebers |
| publisherId |
string |
Herausgeber-ID |
| publisherType |
Ein Wert, der angibt, ob es sich um ein Microsoft- oder Drittanbieterprodukt handelt. Mögliche Werte:
|
|
| publishingStage |
Produktveröffentlichungsphase. Mögliche Werte:
|
|
| ratingAverage |
number (double) |
Durchschnittliche Bewertung für das Angebot |
| ratingBuckets |
Bewertungs-Buckets, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Gesamtanzahl der Bewertungen für das Angebot |
| service |
string |
Der Dienstname des Produkts, z. B. "Virtuelle Computer" |
| serviceFamily |
string |
Die Dienstfamilie des Produkts, z. B. "Compute" |
| smallIconUri |
string |
URI für das kleine Produktsymbol |
| startingPrice |
Verkaufspreis des billigsten Plans des Produkts |
|
| summary |
string |
Produktzusammenfassung |
| supportedProducts |
string[] |
Ordnet der Liste der kompatiblen Produkte zu, die der Herausgeber bereitstellt |
| uniqueProductId |
string |
Eindeutiger Produktbezeichner |
ProductType
Die Übermittlungsmethode oder das Bereitstellungsmodell. Mögliche Werte:
-
SaaS– Das Produkt ist eine Softwarelösung, die auf Pay-as-you-go-Basis von einem Clouddienstanbieter erworben wurde -
VirtualMachine– Das Produkt ist Image-Dienstinstanzen mit nutzungsbasierten Preisen -
AzureApplication– Produkte, die als Lösungsvorlagen (Solution Templates, ST) oder Azure Managed Apps (AMA) veröffentlicht wurden, die Azure-Ressourcen für den Kundenmandanten bereitstellen -
DynamicsCE– Alle Dynamics-Produkte mit Ausnahme von DynamicsBC und DynamicsOps -
DynamicsBC– Dynamics 365 Business Central -
Container- Das Produkt wird als Container geliefert -
DynamicsOps– Dynamics 365 Operations Apps -
None– Für Azure Services, Containererweiterungen und VM-Erweiterungen zurückgegebener Produkttyp -
IotEdgeModules– Ressource wird als IoT Edge Module bereitgestellt -
ContainerApps– Ressource wird als Container-App bereitgestellt -
ConsultingServicesConsulting Services (nur in Azure Marketplace als Angebotsauflistung verfügbar) -
ManagedServices– Das Produkt wird als verwalteter Dienst geliefert -
PowerBI– Power BI-Produkte -
CosellOnly- Nur im Rahmen Co-Sell Programms verfügbare Produkte -
PowerBIVisuals– Power BI Visuals-Produkte -
Office365– Office 365-Produkte -
DevService– Dev Service -
AADApps– Azure Active Directory-Anwendungen -
VisualStudioExtension– Visual Studio-Erweiterungen -
SolutionTemplate– Plantyp der Lösungsvorlage (gilt nur für Azure-Anwendungen) -
ManagedApplication– Typ des verwalteten Anwendungsplans (gilt nur für Azure-Anwendungen) -
MicrosoftProduct– 1. Azure-Produkt von Drittanbietern
| Wert | Beschreibung |
|---|---|
| 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
Ein Wert, der angibt, ob es sich um ein Microsoft- oder Drittanbieterprodukt handelt. Mögliche Werte:
-
Microsoft– Produkt wird von Microsoft veröffentlicht (Produkt der 1. Partei) -
Third Party- Produkt wird vom Drittanbieter veröffentlicht.
| Wert | Beschreibung |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Produktveröffentlichungsphase. Mögliche Werte:
-
Preview– Produkt ist für eingeschränkte Benutzergruppen verfügbar. -
Public– Das Produkt ist im Marketplace öffentlich verfügbar
| Wert | Beschreibung |
|---|---|
| Preview | |
| Public |
RatingBucket
Bewertungs-Bucket
| Wert | Beschreibung |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Die Sku
| Name | Typ | Beschreibung |
|---|---|---|
| generation |
string |
Die Generation |
| identity |
string |
Die Identität |
| name |
string |
Der Name |
StartingPrice
Verkaufspreis des billigsten Plans des Produkts
| Name | Typ | Beschreibung |
|---|---|---|
| currency |
string |
Währung zum Preis |
| market |
string |
Der Markt, für den der Startpreis berechnet wird |
| meterUnits |
string |
Die Meter-Preismodelleinheiten |
| minMeterPrice |
number |
Start (minimal) Meter Preis |
| minTermPrice |
number |
Startpreis (minimal) |
| termUnits |
string |
Die Preismodelleinheiten |
VmArchitectureType
VM-Architekturtyp. Gilt nur für Produkte des virtuellen Computers. Mögliche Werte:
-
Arm64– Die VM-Imagearchitektur des Plans ist Arm64. -
X64Gen1– Die VM-Imagearchitektur des Plans ist X64 Generation1 -
X64Gen2– Die VM-Imagearchitektur des Plans ist X64 Generation2
| Wert | Beschreibung |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
VM-Sicherheitstyp. Gilt nur für Produkte des virtuellen Computers. Mögliche Werte:
- Standard – Grundlegende Sicherheitsstufe für den virtuellen Computer
- Vertrauenswürdig – schützt vor persistenten und erweiterten Angriffen auf virtuellen Gen2-Computern mit konfigurierbaren Features wie Sicherheitsstart und virtuellem Trusted Platform Module(vTPM)
- Vertraulich – über den vertrauenswürdigen Start hinaus bieten virtuelle Computer höhere Vertraulichkeit und Integrität, die mit hardwarebasierter vertrauenswürdiger Ausführungsumgebung gewährleistet ist
| Wert | Beschreibung |
|---|---|
| None | |
| Trusted | |
| Confidential |