Products - List
Získejte seznam komerčních veřejných produktů.
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}
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Verze rozhraní REST API, která se používá pro požadavek |
|
expand
|
query |
string[] |
Rozbalí související entity vložené. Příklad: expand=startingPrice |
|
|
filter
|
query |
string |
Filtruje výsledky na základě logické podmínky. Příklad: filter=productType eq "VirtualMachine". Pole, podle které je možné filtrovat, jsou:
|
|
|
hide
|
query |
string[] |
Tento klíč se využívá k načtení produktů ve verzi Preview a generuje se v Partnerském centru během procesu publikování nabídky. |
|
|
language
|
query |
string |
Jazyk pro vyhledávání, ISO 639-1 dvoupísmenný kód, možné hodnoty - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Výchozí hodnota je "en" |
|
|
locations
|
query |
string[] |
Vrácení produktů dostupných ve vybraném umístění Výčet oblastí datacentra Azure Podívejte se na https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Hodnota trhu výrobku (odpověď bude obsahovat pouze produkty, které lze prodat na zadaném trhu) Možné hodnoty lze nalézt v https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Příklad: USA |
|
|
orderby
|
query |
string |
Výraz řazení pro výsledky pomocí zápisu OData. Nepoužívejte orderby, pokud to není nezbytné, protože to může mít vliv na latenci vaší žádosti. Příklad: orderby=displayName desc. Toto rozhraní API podporuje pouze řazení podle jednoho pole. Pole, podle které lze řadit, jsou:
|
|
|
select
|
query |
string[] |
Vybere vlastnosti, které se mají zahrnout do výsledků. Příklad: select=displayName |
|
|
storefront
|
query |
string |
Vrácení produktů dostupných na webu Azure Portal Marketplace, AppSource nebo portálu Azure Marketplace Možné hodnoty:
|
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| X-API-Key | True |
string |
Použití klíče rozhraní API poskytovaného týmem katalogu Marketplace jako parametrem zadaným v hlavičce |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Vrátí seznam veřejných produktů nebo produktů ve verzi Preview. |
|
| Other Status Codes |
Chybové odpovědi:
Hlavičky x-ms-error-code: string |
Příklady
List_Products
Ukázkový požadavek
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Ukázková odpověď
{
"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..."
}
Definice
| Name | Description |
|---|---|
| Attribute |
Představuje atribut skladové položky, který se skládá z klíče a hodnoty. Atributy se můžou lišit v různých službách. |
|
Azure |
Nárok na výhodu závazku využití Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Možné hodnoty:
|
| Badge |
Typ odznáčku |
|
Catalog |
Stránka odpovědi složená ze seznamu objektů Product (obsahujících podmnožinu atributů produktu) společně s odkazem na další stránku. Atributy produktů vrácené v seznamu se obvykle používají k vytváření dlaždic produktů pro galerii Marketplace. Poznámka:Poznámka: Maximální počet vrácených položek na stránku je 100. V konkrétních případech optimalizace výkonu se obraťte na tým Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Hodnota znázorňující, jestli je plán k dispozici pro nákup prostřednictvím kanálu CSP Možné hodnoty:
|
|
Error |
Objekt odpovědi na chybu rozhraní API |
|
Error |
Objekt podrobnosti odpovědi na chybu rozhraní API |
| Metadata |
Rozšířená metadata plánu nebo skladové položky |
|
Plan |
Odkazování na související objekt skladové položky |
|
Plan |
Vrátí podmnožinu atributů plánu. |
|
Plan |
Typ plánu šablony spravované aplikace nebo řešení (platí jenom pro produkt Azure Applications). Možné hodnoty:
|
|
Pricing |
Cenový typ |
|
Product |
Vrátí podmnožinu atributů Product. |
|
Product |
Metoda doručení nebo model nasazení. Možné hodnoty:
|
|
Publisher |
Hodnota označující, jestli se jedná o produkt společnosti Microsoft nebo třetí strany. Možné hodnoty:
|
|
Publishing |
Fáze publikování produktů Možné hodnoty:
|
|
Rating |
Kontejner hodnocení |
| Sku |
Skladová položka |
|
Starting |
Maloobchodní cena nejlevnějšího plánu produktu |
|
Vm |
Typ architektury virtuálního počítače Platí pouze pro produkty virtuálních počítačů. Možné hodnoty:
|
|
Vm |
Typ zabezpečení virtuálního počítače Platí pouze pro produkty virtuálních počítačů. Možné hodnoty:
|
Attribute
Představuje atribut skladové položky, který se skládá z klíče a hodnoty. Atributy se můžou lišit v různých službách.
| Name | Typ | Description |
|---|---|---|
| key |
string |
Klíč atributu |
| value |
string |
Hodnota atributu |
AzureBenefit
Nárok na výhodu závazku využití Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Možné hodnoty:
-
Eligible– Produkt má nárok na výhodu závazku využití Azure. -
NotEligible– Produkt nemá nárok na výhodu závazku využití Azure
| Hodnota | Description |
|---|---|
| Eligible | |
| NotEligible |
Badge
Typ odznáčku
| Hodnota | Description |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Stránka odpovědi složená ze seznamu objektů Product (obsahujících podmnožinu atributů produktu) společně s odkazem na další stránku. Atributy produktů vrácené v seznamu se obvykle používají k vytváření dlaždic produktů pro galerii Marketplace. Poznámka:Poznámka: Maximální počet vrácených položek na stránku je 100. V konkrétních případech optimalizace výkonu se obraťte na tým Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Name | Typ | Description |
|---|---|---|
| items |
Seznam vrácených položek |
|
| nextPageLink |
string (uri) |
Odkaz na další stránku, kde požadavek vrací více než jednu stránku výsledků |
CspState
Hodnota znázorňující, jestli je plán k dispozici pro nákup prostřednictvím kanálu CSP Možné hodnoty:
-
OptIn– Plánování výslovného souhlasu s programem CSP pro libovolného partnera v programu CSP -
Optout– Naplánování odhlášení z programu CSP -
SelectiveOptIn– Naplánování výslovného souhlasu s programem CSP pro konkrétní partnery v programu ISV programu CSP vybere. Další informace najdete v tématu https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Hodnota | Description |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Objekt odpovědi na chybu rozhraní API
| Name | Typ | Description |
|---|---|---|
| error |
Podrobnosti odpovědi rozhraní API |
ErrorResponseDetails
Objekt podrobnosti odpovědi na chybu rozhraní API
| Name | Typ | Description |
|---|---|---|
| code |
string |
Popis kódu chyby. Například code=InternalError |
| message |
string |
Chybová zpráva. Například message=Vnitřní chyba serveru |
Metadata
Rozšířená metadata plánu nebo skladové položky
| Name | Typ | Description |
|---|---|---|
| altStackReference |
string |
Odkazování na planId, který obsahuje odkaz na alternativní zásobník |
| generation |
string |
Generování imagí virtuálního počítače (použitelné jenom pro produkty virtuálních počítačů).viz https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Odkazování na planId plánů, které souvisejí s tímto plánem |
PlanSkuRelation
Odkazování na související objekt skladové položky
| Name | Typ | Description |
|---|---|---|
| relationType |
string |
Typ relace |
| sku |
Skladová položka |
PlanSummary
Vrátí podmnožinu atributů plánu.
| Name | Typ | Description |
|---|---|---|
| altArchitectureReference |
string |
Referenční informace k alternativní architektuře |
| altStackReference |
string |
Referenční informace k alternativnímu zásobníku |
| categoryIds |
string[] |
Id kategorií plánu |
| cspState |
Hodnota znázorňující, jestli je plán k dispozici pro nákup prostřednictvím kanálu CSP Možné hodnoty:
|
|
| description |
string |
Popis plánu nebo skladové položky |
| displayName |
string |
Zobrazovaný název plánu / skladové položky |
| displayRank |
string |
Pořadí, ve kterém se plán zobrazuje v tabulce Plány (nakonfigurované vydavatelem) |
| hasProtectedArtifacts |
boolean |
Pokud má plán artefakty, které mají být skryté pro neověřené uživatele, nastavte na hodnotu true. |
| hasRI |
boolean |
Určení, jestli skladová položka podporuje rezervace |
| isPrivate |
boolean |
Označení, že plán je přístupný pouze omezené cílové skupině |
| metadata |
Rozšířená metadata plánu nebo skladové položky |
|
| planId |
string |
ID plánu |
| planType |
Typ plánu šablony spravované aplikace nebo řešení (platí jenom pro produkt Azure Applications). Možné hodnoty:
|
|
| pricingTypes |
Seznam cenových typů, pro které je tento plán určen (možné hodnoty jsou stejné jako na úrovni produktu) |
|
| skuId |
string |
ID skladové položky |
| stackType |
string |
Typ zásobníku: Classic, Gen1, Gen2 |
| summary |
string |
Text souhrnu plánu |
| uniquePlanId |
string |
Jedinečné ID plánu, které je předponou kombinování uniqueProductId a PlanId bez oddělovače mezi |
| vmArchitectureType |
Typ architektury virtuálního počítače Platí pouze pro produkty virtuálních počítačů. Možné hodnoty:
|
|
| vmSecuritytypes |
Typ zabezpečení virtuálního počítače Platí pouze pro produkty virtuálních počítačů. Možné hodnoty:
|
PlanType
Typ plánu šablony spravované aplikace nebo řešení (platí jenom pro produkt Azure Applications). Možné hodnoty:
-
SolutionTemplate– Typ plánu šablony řešení (platí jenom pro aplikace Azure) -
ManagedApplication– typ plánu spravované aplikace (platí jenom pro aplikace Azure)
PricingType
Cenový typ
| Hodnota | Description |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Vrátí podmnožinu atributů Product.
| Name | Typ | Description |
|---|---|---|
| applicableProducts |
string[] |
Kategorie produktů, do kterých nabídka patří |
| attributes |
Sada atributů produktů (liší se podle typu produktu), kde každý atribut představuje dvojici klíče (název atributu) a value(hodnota atributu) |
|
| azureBenefit |
Nárok na výhodu závazku využití Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Možné hodnoty:
|
|
| badges |
Badge[] |
K dispozici jsou následující odznáčky produktů: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Pole kategorií výrobků, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Například "Produktivita" |
| cspLegalTermsUri |
string |
Právní podmínky produktu pro CSP |
| description |
string |
Text popisu produktu |
| displayName |
string |
Zobrazovaný název produktu |
| hasMarketplaceFootprint |
boolean |
Označení, jestli má produkt reprezentaci na marketplace |
| hasRIPlans |
boolean |
Označení, jestli má produkt plány s rezervacemi |
| industryIds |
string[] |
Seznam ID odvětví, do nichž položka patří |
| lastModifiedDateTime |
string (date-time) |
Datum poslední aktualizace produktu |
| linkedAddInsTypes |
object |
Propojené typy doplňků |
| locations |
string[] |
Seznam umístění, která jsou k dispozici v skladových posku |
| longSummary |
string |
Dlouhý souhrn produktu |
| operatingSystems |
string[] |
Informace o operačním systému pro tento produkt |
| plans |
Seznam plánů, které jsou pro tento produkt k dispozici |
|
| popularity |
number (double) |
Popularita produktu |
| pricingTypes |
Seznam cenovýchtypůch Možné hodnoty:
|
|
| privacyPolicyUri |
string |
Zásady ochrany osobních údajů produktu |
| productFamily |
string |
Produktová řada |
| productId |
string |
Jedinečné ID produktu |
| productSubType |
string |
Podtyp produktu |
| productType |
Metoda doručení nebo model nasazení. Možné hodnoty:
|
|
| publisherDisplayName |
string |
Zobrazovaný název vydavatele |
| publisherId |
string |
ID vydavatele |
| publisherType |
Hodnota označující, jestli se jedná o produkt společnosti Microsoft nebo třetí strany. Možné hodnoty:
|
|
| publishingStage |
Fáze publikování produktů Možné hodnoty:
|
|
| ratingAverage |
number (double) |
Průměrné hodnocení nabídky |
| ratingBuckets |
Kontejnery hodnocení, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Celkový počet hodnocení nabídky |
| service |
string |
Název služby produktu, například "Virtuální počítače". |
| serviceFamily |
string |
Řada služeb produktu, například Compute |
| smallIconUri |
string |
Identifikátor URI na malou ikonu produktu |
| startingPrice |
Maloobchodní cena nejlevnějšího plánu produktu |
|
| summary |
string |
Souhrn produktů |
| supportedProducts |
string[] |
Mapuje se na seznam kompatibilních produktů, které vydavatel poskytuje. |
| uniqueProductId |
string |
Jedinečný identifikátor produktu |
ProductType
Metoda doručení nebo model nasazení. Možné hodnoty:
-
SaaS– Produkt je softwarové řešení zakoupené na základě průběžných plateb od poskytovatele cloudových služeb. -
VirtualMachine– Produkt je instance služby Image s cenami na základě využití -
AzureApplication– Produkty publikované jako šablony řešení (ST) nebo plány AMA (Azure Managed Apps), které nasazují prostředky Azure do tenanta zákazníka -
DynamicsCE– všechny produkty Dynamics s výjimkou DynamicsBC a DynamicsOps -
DynamicsBC– Dynamics 365 Business Central -
Container– produkt se dodává jako kontejner. -
DynamicsOps– Dynamics 365 Operations Apps -
None– Vrácený typ produktu pro služby Azure, rozšíření kontejnerů a rozšíření virtuálních počítačů -
IotEdgeModules– Prostředek se dodává jako modul IoT Edge -
ContainerApps– Prostředek se doručí jako kontejnerová aplikace - konzultační služby
ConsultingServices(dostupné pouze v Azure Marketplace jako nabídky pro výpis) -
ManagedServices– produkt se dodává jako spravovaná služba. -
PowerBI– produkty Power BI -
CosellOnly– produkty dostupné pouze v rámci programu Co-Sell -
PowerBIVisuals– produkty vizuálů Power BI -
Office365– produkty Office 365 -
DevService– Dev Service -
AADApps– Aplikace Azure Active Directory -
VisualStudioExtension– rozšíření sady Visual Studio -
SolutionTemplate– Typ plánu šablony řešení (platí jenom pro aplikace Azure) -
ManagedApplication– typ plánu spravované aplikace (platí jenom pro aplikace Azure) -
MicrosoftProduct– produkt Azure třetí strany
| Hodnota | 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
Hodnota označující, jestli se jedná o produkt společnosti Microsoft nebo třetí strany. Možné hodnoty:
-
Microsoft– Produkt publikuje Microsoft (produkt třetí strany) -
Third Party– Produkt je publikovaný dodavatelem třetí strany.
| Hodnota | Description |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Fáze publikování produktů Možné hodnoty:
-
Preview– Produkt je k dispozici omezené cílové skupině -
Public– Produkt je veřejně dostupný na Marketplace
| Hodnota | Description |
|---|---|
| Preview | |
| Public |
RatingBucket
Kontejner hodnocení
| Hodnota | Description |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Skladová položka
| Name | Typ | Description |
|---|---|---|
| generation |
string |
Generace |
| identity |
string |
Identita |
| name |
string |
Název |
StartingPrice
Maloobchodní cena nejlevnějšího plánu produktu
| Name | Typ | Description |
|---|---|---|
| currency |
string |
Měna za cenu |
| market |
string |
Trh, pro který se počítá počáteční cena |
| meterUnits |
string |
Jednotky cenového modelu měřičů |
| minMeterPrice |
number |
Počáteční (minimální) cena měřiče |
| minTermPrice |
number |
Počáteční (minimální) cena za podmínky |
| termUnits |
string |
Ceny jednotek cenového modelu |
VmArchitectureType
Typ architektury virtuálního počítače Platí pouze pro produkty virtuálních počítačů. Možné hodnoty:
-
Arm64– Architektura imagí virtuálních počítačů v plánu je Arm64 -
X64Gen1– architektura image virtuálního počítače v plánu je X64 Generation1. -
X64Gen2– architektura image virtuálního počítače v plánu je X64 Generation2.
| Hodnota | Description |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Typ zabezpečení virtuálního počítače Platí pouze pro produkty virtuálních počítačů. Možné hodnoty:
- Standard – Základní úroveň zabezpečení pro virtuální počítač
- Důvěryhodné – chrání před trvalými a pokročilými útoky na virtuální počítače Gen2 s konfigurovatelnými funkcemi, jako je spouštění zabezpečení a virtuální trusted Platform Module (vTPM)
- Důvěrné – kromě důvěryhodného spouštěcího prostředí založeného na hardwaru nabízejí důvěrné virtuální počítače vyšší důvěrnost a integritu.
| Hodnota | Description |
|---|---|
| None | |
| Trusted | |
| Confidential |