Products - List
Pobierz listę komercyjnych produktów publicznych.
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 identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Wersja interfejsu API REST używana dla żądania. |
|
expand
|
query |
string[] |
Rozszerza powiązane jednostki wbudowane. Przykład: "expand=startingPrice" |
|
|
filter
|
query |
string |
Filtruje wyniki na podstawie warunku logicznego. Przykład: "filter=productType eq "VirtualMachine". Pola, które można filtrować według, to:
|
|
|
hide
|
query |
string[] |
Ten klucz jest używany do pobierania produktów w wersji zapoznawczej i jest generowany w Centrum partnerskim podczas procesu publikowania oferty. |
|
|
language
|
query |
string |
Język do wyszukiwania, ISO 639-1 dwuliterowy kod, możliwe wartości - "en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hul". Wartość domyślna to "en" |
|
|
locations
|
query |
string[] |
Zwracaj produkty dostępne w wybranej lokalizacji. Wyliczenie regionów centrum danych platformy Azure. Zobacz https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Wartość rynkowa produktu (odpowiedź będzie zawierać tylko produkty, które mogą być sprzedawane na określonym rynku) Możliwe wartości można znaleźć w https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Przykład: "USA" |
|
|
orderby
|
query |
string |
Wyrażenie porządkowania wyników przy użyciu notacji OData. Unikaj używania elementu orderby, chyba że ma to zasadnicze znaczenie, ponieważ może to mieć wpływ na opóźnienie żądania. Przykład: "orderby=displayName desc". Ten interfejs API obsługuje tylko kolejność według pojedynczego pola. Pola, które mogą być uporządkowane według, to:
|
|
|
select
|
query |
string[] |
Wybiera właściwości do uwzględnienia w wynikach. Przykład: "select=displayName" |
|
|
storefront
|
query |
string |
Zwracanie produktów dostępnych w witrynie Azure Portal Marketplace, witrynie AppSource lub w witrynie Azure Marketplace. Możliwe wartości to:
|
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| X-API-Key | True |
string |
Użyj klucza interfejsu API dostarczonego przez zespół wykazu witryny Marketplace jako parametru podanego w nagłówku |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Zwraca listę produktów publicznych lub w wersji zapoznawczej |
|
| Other Status Codes |
Odpowiedzi na błędy:
Nagłówki x-ms-error-code: string |
Przykłady
List_Products
Przykładowe żądanie
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Przykładowa odpowiedź
{
"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..."
}
Definicje
| Nazwa | Opis |
|---|---|
| Attribute |
Reprezentuje atrybut jednostki SKU, który składa się z klucza i wartości. Atrybuty mogą się różnić w różnych usługach. |
|
Azure |
Uprawnienia do korzyści ze zobowiązania do użycia platformy Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Możliwe wartości:
|
| Badge |
Typ wskaźnika |
|
Catalog |
Strona odpowiedzi składająca się z listy obiektów Produktu (zawierających podzbiór atrybutów produktu) wraz z linkiem następnej strony. Zazwyczaj atrybuty produktu zwracane na liście są używane do tworzenia kafelków produktów dla galerii witryny Marketplace. Uwaga: maksymalna liczba elementów zwróconych na stronę wynosi 100. W określonych przypadkach optymalizacji wydajności skontaktuj się z zespołem witryny Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Wartość pokazująca, czy plan jest dostępny do zakupu za pośrednictwem kanału CSP. Możliwe wartości:
|
|
Error |
Obiekt odpowiedzi na błąd interfejsu API |
|
Error |
Obiekt szczegółów odpowiedzi o błędzie interfejsu API |
| Metadata |
Rozszerzone metadane planu/jednostki SKU. |
|
Plan |
Wskazywanie powiązanego obiektu jednostki SKU |
|
Plan |
Zwraca podzbiór atrybutów planu |
|
Plan |
Typ planu szablonu aplikacji zarządzanej lub rozwiązania (dotyczy tylko produktu Azure Applications). Możliwe wartości:
|
|
Pricing |
Typ cennika |
|
Product |
Zwraca podzbiór atrybutów produktu |
|
Product |
Metoda dostarczania lub model wdrażania. Możliwe wartości:
|
|
Publisher |
Wartość wskazująca, czy jest to produkt firmy Microsoft, czy innej firmy. Możliwe wartości:
|
|
Publishing |
Etap publikowania produktu. Możliwe wartości:
|
|
Rating |
Zasobnik klasyfikacji |
| Sku |
Jednostka SKU |
|
Starting |
Cena detaliczna najtańszego planu produktu |
|
Vm |
Typ architektury maszyny wirtualnej. Dotyczy tylko produktów maszyn wirtualnych. Możliwe wartości:
|
|
Vm |
Typ zabezpieczeń maszyny wirtualnej. Dotyczy tylko produktów maszyn wirtualnych. Możliwe wartości:
|
Attribute
Reprezentuje atrybut jednostki SKU, który składa się z klucza i wartości. Atrybuty mogą się różnić w różnych usługach.
| Nazwa | Typ | Opis |
|---|---|---|
| key |
string |
Klucz atrybutu |
| value |
string |
Wartość atrybutu |
AzureBenefit
Uprawnienia do korzyści ze zobowiązania do użycia platformy Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Możliwe wartości:
-
Eligible— produkt kwalifikuje się do skorzystania ze zobowiązania dotyczącego użycia platformy Azure -
NotEligible— produkt nie kwalifikuje się do korzyści ze zobowiązania do użycia platformy Azure
| Wartość | Opis |
|---|---|
| Eligible | |
| NotEligible |
Badge
Typ wskaźnika
| Wartość | Opis |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Strona odpowiedzi składająca się z listy obiektów Produktu (zawierających podzbiór atrybutów produktu) wraz z linkiem następnej strony. Zazwyczaj atrybuty produktu zwracane na liście są używane do tworzenia kafelków produktów dla galerii witryny Marketplace. Uwaga: maksymalna liczba elementów zwróconych na stronę wynosi 100. W określonych przypadkach optymalizacji wydajności skontaktuj się z zespołem witryny Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Nazwa | Typ | Opis |
|---|---|---|
| items |
Lista zwracanych elementów |
|
| nextPageLink |
string (uri) |
Łącze do następnej strony, na której żądanie zwraca więcej niż jedną stronę wyników |
CspState
Wartość pokazująca, czy plan jest dostępny do zakupu za pośrednictwem kanału CSP. Możliwe wartości:
-
OptIn— planowanie skonfigurowanego programu CSP jest opt-in dla dowolnego partnera w programie CSP -
Optout— rezygnacja ze skonfigurowanych planów programu CSP -
SelectiveOptIn— wybierz opcję wyboru programu CSP skonfigurowanego w planie dla określonych partnerów w wybranym programie CSP isV. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Wartość | Opis |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Obiekt odpowiedzi na błąd interfejsu API
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Szczegóły odpowiedzi interfejsu API |
ErrorResponseDetails
Obiekt szczegółów odpowiedzi o błędzie interfejsu API
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Opis kodu błędu. Na przykład code=InternalError |
| message |
string |
Komunikat o błędzie. Na przykład message=Wewnętrzny błąd serwera |
Metadata
Rozszerzone metadane planu/jednostki SKU.
| Nazwa | Typ | Opis |
|---|---|---|
| altStackReference |
string |
Wskazywanie identyfikatora planu zawierającego odwołanie do alternatywnego stosu |
| generation |
string |
Generowanie obrazu maszyny wirtualnej (dotyczy tylko produktów maszyny wirtualnej).zobacz https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Wskazywanie identyfikatora planu planów powiązanych z tym planem |
PlanSkuRelation
Wskazywanie powiązanego obiektu jednostki SKU
| Nazwa | Typ | Opis |
|---|---|---|
| relationType |
string |
Typ relacji |
| sku |
Jednostka SKU |
PlanSummary
Zwraca podzbiór atrybutów planu
| Nazwa | Typ | Opis |
|---|---|---|
| altArchitectureReference |
string |
Dokumentacja architektury alternatywnej |
| altStackReference |
string |
Odwołanie do alternatywnego stosu |
| categoryIds |
string[] |
Identyfikatory kategorii planu |
| cspState |
Wartość pokazująca, czy plan jest dostępny do zakupu za pośrednictwem kanału CSP. Możliwe wartości:
|
|
| description |
string |
Opis planu/jednostki SKU |
| displayName |
string |
Nazwa wyświetlana planu/jednostki SKU |
| displayRank |
string |
Kolejność, w którą plan jest wyświetlany w tabeli "Plany" (zgodnie z konfiguracją wydawcy) |
| hasProtectedArtifacts |
boolean |
Ustaw wartość true, jeśli plan zawiera artefakty, które mają być ukryte dla nieuwierzytelnionego użytkownika |
| hasRI |
boolean |
Wskazanie, czy jednostka SKU obsługuje rezerwacje |
| isPrivate |
boolean |
Wskazanie, że plan jest dostępny tylko dla ograniczonej grupy odbiorców |
| metadata |
Rozszerzone metadane planu/jednostki SKU. |
|
| planId |
string |
Identyfikator planu |
| planType |
Typ planu szablonu aplikacji zarządzanej lub rozwiązania (dotyczy tylko produktu Azure Applications). Możliwe wartości:
|
|
| pricingTypes |
Lista typów cen, dla których wyznaczony jest ten plan (Możliwe wartości są takie same jak na poziomie produktu) |
|
| skuId |
string |
Identyfikator jednostki SKU |
| stackType |
string |
Typ stosu: Classic, Gen1, Gen2 |
| summary |
string |
Tekst podsumowania planu |
| uniquePlanId |
string |
Unikatowy identyfikator planu, który jest poprzedzony połączeniem uniqueProductId i PlanId bez separatora między |
| vmArchitectureType |
Typ architektury maszyny wirtualnej. Dotyczy tylko produktów maszyn wirtualnych. Możliwe wartości:
|
|
| vmSecuritytypes |
Typ zabezpieczeń maszyny wirtualnej. Dotyczy tylko produktów maszyn wirtualnych. Możliwe wartości:
|
PlanType
Typ planu szablonu aplikacji zarządzanej lub rozwiązania (dotyczy tylko produktu Azure Applications). Możliwe wartości:
-
SolutionTemplate— typ planu szablonu rozwiązania (dotyczy tylko aplikacji platformy Azure) -
ManagedApplication— typ planu aplikacji zarządzanej (dotyczy tylko aplikacji platformy Azure)
PricingType
Typ cennika
| Wartość | Opis |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Zwraca podzbiór atrybutów produktu
| Nazwa | Typ | Opis |
|---|---|---|
| applicableProducts |
string[] |
Kategorie produktów, do których należy oferta |
| attributes |
Zestaw atrybutów produktów (różni się w zależności od typu produktu), gdzie każdy atrybut jest reprezentowany przez parę kluczy (nazwa atrybutu) i wartość (wartość atrybutu) |
|
| azureBenefit |
Uprawnienia do korzyści ze zobowiązania do użycia platformy Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Możliwe wartości:
|
|
| badges |
Badge[] |
Dostępne są następujące znaczki produktów: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Tablica kategorii produktów, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Na przykład "Produktywność" |
| cspLegalTermsUri |
string |
Postanowienia prawne produktu dla dostawcy usług w chmurze |
| description |
string |
Tekst opisu produktu |
| displayName |
string |
Nazwa wyświetlana produktu |
| hasMarketplaceFootprint |
boolean |
Wskazanie, czy produkt ma reprezentację na platformie handlowej |
| hasRIPlans |
boolean |
Wskazanie, czy produkt ma plany z rezerwacjami |
| industryIds |
string[] |
Lista identyfikatorów branżowych, do których należy element |
| lastModifiedDateTime |
string (date-time) |
Najnowsza data aktualizacji produktu |
| linkedAddInsTypes |
object |
Połączone typy dodatków |
| locations |
string[] |
Lista lokalizacji, które są dostępne w jednostkach SKU |
| longSummary |
string |
Długie podsumowanie produktu |
| operatingSystems |
string[] |
Informacje o systemie operacyjnym dla tego produktu |
| plans |
Lista planów dostępnych dla tego produktu |
|
| popularity |
number (double) |
Popularność produktu |
| pricingTypes |
Lista typów cen, dla których wyznaczono tę ofertę. Możliwe wartości:
|
|
| privacyPolicyUri |
string |
Zasady ochrony prywatności produktu |
| productFamily |
string |
Rodzina produktów |
| productId |
string |
Unikatowy identyfikator produktu |
| productSubType |
string |
Typ podrzędny produktu |
| productType |
Metoda dostarczania lub model wdrażania. Możliwe wartości:
|
|
| publisherDisplayName |
string |
Nazwa wyświetlana wydawcy |
| publisherId |
string |
Identyfikator wydawcy |
| publisherType |
Wartość wskazująca, czy jest to produkt firmy Microsoft, czy innej firmy. Możliwe wartości:
|
|
| publishingStage |
Etap publikowania produktu. Możliwe wartości:
|
|
| ratingAverage |
number (double) |
Średnia ocena oferty |
| ratingBuckets |
Zasobniki klasyfikacji, Powyżej1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Łączna liczba ocen dla oferty |
| service |
string |
Nazwa usługi produktu, taka jak "Virtual Machines" |
| serviceFamily |
string |
Rodzina usług produktu, taka jak "Obliczenia" |
| smallIconUri |
string |
Identyfikator URI dla małej ikony produktu |
| startingPrice |
Cena detaliczna najtańszego planu produktu |
|
| summary |
string |
Podsumowanie produktu |
| supportedProducts |
string[] |
Mapuje na listę zgodnych produktów, które udostępnia wydawca |
| uniqueProductId |
string |
Unikatowy identyfikator produktu |
ProductType
Metoda dostarczania lub model wdrażania. Możliwe wartości:
-
SaaS— produkt to rozwiązanie oprogramowania zakupione na zasadzie płatności zgodnie z rzeczywistym użyciem od dostawcy usług w chmurze -
VirtualMachine— produkt to wystąpienia usługi obrazów z cenami opartymi na użyciu -
AzureApplication— produkty opublikowane jako szablony rozwiązań (ST) lub plany usługi Azure Managed Apps (AMA), które wdrażają zasoby platformy Azure w dzierżawie klienta -
DynamicsCE— wszystkie produkty Dynamics z wyjątkiem dynamicsBC i DynamicsOps -
DynamicsBC— Dynamics 365 Business Central -
Container— produkt jest dostarczany jako kontener -
DynamicsOps— Aplikacje operacyjne usługi Dynamics 365 -
None— typ produktu zwracany dla usług platformy Azure, rozszerzeń kontenerów i rozszerzeń maszyn wirtualnych -
IotEdgeModules— zasób jest dostarczany jako moduł usługi IoT Edge -
ContainerApps— zasób jest dostarczany jako aplikacja kontenera -
ConsultingServicesConsulting Services (dostępne tylko w witrynie Azure Marketplace jako oferty ofert) -
ManagedServices— produkt jest dostarczany jako usługa zarządzana -
PowerBI— produkty usługi Power BI -
CosellOnly— produkty dostępne tylko w zakresie programu Co-Sell -
PowerBIVisuals— produkty Power BI Visuals -
Office365— produkty usługi Office 365 -
DevService— usługa dev service -
AADApps— Aplikacje usługi Azure Active Directory -
VisualStudioExtension— rozszerzenia programu Visual Studio -
SolutionTemplate— typ planu szablonu rozwiązania (dotyczy tylko aplikacji platformy Azure) -
ManagedApplication— typ planu aplikacji zarządzanej (dotyczy tylko aplikacji platformy Azure) -
MicrosoftProduct— produkt platformy Azure innej firmy
| Wartość | Opis |
|---|---|
| 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
Wartość wskazująca, czy jest to produkt firmy Microsoft, czy innej firmy. Możliwe wartości:
-
Microsoft— produkt jest publikowany przez firmę Microsoft (produkt testowy) -
Third Party— produkt jest publikowany przez innego dostawcę
| Wartość | Opis |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Etap publikowania produktu. Możliwe wartości:
-
Preview— produkt jest dostępny dla ograniczonej grupy odbiorców -
Public— produkt jest publicznie dostępny w witrynie Marketplace
| Wartość | Opis |
|---|---|
| Preview | |
| Public |
RatingBucket
Zasobnik klasyfikacji
| Wartość | Opis |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Jednostka SKU
| Nazwa | Typ | Opis |
|---|---|---|
| generation |
string |
Generacja |
| identity |
string |
Tożsamość |
| name |
string |
Nazwa |
StartingPrice
Cena detaliczna najtańszego planu produktu
| Nazwa | Typ | Opis |
|---|---|---|
| currency |
string |
Waluta za cenę |
| market |
string |
Rynek, dla którego obliczana jest cena początkowa |
| meterUnits |
string |
Jednostki modelu cen mierników |
| minMeterPrice |
number |
Cena mierników początkowych (minimalna) |
| minTermPrice |
number |
Początkowa (minimalna) cena terminów |
| termUnits |
string |
Terminy — jednostki modelu cen |
VmArchitectureType
Typ architektury maszyny wirtualnej. Dotyczy tylko produktów maszyn wirtualnych. Możliwe wartości:
-
Arm64— architektura obrazu maszyny wirtualnej planu to Arm64 -
X64Gen1— architektura obrazu maszyny wirtualnej planu to X64 Generation1 -
X64Gen2— architektura obrazu maszyny wirtualnej planu to X64 Generation2
| Wartość | Opis |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Typ zabezpieczeń maszyny wirtualnej. Dotyczy tylko produktów maszyn wirtualnych. Możliwe wartości:
- Standardowa — podstawowy poziom zabezpieczeń maszyny wirtualnej
- Zaufane — chroni przed trwałymi i zaawansowanymi atakami na maszynach wirtualnych Gen2 z konfigurowalnymi funkcjami, takimi jak rozruch zabezpieczeń i wirtualny moduł Trusted Platform Module (vTPM)
- Poufne — na podstawie zaufanego uruchamiania poufne maszyny wirtualne oferują większą poufność i integralność gwarantowaną przy użyciu zaufanego środowiska wykonywania opartego na sprzęcie
| Wartość | Opis |
|---|---|
| None | |
| Trusted | |
| Confidential |