Products - List
Hämta en lista över kommersiella offentliga produkter.
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-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version av REST-API:et som används för begäran. |
|
expand
|
query |
string[] |
Expanderar relaterade entiteter infogade. Exempel: "expand=startingPrice" |
|
|
filter
|
query |
string |
Filtrerar resultatet baserat på ett booleskt villkor. Exempel: "filter=productType eq "VirtualMachine". Fält som kan filtreras efter är:
|
|
|
hide
|
query |
string[] |
Den här nyckeln används för att hämta förhandsgranskningsprodukter och genereras i Partnercenter under publiceringsprocessen för erbjudandet. |
|
|
language
|
query |
string |
Språk för sökning, 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,zh-hans,zh-hant". Standardvärdet är "en" |
|
|
locations
|
query |
string[] |
Returnera produkter som är tillgängliga på den valda platsen. Uppräkning av Azure-datacenterregionerna. Se https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Produktmarknadsvärde (svaret innehåller endast produkter som kan säljas på den angivna marknaden) Möjliga värden finns på https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Exempel: "US" |
|
|
orderby
|
query |
string |
Orderuttryck för resultaten med 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 beställning av ett enda fält. Fält som kan sorteras efter är:
|
|
|
select
|
query |
string[] |
Väljer vilka egenskaper som ska inkluderas i resultatet. Exempel: "select=displayName" |
|
|
storefront
|
query |
string |
Returnera produkter som är tillgängliga på Azure Portal Marketplace, AppSource eller Azure Marketplace-portalen. Möjliga värden är:
|
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| X-API-Key | True |
string |
Använd API-nyckeln som tillhandahålls av Marketplace Catalog Team som en parameter som anges i rubriken |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Returnerar en lista över offentliga produkter eller förhandsgranskningsprodukter |
|
| Other Status Codes |
Felsvar:
Sidhuvuden x-ms-error-code: string |
Exempel
List_Products
Exempelbegäran
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Exempelsvar
{
"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..."
}
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. |
|
Azure |
Berättigande till azure-förbrukningsåtagandeförmån (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Möjliga värden:
|
| Badge |
Märkestyp |
|
Catalog |
Svarssidan består av en lista över produktobjekt (som innehåller delmängd av produktattribut) tillsammans med en länk till nästa sida. Vanligtvis används produktattribut som returneras i listan för att skapa produktpaneler för Marketplace-galleriet. Obs! Det maximala antalet objekt som returneras per sida är 100. I specifika fall för prestandaoptimering kontaktar du Microsoft Marketplace-teamet MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Värde som visar om planen är tillgänglig för köp via CSP-kanalen. Möjliga värden:
|
|
Error |
API-felsvarsobjektet |
|
Error |
API-felsvarsinformationsobjektet |
| Metadata |
Utökade plan-/SKU-metadata. |
|
Plan |
Pekar på ett relaterat SKU-objekt |
|
Plan |
Returnerar en delmängd av planattribut |
|
Plan |
Plantyp för hanterat program eller lösningsmall (gäller endast för azure-programprodukt). Möjliga värden:
|
|
Pricing |
Pristyp |
|
Product |
Returnerar en delmängd av Produktattribut |
|
Product |
Leveransmetoden eller distributionsmodellen. Möjliga värden:
|
|
Publisher |
Ett värde som anger om det här är en Microsoft- eller tredjepartsprodukt. Möjliga värden:
|
|
Publishing |
Produktpubliceringssteg. Möjliga värden:
|
|
Rating |
Klassificerings bucket |
| Sku |
Sku:n |
|
Starting |
Detaljhandelspris för produktens billigaste plan |
|
Vm |
Arkitekturtyp för virtuell dator. Gäller endast för virtual machine-produkter. Möjliga värden:
|
|
Vm |
Säkerhetstyp för virtuella datorer. Gäller endast för virtual machine-produkter. Möjliga värden:
|
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 |
Attributnyckeln |
| value |
string |
Attributvärdet |
AzureBenefit
Berättigande till azure-förbrukningsåtagandeförmån (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Möjliga värden:
-
Eligible– Produkten är berättigad till azure-förbrukningsåtagandeförmån -
NotEligible– Produkten är inte berättigad till azure-förbrukningsåtagandeförmån
| Värde | Description |
|---|---|
| Eligible | |
| NotEligible |
Badge
Märkestyp
| Värde | Description |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Svarssidan består av en lista över produktobjekt (som innehåller delmängd av produktattribut) tillsammans med en länk till nästa sida. Vanligtvis används produktattribut som returneras i listan för att skapa produktpaneler för Marketplace-galleriet. Obs! Det maximala antalet objekt som returneras per sida är 100. I specifika fall för prestandaoptimering kontaktar du Microsoft Marketplace-teamet MKPL_Platform_API_DL@microsoft.com
| Name | Typ | Description |
|---|---|---|
| items |
Listan över returnerade objekt |
|
| nextPageLink |
string (uri) |
Länka till nästa sida där begäran returnerar mer än en enda resultatsida |
CspState
Värde som visar om planen är tillgänglig för köp via CSP-kanalen. Möjliga värden:
-
OptIn– Planera konfigurerad CSP-programregistrering för alla partner i CSP-programmet -
Optout– Planera avregistrering av konfigurerat CSP-program -
SelectiveOptIn– Planera konfigurerad CSP-programregistrering för specifika partner i DET CSP-program som ISV väljer. Mer information finns i https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Värde | Description |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
API-felsvarsobjektet
| Name | Typ | Description |
|---|---|---|
| error |
API-svarsinformationen |
ErrorResponseDetails
API-felsvarsinformationsobjektet
| Name | Typ | Description |
|---|---|---|
| code |
string |
Felkodsbeskrivningen. Till exempel code=InternalError |
| message |
string |
Felmeddelandet. Till exempel meddelande=Internt serverfel |
Metadata
Utökade plan-/SKU-metadata.
| Name | Typ | Description |
|---|---|---|
| altStackReference |
string |
Pekar på ett planId som innehåller den alternativa stackreferensen |
| generation |
string |
Vm-avbildningsgenereringen (gäller endast för virtual machine-produkter).se https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Pekar på ett planId med planer som är relaterade till den här planen |
PlanSkuRelation
Pekar på ett relaterat SKU-objekt
| Name | Typ | Description |
|---|---|---|
| relationType |
string |
Relationstyp |
| sku |
Sku:n |
PlanSummary
Returnerar en delmängd av planattribut
| Name | Typ | Description |
|---|---|---|
| altArchitectureReference |
string |
Referens för alternativ arkitektur |
| altStackReference |
string |
Referens för alternativ stack |
| categoryIds |
string[] |
Planera CategoryIds |
| cspState |
Värde som visar om planen är tillgänglig för köp via CSP-kanalen. Möjliga värden:
|
|
| description |
string |
Plan-/sku-beskrivning |
| displayName |
string |
Visningsnamn för planen/sku:n |
| displayRank |
string |
Ordningen som planen visas i tabellen Planer (enligt utgivarens konfiguration) |
| hasProtectedArtifacts |
boolean |
Ställ in på sant om planen har artefakter som ska döljas för icke-autentiserade användare |
| hasRI |
boolean |
Ange om SKU:n stöder reservationer |
| isPrivate |
boolean |
Indikation på att planen endast är tillgänglig för begränsad målgrupp |
| metadata |
Utökade plan-/SKU-metadata. |
|
| planId |
string |
Planera ID |
| planType |
Plantyp för hanterat program eller lösningsmall (gäller endast för azure-programprodukt). Möjliga värden:
|
|
| pricingTypes |
Listan över de pristyper som planen är avsedd för (Möjliga värden är desamma som på produktnivå) |
|
| skuId |
string |
SKU-ID:t |
| stackType |
string |
Stacktyp: Klassisk, Gen1, Gen2 |
| summary |
string |
Sammanfattningstext för planen |
| uniquePlanId |
string |
Unikt plan-ID som är prefix genom att kombinera uniqueProductId och PlanId utan avgränsare mellan |
| vmArchitectureType |
Arkitekturtyp för virtuell dator. Gäller endast för virtual machine-produkter. Möjliga värden:
|
|
| vmSecuritytypes |
Säkerhetstyp för virtuella datorer. Gäller endast för virtual machine-produkter. Möjliga värden:
|
PlanType
Plantyp för hanterat program eller lösningsmall (gäller endast för azure-programprodukt). Möjliga värden:
-
SolutionTemplate– Plantyp för lösningsmall (gäller endast för Azure-program) -
ManagedApplication– Plantyp för hanterat program (gäller endast för Azure-program)
PricingType
Pristyp
| Värde | Description |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Returnerar en delmängd av Produktattribut
| Name | Typ | Description |
|---|---|---|
| applicableProducts |
string[] |
Produktkategorier som erbjudandet tillhör |
| attributes |
Uppsättning produktattribut (varierar per produkttyp), där varje attribut representeras av ett nyckelpar (attributnamn) och värde(attributvärde) |
|
| azureBenefit |
Berättigande till azure-förbrukningsåtagandeförmån (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Möjliga värden:
|
|
| badges |
Badge[] |
Följande produktmärken är tillgängliga: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Matris med produktkategorier, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Till exempel "Produktivitet" |
| cspLegalTermsUri |
string |
De juridiska villkoren för produkten för CSP |
| description |
string |
Produktbeskrivningstexten |
| displayName |
string |
Produktvisningsnamn |
| hasMarketplaceFootprint |
boolean |
Ange om produkten har en representation på marknadsplatsen |
| hasRIPlans |
boolean |
Ange om produkten har planer med reservationer |
| industryIds |
string[] |
Lista över bransch-ID:t som objektet tillhör |
| lastModifiedDateTime |
string (date-time) |
Senaste uppdateringsdatum för produkten |
| linkedAddInsTypes |
object |
Länkade tilläggstyper |
| locations |
string[] |
Lista över platser som är tillgängliga på SKU:erna |
| longSummary |
string |
Lång sammanfattning av produkten |
| operatingSystems |
string[] |
Information om operativsystem för den här produkten |
| plans |
Lista över planer som är tillgängliga för den här produkten |
|
| popularity |
number (double) |
Produktens popularitet |
| pricingTypes |
Listan över de pristyper som det här erbjudandet är avsett för. Möjliga värden:
|
|
| privacyPolicyUri |
string |
Produktens sekretesspolicy |
| productFamily |
string |
Produktfamilj |
| productId |
string |
Produktens unika ID |
| productSubType |
string |
Produktundertyp |
| productType |
Leveransmetoden eller distributionsmodellen. Möjliga värden:
|
|
| publisherDisplayName |
string |
Visningsnamn för utgivare |
| publisherId |
string |
Utgivar-ID |
| publisherType |
Ett värde som anger om det här är en Microsoft- eller tredjepartsprodukt. Möjliga värden:
|
|
| publishingStage |
Produktpubliceringssteg. Möjliga värden:
|
|
| ratingAverage |
number (double) |
Genomsnittligt omdöme för erbjudandet |
| ratingBuckets |
Klassificerings buckets, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Totalt antal betyg för erbjudandet |
| service |
string |
Tjänstens namn på produkten, till exempel "Virtuella datorer" |
| serviceFamily |
string |
Tjänstfamiljen för produkten, till exempel "Compute" |
| smallIconUri |
string |
URI till den lilla produktikonen |
| startingPrice |
Detaljhandelspris för produktens billigaste plan |
|
| summary |
string |
Produktsammanfattning |
| supportedProducts |
string[] |
Mappar till listan över kompatibla produkter som utgivaren tillhandahåller |
| uniqueProductId |
string |
Unik produktidentifierare |
ProductType
Leveransmetoden eller distributionsmodellen. Möjliga värden:
-
SaaS– Produkten är en programvarulösning som köpts enligt principen betala per användning från en molntjänstleverantör -
VirtualMachine– Produkten är Image Service-instanser med användningsbaserad prissättning -
AzureApplication– Produkter som publicerats som lösningsmallar (ST) eller AMA-planer (Azure Managed Apps) som distribuerar Azure-resurser till kundklientorganisationen -
DynamicsCE– Alla Dynamics-produkter förutom DynamicsBC och DynamicsOps -
DynamicsBC– Dynamics 365 Business Central -
Container– Produkten levereras som container -
DynamicsOps– Dynamics 365 Operations Apps -
None– Produkttyp som returneras för Azure Services, containertillägg och VM-tillägg -
IotEdgeModules– Resursen levereras som IoT Edge-modul -
ContainerApps– Resursen levereras som containerapp -
ConsultingServicesConsulting Services (endast tillgängligt på Azure Marketplace som listerbjudanden) -
ManagedServices– Produkten levereras som hanterad tjänst -
PowerBI– Power BI-produkter -
CosellOnly– Endast produkter som är tillgängliga i Co-Sell program -
PowerBIVisuals– Produkter för visuella Power BI-objekt -
Office365– Office 365-produkter -
DevService– Dev Service -
AADApps– Azure Active Directory-program -
VisualStudioExtension– Visual Studio-tillägg -
SolutionTemplate– Plantyp för lösningsmall (gäller endast för Azure-program) -
ManagedApplication– Plantyp för hanterat program (gäller endast för Azure-program) -
MicrosoftProduct– Azure-produkt från första part
| Värde | Description |
|---|---|
| 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
Ett värde som anger om det här är en Microsoft- eller tredjepartsprodukt. Möjliga värden:
-
Microsoft– Produkten publiceras av Microsoft (produkt från första part) -
Third Party– Produkten publiceras av tredjepartsleverantör
| Värde | Description |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Produktpubliceringssteg. Möjliga värden:
-
Preview– Produkten är tillgänglig för begränsad målgrupp -
Public– Produkten är offentligt tillgänglig på Marketplace
| Värde | Description |
|---|---|
| Preview | |
| Public |
RatingBucket
Klassificerings bucket
| Värde | Description |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Sku:n
| Name | Typ | Description |
|---|---|---|
| generation |
string |
Genereringen |
| identity |
string |
Identiteten |
| name |
string |
Namnet |
StartingPrice
Detaljhandelspris för produktens billigaste plan
| Name | Typ | Description |
|---|---|---|
| currency |
string |
Valuta för pris |
| market |
string |
Den marknad för vilken startpriset beräknas |
| meterUnits |
string |
Prismodellenheterna för mätare |
| minMeterPrice |
number |
Startpris för (minimala) mätare |
| minTermPrice |
number |
Startpris för (minimala) villkor |
| termUnits |
string |
Termernas prismodellenheter |
VmArchitectureType
Arkitekturtyp för virtuell dator. Gäller endast för virtual machine-produkter. Möjliga värden:
-
Arm64– Vm-avbildningsarkitekturen för planen är Arm64 -
X64Gen1– Planens vm-avbildningsarkitektur är X64 Generation1 -
X64Gen2– Vm-avbildningsarkitekturen för planen är X64 Generation2
| Värde | Description |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Säkerhetstyp för virtuella datorer. Gäller endast för virtual machine-produkter. Möjliga värden:
- Standard – Grundläggande säkerhetsnivå för den virtuella datorn
- Betrodd – skyddar mot beständiga och avancerade attacker på virtuella Gen2-datorer med konfigurerbara funktioner som säkerhetsstart och virtuell betrodd plattformsmodul (vTPM)
- Konfidentiellt – utöver betrodd start erbjuder konfidentiella virtuella datorer högre konfidentialitet och integritet som garanteras med maskinvarubaserad betrodd körningsmiljö
| Värde | Description |
|---|---|
| None | |
| Trusted | |
| Confidential |