Products - List
Api voor openbare producten biedt een niet-geverifieerd eindpunt voor het gebruik van openbare marketplace-producten van derden en azure-producten van derden. Daarnaast kan Odata worden gefilterd op geselecteerde producteigenschappen. Elke API-aanvraag moet een API-sleutel bevatten die aan u is toegewezen (zie de beschrijving van X-API-Key). Verzend een e-mailbericht naar MKPL_Platform_API_DL@microsoft.com met de volgende details om de API-sleutel op te halen:
- Klantnaam
- Service-/productnaam
- Ad-geregistreerde app-id (indien beschikbaar)
- Brandpunt-e-mail
- Use case/scenario
- Verwacht verkeersvolume, inclusief piekaanvragen per seconde (dagelijks)
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-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versie van de REST API die wordt gebruikt voor de aanvraag. |
expand
|
query |
string[] |
Breidt gerelateerde entiteiten inline uit. Voorbeeld: 'expand=startingPrice' |
|
filter
|
query |
string |
Filtert de resultaten op basis van een Booleaanse voorwaarde. Voorbeeld: 'filter=productType eq 'VirtualMachine'. Velden waarop kan worden gefilterd, zijn:
|
|
hide
|
query |
string[] |
Deze sleutel wordt gebruikt om preview-producten op te halen en wordt gegenereerd in het Partnercentrum tijdens het publicatieproces van de aanbieding. |
|
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,zh-hans,zh-hant'. De standaardwaarde is 'en' |
|
locations
|
query |
string[] |
Retourproducten die beschikbaar zijn op de geselecteerde locatie. Opsomming van de Azure-datacenterregio's. Zie https://azure.microsoft.com/regions/ |
|
market
|
query |
string |
Productmarktwaarde (het antwoord bevat alleen producten die op de opgegeven markt kunnen worden verkocht) Mogelijke waarden zijn te vinden op https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Voorbeeld: 'VS' |
|
orderby
|
query |
string |
Orderexpressie voor de resultaten met behulp van OData-notatie. Vermijd het gebruik van orderby, tenzij dit essentieel is voor de latentie van uw aanvraag. Voorbeeld: 'orderby=displayName desc'. Deze API biedt alleen ondersteuning voor bestellen op basis van één veld. Velden waarop u kunt sorteren, zijn:
|
|
select
|
query |
string[] |
Hiermee selecteert u welke eigenschappen u wilt opnemen in de resultaten. Voorbeeld: 'select=displayName' |
|
storefront
|
query |
string |
Retourneert producten die beschikbaar zijn in Azure Portal Marketplace, AppSource of Azure Marketplace Portal. De mogelijke waarden zijn:
|
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
X-API-Key | True |
string |
Api-sleutel van marketplace-catalogusteam gebruiken als een parameter die is opgegeven in de header |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Retourneert een lijst met openbare of preview-producten |
|
Other Status Codes |
Foutreacties:
Kopteksten x-ms-error-code: string |
Voorbeelden
List_Products
Voorbeeldaanvraag
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Voorbeeldrespons
{
"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..."
}
Definities
Name | Description |
---|---|
Attribute |
Vertegenwoordigt een SKU-kenmerk, dat bestaat uit een sleutel en waarde. De kenmerken kunnen verschillen tussen verschillende services. |
Azure |
Geschiktheid voor azure-verbruiksverplichtingsvoordeel (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Mogelijke waarden:
|
Badge |
Badgetype |
Catalog |
Antwoordpagina samengesteld uit een lijst met productobjecten (die een subset van productkenmerken bevat) samen met een koppeling naar de volgende pagina. Meestal worden productkenmerken die in de lijst worden geretourneerd, gebruikt voor het bouwen van producttegels voor Marketplace Gallery. Opmerking:opmerking: het maximum aantal geretourneerde items per pagina is 100. Neem in specifieke gevallen voor prestatieoptimalisatie contact op met het Microsoft Marketplace-team MKPL_Platform_API_DL@microsoft.com |
Csp |
Waarde die aangeeft of het abonnement beschikbaar is voor aankoop via het CSP-kanaal. Mogelijke waarden:
|
Error |
Het ANTWOORDobject voor API-fouten |
Error |
Het object met details van het API-foutantwoord |
Metadata |
Uitgebreide plan-/SKU-metagegevens. |
Plan |
Een gerelateerd SKU-object aanwijzen |
Plan |
Retourneert een subset van plankenmerken |
Plan |
Type sjabloonplan voor beheerde toepassing of oplossing (alleen van toepassing op azure-toepassingen). Mogelijke waarden:
|
Pricing |
Prijstype |
Product |
Hiermee wordt een subset van productkenmerken geretourneerd |
Product |
De leveringsmethode of het implementatiemodel. Mogelijke waarden:
|
Publisher |
Een waarde die aangeeft of dit een Microsoft- of een product van derden is. Mogelijke waarden:
|
Publishing |
De publicatiefase van het product. Mogelijke waarden:
|
Rating |
Classificatiebucket |
Sku |
De SKU |
Starting |
Verkoopprijs van het goedkoopste abonnement van het product |
Vm |
Type VM-architectuur. Alleen van toepassing op producten van virtuele machines. Mogelijke waarden:
|
Vm |
VM-beveiligingstype. Alleen van toepassing op producten van virtuele machines. Mogelijke waarden:
|
Attribute
Vertegenwoordigt een SKU-kenmerk, dat bestaat uit een sleutel en waarde. De kenmerken kunnen verschillen tussen verschillende services.
Name | Type | Description |
---|---|---|
key |
string |
De kenmerksleutel |
value |
string |
De kenmerkwaarde |
AzureBenefit
Geschiktheid voor azure-verbruiksverplichtingsvoordeel (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Mogelijke waarden:
-
Eligible
: het product komt in aanmerking voor azure-verbruiksverzeggingsvoordeel -
NotEligible
: het product komt niet in aanmerking voor azure-verbruiksverzeggingsvoordeel
Waarde | Description |
---|---|
Eligible | |
NotEligible |
Badge
Badgetype
Waarde | Description |
---|---|
AdditionalPurchaseRequirement | |
PowerBICertified | |
PreferredSolution |
CatalogApiResponse
Antwoordpagina samengesteld uit een lijst met productobjecten (die een subset van productkenmerken bevat) samen met een koppeling naar de volgende pagina. Meestal worden productkenmerken die in de lijst worden geretourneerd, gebruikt voor het bouwen van producttegels voor Marketplace Gallery. Opmerking:opmerking: het maximum aantal geretourneerde items per pagina is 100. Neem in specifieke gevallen voor prestatieoptimalisatie contact op met het Microsoft Marketplace-team MKPL_Platform_API_DL@microsoft.com
Name | Type | Description |
---|---|---|
items |
De lijst met geretourneerde items |
|
nextPageLink |
string (uri) |
Koppeling naar de volgende pagina waar de aanvraag meer dan één pagina met resultaten retourneert |
CspState
Waarde die aangeeft of het abonnement beschikbaar is voor aankoop via het CSP-kanaal. Mogelijke waarden:
-
OptIn
- Pland configured CSP program opt-in for any partner in the CSP Program -
Optout
- Pland configured CSP program opt-out -
SelectiveOptIn
- Plan geconfigureerde CSP-programma-opt-in voor specifieke partners in de CSP-programma ISV selecteert. Zie https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers voor meer informatie
Waarde | Description |
---|---|
OptIn | |
OptOut | |
SelectiveOptIn |
ErrorResponse
Het ANTWOORDobject voor API-fouten
Name | Type | Description |
---|---|---|
error |
Details van het API-antwoord |
ErrorResponseDetails
Het object met details van het API-foutantwoord
Name | Type | Description |
---|---|---|
code |
string |
De beschrijving van de foutcode. Zoals code=InternalError |
message |
string |
Het foutbericht. Zoals bericht=Interne serverfout |
Metadata
Uitgebreide plan-/SKU-metagegevens.
Name | Type | Description |
---|---|---|
altStackReference |
string |
Verwijzen naar een planId die de alternatieve stackverwijzing bevat |
generation |
string |
De vm-installatiekopieën genereren (alleen van toepassing op producten van virtuele machines).zie https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
relatedSkus |
Verwijzen naar een planId van plannen die zijn gerelateerd aan dit plan |
PlanSkuRelation
Een gerelateerd SKU-object aanwijzen
Name | Type | Description |
---|---|---|
relationType |
string |
Relatietype |
sku |
De SKU |
PlanSummary
Retourneert een subset van plankenmerken
Name | Type | Description |
---|---|---|
altArchitectureReference |
string |
De referentie voor alternatieve architectuur |
altStackReference |
string |
Alternatieve stack-verwijzing |
categoryIds |
string[] |
Categorie-id's plannen |
cspState |
Waarde die aangeeft of het abonnement beschikbaar is voor aankoop via het CSP-kanaal. Mogelijke waarden:
|
|
description |
string |
Beschrijving van plan/sKU |
displayName |
string |
Weergavenaam van het plan/sku |
displayRank |
string |
De volgorde waarin het plan wordt weergegeven in de tabel Plannen (zoals geconfigureerd door de uitgever) |
hasProtectedArtifacts |
boolean |
Ingesteld op Waar 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 plan alleen toegankelijk is voor beperkte doelgroepen |
metadata |
Uitgebreide plan-/SKU-metagegevens. |
|
planId |
string |
Plan-id |
planType |
Type sjabloonplan voor beheerde toepassing of oplossing (alleen van toepassing op azure-toepassingen). Mogelijke waarden:
|
|
pricingTypes |
De lijst met de prijstypen waarvoor dit plan wordt aangewezen (Mogelijke waarden zijn hetzelfde als op productniveau) |
|
skuId |
string |
De SKU-id |
stackType |
string |
Stacktype: Klassiek, Gen1, Gen2 |
summary |
string |
De overzichtstekst van het plan |
uniquePlanId |
string |
Unieke plan-id die wordt voorafgegaan door uniekeProductId en PlanId te combineren zonder scheidingsteken tussen |
vmArchitectureType |
Type VM-architectuur. Alleen van toepassing op producten van virtuele machines. Mogelijke waarden:
|
|
vmSecuritytypes |
VM-beveiligingstype. Alleen van toepassing op producten van virtuele machines. Mogelijke waarden:
|
PlanType
Type sjabloonplan voor beheerde toepassing of oplossing (alleen van toepassing op azure-toepassingen). Mogelijke waarden:
-
SolutionTemplate
- Type oplossingssjabloonplan (alleen van toepassing op Azure-toepassingen) -
ManagedApplication
- Type beheerde toepassingsplan (alleen van toepassing op Azure-toepassingen)
PricingType
Prijstype
Waarde | Description |
---|---|
Byol | |
Free | |
FreeTrial | |
Payg | |
Ri |
ProductSummary
Hiermee wordt een subset van productkenmerken geretourneerd
Name | Type | Description |
---|---|---|
applicableProducts |
string[] |
Productcategorieën waartoe de aanbieding behoort |
attributes |
Set productkenmerken (verschilt per producttype), waarbij elk kenmerk wordt vertegenwoordigd door een paar sleutels (kenmerknaam) en waarde (kenmerkwaarde) |
|
azureBenefit |
Geschiktheid voor azure-verbruiksverplichtingsvoordeel (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Mogelijke waarden:
|
|
badges |
Badge[] |
De volgende productbadges zijn beschikbaar: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
categoryIds |
string[] |
Matrix van productcategorieën, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Zoals 'Productiviteit' |
cspLegalTermsUri |
string |
De juridische voorwaarden van het product voor de CSP |
description |
string |
De tekst van de productbeschrijving |
displayName |
string |
Weergavenaam van product |
hasMarketplaceFootprint |
boolean |
Indicatie of het product een weergave heeft in de marketplace |
hasRIPlans |
boolean |
Indicatie of het product abonnementen heeft met reserveringen |
industryIds |
string[] |
Lijst met branche-id's waartoe het item behoort |
lastModifiedDateTime |
string (date-time) |
Meest recente updatedatum van het product |
linkedAddInsTypes |
object |
Gekoppelde typen invoegtoepassingen |
locations |
string[] |
Lijst met locaties die beschikbaar zijn op de SKU's |
longSummary |
string |
Lange samenvatting van product |
operatingSystems |
string[] |
Informatie over het besturingssysteem voor dit product |
plans |
Lijst met abonnementen die beschikbaar zijn voor dit product |
|
popularity |
number (double) |
Populariteit van het product |
pricingTypes |
De lijst met de prijstypen waarvoor deze aanbieding is aangewezen. Mogelijke waarden:
|
|
privacyPolicyUri |
string |
Het privacybeleid van het product |
productFamily |
string |
Productfamilie |
productId |
string |
De unieke id van het product |
productSubType |
string |
Subtype product |
productType |
De leveringsmethode of het implementatiemodel. Mogelijke waarden:
|
|
publisherDisplayName |
string |
Weergavenaam van Publisher |
publisherId |
string |
Uitgever-id |
publisherType |
Een waarde die aangeeft of dit een Microsoft- of een product van derden is. Mogelijke waarden:
|
|
publishingStage |
De publicatiefase van het product. Mogelijke waarden:
|
|
ratingAverage |
number (double) |
Gemiddelde waardering voor de aanbieding |
ratingBuckets |
Classificatie buckets, Boven1, Boven2, Boven3, Boven4 |
|
ratingCount |
integer (int32) |
Totaal aantal beoordelingen voor de aanbieding |
service |
string |
De servicenaam van het product, zoals 'Virtuele machines' |
serviceFamily |
string |
De servicefamilie van het product, zoals 'Compute' |
smallIconUri |
string |
URI naar het kleine productpictogram |
startingPrice |
Verkoopprijs van het goedkoopste abonnement van het product |
|
summary |
string |
Productoverzicht |
supportedProducts |
string[] |
Wordt toegewezen aan de lijst met compatibele producten die door de uitgever worden geleverd |
uniqueProductId |
string |
Unieke productidentificatie |
ProductType
De leveringsmethode of het implementatiemodel. Mogelijke waarden:
-
SaaS
- Het product is een softwareoplossing die is gekocht op basis van betalen per gebruik van een cloudserviceprovider -
VirtualMachine
- Het product is Image Service-exemplaren met prijzen op basis van gebruik -
AzureApplication
- Producten die zijn gepubliceerd als oplossingssjablonen (ST) of Azure Managed Apps-abonnementen (AMA) die Azure-resources implementeren in de tenant van de klant -
DynamicsCE
- Alle Dynamics-producten, met uitzondering van DynamicsBC en DynamicsOps -
DynamicsBC
- Dynamics 365 business Central -
Container
- Het product wordt geleverd als container -
DynamicsOps
- Dynamics 365 Operations Apps -
None
- Producttype geretourneerd voor Azure Services, Container Extensions en VM-extensies -
IotEdgeModules
- Resource wordt geleverd als IoT Edge-module -
ContainerApps
- Resource wordt geleverd als container-app -
ConsultingServices
Consulting Services (alleen beschikbaar in Azure Marketplace als aanbieding) -
ManagedServices
- Het product wordt geleverd als Managed Service -
PowerBI
- Power BI-producten -
CosellOnly
- Producten die alleen beschikbaar zijn binnen het bereik van Co-Sell programma -
PowerBIVisuals
- Power BI Visuals-producten -
Office365
- Office 365-producten -
DevService
- Dev Service -
AADApps
- Azure Active Directory-toepassingen -
VisualStudioExtension
- Visual Studio-extensies -
SolutionTemplate
- Type oplossingssjabloonplan (alleen van toepassing op Azure-toepassingen) -
ManagedApplication
- Type beheerde toepassingsplan (alleen van toepassing op Azure-toepassingen) -
MicrosoftProduct
- Azure-product van één partij
Waarde | Description |
---|---|
AADApps | |
AppService | |
AzureApplication | |
AzureServices | |
ConsultingServices | |
Container | |
ContainerApps | |
CoreVirtualMachine | |
CosellOnly | |
DevService | |
DynamicsBC | |
DynamicsCE | |
DynamicsOps | |
IotEdgeModules | |
LogAnalytics | |
ManagedApplication | |
ManagedServices | |
MicrosoftProduct | |
None | |
Office365 | |
PowerBI | |
PowerBIVisuals | |
SaaS | |
SolutionTemplate | |
VirtualMachine | |
VisualStudioExtension |
PublisherType
Een waarde die aangeeft of dit een Microsoft- of een product van derden is. Mogelijke waarden:
-
Microsoft
- Product wordt gepubliceerd door Microsoft (product van derden) -
Third Party
- Product wordt gepubliceerd door externe leverancier
Waarde | Description |
---|---|
Microsoft | |
ThirdParty |
PublishingStage
De publicatiefase van het product. Mogelijke waarden:
-
Preview
- Product is beschikbaar voor een beperkt publiek -
Public
- Product is openbaar beschikbaar in Marketplace
Waarde | Description |
---|---|
Preview | |
Public |
RatingBucket
Classificatiebucket
Waarde | Description |
---|---|
AboveFour | |
AboveOne | |
AboveThree | |
AboveTwo |
Sku
De SKU
Name | Type | Description |
---|---|---|
generation |
string |
De generatie |
identity |
string |
De identiteit |
name |
string |
De naam |
StartingPrice
Verkoopprijs van het goedkoopste abonnement van het product
Name | Type | Description |
---|---|---|
currency |
string |
Valuta voor prijs |
market |
string |
De markt waarvoor de startprijs wordt berekend |
meterUnits |
string |
De meters prijsmodeleenheden |
minMeterPrice |
number |
Vanaf (minimale) meterprijs |
minTermPrice |
number |
Prijs voor beginnende (minimale) voorwaarden |
termUnits |
string |
De termen prijsmodeleenheden |
VmArchitectureType
Type VM-architectuur. Alleen van toepassing op producten van virtuele machines. Mogelijke waarden:
-
Arm64
- De VM-installatiekopieënarchitectuur van het plan is Arm64 -
X64Gen1
- De VM-installatiekopieënarchitectuur van het plan is X64 Generation1 -
X64Gen2
: de VM-installatiekopieënarchitectuur van het plan is X64 Generation2
Waarde | Description |
---|---|
Arm64 | |
X64Gen1 | |
X64Gen2 |
VmSecurityType
VM-beveiligingstype. Alleen van toepassing op producten van virtuele machines. Mogelijke waarden:
- Standard - Basisniveau van beveiliging voor de virtuele machine
- Vertrouwd: beschermt tegen permanente en geavanceerde aanvallen op virtuele Gen2-machines met configureerbare functies zoals opstarten van beveiliging en virtuele Trusted Platform Module (vTPM)
- Vertrouwelijk: boven op Vertrouwde lancering bieden vertrouwelijke virtuele machines een hogere vertrouwelijkheid en integriteit die gegarandeerd is met een vertrouwde uitvoeringsomgeving op basis van hardware
Waarde | Description |
---|---|
Confidential | |
None | |
Trusted |