Products - List
Dapatkan daftar produk publik komersial.
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}
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versi REST API yang digunakan untuk permintaan. |
|
expand
|
query |
string[] |
Memperluas entitas terkait sebaris. Contoh: 'expand=startingPrice' |
|
|
filter
|
query |
string |
Memfilter hasil, berdasarkan kondisi Boolean. Contoh: 'filter=productType eq "VirtualMachine"'. Bidang yang dapat difilter menurut adalah:
|
|
|
hide
|
query |
string[] |
Kunci ini digunakan untuk mengambil produk pratinjau dan dihasilkan dalam Pusat Mitra selama proses penerbitan penawaran. |
|
|
language
|
query |
string |
Bahasa untuk dicari, kode dua huruf ISO 639-1, nilai yang mungkin - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Defaultnya adalah "en" |
|
|
locations
|
query |
string[] |
Mengembalikan produk yang tersedia di lokasi yang dipilih. Enumerasi wilayah pusat data Azure. Lihat https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Nilai pasar produk (respons hanya akan mencakup produk yang dapat dijual di pasar yang ditentukan) Nilai yang mungkin dapat ditemukan di https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Contoh: 'US' |
|
|
orderby
|
query |
string |
Ekspresi pengurutan untuk hasil menggunakan notasi OData. Hindari menggunakan orderby kecuali penting karena ini dapat memengaruhi latensi permintaan Anda. Contoh: 'orderby=displayName desc'. API ini hanya mendukung pemesanan berdasarkan satu bidang. Bidang yang dapat diurutkan berdasarkan adalah:
|
|
|
select
|
query |
string[] |
Memilih properti mana yang akan disertakan dalam hasil. Contoh: 'select=displayName' |
|
|
storefront
|
query |
string |
Mengembalikan produk yang tersedia di portal Azure Portal Marketplace, AppSource, atau Marketplace Azure. Nilai yang mungkin adalah:
|
Header Permintaan
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| X-API-Key | True |
string |
Gunakan kunci Api yang disediakan oleh Tim Katalog Marketplace sebagai parameter yang disediakan di header |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 OK |
Mengembalikan daftar produk publik atau pratinjau |
|
| Other Status Codes |
Respons Kesalahan:
Header x-ms-error-code: string |
Contoh
List_Products
Permintaan sampel
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Respon sampel
{
"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..."
}
Definisi
| Nama | Deskripsi |
|---|---|
| Attribute |
Mewakili atribut SKU, yang terdiri dari kunci dan nilai. Atribut mungkin berbeda di berbagai layanan. |
|
Azure |
Kelayakan untuk manfaat komitmen konsumsi Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Nilai yang mungkin:
|
| Badge |
Jenis lencana |
|
Catalog |
Halaman respons terdiri dari daftar objek Produk (yang menyertakan subset atribut produk) bersama dengan tautan halaman berikutnya. Biasanya atribut produk yang dikembalikan dalam daftar digunakan untuk membangun petak peta produk untuk Galeri Marketplace. Catatan:catatan Jumlah maksimum item yang dikembalikan per halaman adalah 100. Dalam kasus tertentu untuk pengoptimalan performa, silakan hubungi tim Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Nilai yang menunjukkan apakah paket tersedia untuk dibeli melalui saluran CSP. Nilai yang mungkin:
|
|
Error |
Objek respons kesalahan API |
|
Error |
Objek detail respons kesalahan API |
| Metadata |
Metadata paket/SKU yang diperluas. |
|
Plan |
Menunjuk ke objek SKU terkait |
|
Plan |
Mengembalikan subset atribut Paket |
|
Plan |
Jenis paket templat Aplikasi atau Solusi Terkelola (hanya berlaku untuk produk Aplikasi Azure). Nilai yang mungkin:
|
|
Pricing |
Jenis harga |
|
Product |
Mengembalikan subset atribut Produk |
|
Product |
Metode pengiriman atau model penyebaran. Nilai yang mungkin:
|
|
Publisher |
Nilai yang menunjukkan apakah ini adalah Produk Microsoft atau pihak ketiga. Nilai yang mungkin:
|
|
Publishing |
Tahap penerbitan produk. Nilai yang mungkin:
|
|
Rating |
Wadah Peringkat |
| Sku |
The Sku |
|
Starting |
Harga eceran paket termurah produk |
|
Vm |
Jenis Arsitektur VM. Hanya berlaku untuk produk Komputer Virtual. Nilai yang mungkin:
|
|
Vm |
Jenis keamanan VM. Hanya berlaku untuk produk Komputer Virtual. Nilai yang mungkin:
|
Attribute
Mewakili atribut SKU, yang terdiri dari kunci dan nilai. Atribut mungkin berbeda di berbagai layanan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| key |
string |
Kunci atribut |
| value |
string |
Nilai atribut |
AzureBenefit
Kelayakan untuk manfaat komitmen konsumsi Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Nilai yang mungkin:
-
Eligible- Produk memenuhi syarat untuk manfaat komitmen konsumsi Azure -
NotEligible- Produk tidak memenuhi syarat untuk manfaat komitmen konsumsi Azure
| Nilai | Deskripsi |
|---|---|
| Eligible | |
| NotEligible |
Badge
Jenis lencana
| Nilai | Deskripsi |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Halaman respons terdiri dari daftar objek Produk (yang menyertakan subset atribut produk) bersama dengan tautan halaman berikutnya. Biasanya atribut produk yang dikembalikan dalam daftar digunakan untuk membangun petak peta produk untuk Galeri Marketplace. Catatan:catatan Jumlah maksimum item yang dikembalikan per halaman adalah 100. Dalam kasus tertentu untuk pengoptimalan performa, silakan hubungi tim Microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Nama | Jenis | Deskripsi |
|---|---|---|
| items |
Daftar item yang dikembalikan |
|
| nextPageLink |
string (uri) |
Tautkan ke halaman berikutnya di mana permintaan mengembalikan lebih dari satu halaman hasil |
CspState
Nilai yang menunjukkan apakah paket tersedia untuk dibeli melalui saluran CSP. Nilai yang mungkin:
-
OptIn- Merencanakan keikutsertaan program CSP yang dikonfigurasi untuk mitra mana pun dalam Program CSP -
Optout- Merencanakan penolakan program CSP yang dikonfigurasi -
SelectiveOptIn- Rencanakan keikutsertaan program CSP yang dikonfigurasi untuk mitra tertentu dalam program CSP yang dipilih ISV. Untuk informasi selengkapnya lihat, https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Nilai | Deskripsi |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Objek respons kesalahan API
| Nama | Jenis | Deskripsi |
|---|---|---|
| error |
Detail respons API |
ErrorResponseDetails
Objek detail respons kesalahan API
| Nama | Jenis | Deskripsi |
|---|---|---|
| code |
string |
Deskripsi kode kesalahan. Seperti code=InternalError |
| message |
string |
Pesan kesalahan. Seperti pesan=Kesalahan server internal |
Metadata
Metadata paket/SKU yang diperluas.
| Nama | Jenis | Deskripsi |
|---|---|---|
| altStackReference |
string |
Menunjuk ke planId yang menyimpan referensi tumpukan alternatif |
| generation |
string |
Pembuatan gambar VM (hanya berlaku untuk produk Komputer Virtual).lihat https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Menunjuk ke planId paket yang terkait dengan rencana ini |
PlanSkuRelation
Menunjuk ke objek SKU terkait
| Nama | Jenis | Deskripsi |
|---|---|---|
| relationType |
string |
Jenis Relasi |
| sku |
The Sku |
PlanSummary
Mengembalikan subset atribut Paket
| Nama | Jenis | Deskripsi |
|---|---|---|
| altArchitectureReference |
string |
Referensi arsitektur alternatif |
| altStackReference |
string |
Referensi tumpukan alternatif |
| categoryIds |
string[] |
Paket CategoryIds |
| cspState |
Nilai yang menunjukkan apakah paket tersedia untuk dibeli melalui saluran CSP. Nilai yang mungkin:
|
|
| description |
string |
Deskripsi rencana/sku |
| displayName |
string |
Nama tampilan paket/sku |
| displayRank |
string |
Urutan paket ditampilkan dalam tabel 'Paket' (seperti yang dikonfigurasi oleh penerbit) |
| hasProtectedArtifacts |
boolean |
Atur ke true jika paket memiliki artefak yang akan disembunyikan untuk pengguna yang tidak diautentikasi |
| hasRI |
boolean |
Indikasi apakah SKU mendukung reservasi |
| isPrivate |
boolean |
Indikasi bahwa paket hanya dapat diakses oleh audiens terbatas |
| metadata |
Metadata paket/SKU yang diperluas. |
|
| planId |
string |
Id paket |
| planType |
Jenis paket templat Aplikasi atau Solusi Terkelola (hanya berlaku untuk produk Aplikasi Azure). Nilai yang mungkin:
|
|
| pricingTypes |
Daftar jenis harga yang paket ini ditunjuk (Nilai yang mungkin sama seperti pada tingkat produk) |
|
| skuId |
string |
Id SKU |
| stackType |
string |
Jenis tumpukan : Klasik, Gen1, Gen2 |
| summary |
string |
Teks ringkasan paket |
| uniquePlanId |
string |
Id paket unik yang diawali dengan menggabungkan uniqueProductId dan PlanId tanpa pemisah di antaranya |
| vmArchitectureType |
Jenis Arsitektur VM. Hanya berlaku untuk produk Komputer Virtual. Nilai yang mungkin:
|
|
| vmSecuritytypes |
Jenis keamanan VM. Hanya berlaku untuk produk Komputer Virtual. Nilai yang mungkin:
|
PlanType
Jenis paket templat Aplikasi atau Solusi Terkelola (hanya berlaku untuk produk Aplikasi Azure). Nilai yang mungkin:
-
SolutionTemplate- Jenis paket Templat Solusi (hanya berlaku untuk Aplikasi Azure) -
ManagedApplication- Jenis paket Aplikasi Terkelola (hanya berlaku untuk Aplikasi Azure)
PricingType
Jenis harga
| Nilai | Deskripsi |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Mengembalikan subset atribut Produk
| Nama | Jenis | Deskripsi |
|---|---|---|
| applicableProducts |
string[] |
Kategori produk milik penawaran |
| attributes |
Kumpulan atribut produk (bervariasi per jenis produk), di mana setiap atribut diwakili oleh sepasang kunci (nama atribut) dan nilai(nilai atribut) |
|
| azureBenefit |
Kelayakan untuk manfaat komitmen konsumsi Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Nilai yang mungkin:
|
|
| badges |
Badge[] |
Lencana produk berikut tersedia: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Array kategori produk, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Seperti 'Produktivitas' |
| cspLegalTermsUri |
string |
Ketentuan hukum produk untuk CSP |
| description |
string |
Teks deskripsi produk |
| displayName |
string |
Nama tampilan produk |
| hasMarketplaceFootprint |
boolean |
Indikasi jika produk memiliki representasi di marketplace |
| hasRIPlans |
boolean |
Indikasi apakah produk memiliki paket dengan reservasi |
| industryIds |
string[] |
Daftar ID industri milik item |
| lastModifiedDateTime |
string (date-time) |
Tanggal pembaruan terbaru produk |
| linkedAddInsTypes |
object |
Jenis add-in tertaut |
| locations |
string[] |
Daftar lokasi yang tersedia di SKU |
| longSummary |
string |
Ringkasan panjang produk |
| operatingSystems |
string[] |
Info sistem operasi untuk produk ini |
| plans |
Daftar paket yang tersedia untuk produk ini |
|
| popularity |
number (double) |
Popularitas produk |
| pricingTypes |
Daftar jenis harga yang ditunjuk oleh penawaran ini. Nilai yang Mungkin:
|
|
| privacyPolicyUri |
string |
Kebijakan privasi produk |
| productFamily |
string |
Keluarga Produk |
| productId |
string |
Id unik produk |
| productSubType |
string |
Subjenis produk |
| productType |
Metode pengiriman atau model penyebaran. Nilai yang mungkin:
|
|
| publisherDisplayName |
string |
Nama tampilan Publisher |
| publisherId |
string |
Id penerbit |
| publisherType |
Nilai yang menunjukkan apakah ini adalah Produk Microsoft atau pihak ketiga. Nilai yang mungkin:
|
|
| publishingStage |
Tahap penerbitan produk. Nilai yang mungkin:
|
|
| ratingAverage |
number (double) |
Peringkat rata-rata untuk penawaran |
| ratingBuckets |
Wadah peringkat, Di Atas1, Di Atas2, Di Atas3, Di Atas4 |
|
| ratingCount |
integer (int32) |
Jumlah total peringkat untuk penawaran |
| service |
string |
Nama layanan produk, seperti 'Virtual Machines' |
| serviceFamily |
string |
Keluarga layanan produk, seperti 'Komputasi' |
| smallIconUri |
string |
URI ke ikon produk kecil |
| startingPrice |
Harga eceran paket termurah produk |
|
| summary |
string |
Ringkasan produk |
| supportedProducts |
string[] |
Memetakan ke daftar produk yang kompatibel yang disediakan penerbit |
| uniqueProductId |
string |
Pengidentifikasi produk unik |
ProductType
Metode pengiriman atau model penyebaran. Nilai yang mungkin:
-
SaaS- Produk ini adalah solusi Perangkat Lunak yang dibeli berdasarkan prabayar dari penyedia layanan cloud -
VirtualMachine- Produknya adalah instans layanan Gambar dengan harga berbasis penggunaan -
AzureApplication- Produk yang diterbitkan sebagai paket Templat Solusi (ST) atau Azure Managed Apps (AMA) yang menyebarkan sumber daya Azure ke penyewa pelanggan -
DynamicsCE- Semua produk Dynamics kecuali DynamicsBC dan DynamicsOps -
DynamicsBC- Pusat bisnis Dynamics 365 -
Container- Produk dikirimkan sebagai Kontainer -
DynamicsOps- Aplikasi Operasi Dynamics 365 -
None- Jenis produk yang dikembalikan untuk Azure Services, Ekstensi Kontainer, dan ekstensi VM -
IotEdgeModules- Sumber daya dikirimkan sebagai Modul IoT Edge -
ContainerApps- Sumber daya dikirimkan sebagai Aplikasi Kontainer -
ConsultingServicesConsulting Services (hanya tersedia di Marketplace Azure sebagai penawaran daftar) -
ManagedServices- Produk dikirimkan sebagai Layanan Terkelola -
PowerBI- Produk Power BI -
CosellOnly- Produk hanya tersedia dalam cakupan program Co-Sell -
PowerBIVisuals- Produk Power BI Visuals -
Office365- Produk Office 365 -
DevService- Layanan Dev -
AADApps- Aplikasi Azure Active Directory -
VisualStudioExtension- Ekstensi Visual Studio -
SolutionTemplate- Jenis paket Templat Solusi (hanya berlaku untuk Aplikasi Azure) -
ManagedApplication- Jenis paket Aplikasi Terkelola (hanya berlaku untuk Aplikasi Azure) -
MicrosoftProduct- produk Azure pihak ke-1
| Nilai | Deskripsi |
|---|---|
| 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
Nilai yang menunjukkan apakah ini adalah Produk Microsoft atau pihak ketiga. Nilai yang mungkin:
-
Microsoft- Produk diterbitkan oleh Microsoft (produk pihak ke-1) -
Third Party- Produk diterbitkan oleh Vendor Pihak Ketiga
| Nilai | Deskripsi |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Tahap penerbitan produk. Nilai yang mungkin:
-
Preview- Produk tersedia untuk audiens terbatas -
Public- Produk tersedia untuk umum di Marketplace
| Nilai | Deskripsi |
|---|---|
| Preview | |
| Public |
RatingBucket
Wadah Peringkat
| Nilai | Deskripsi |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
The Sku
| Nama | Jenis | Deskripsi |
|---|---|---|
| generation |
string |
Generasi |
| identity |
string |
Identitas |
| name |
string |
Nama |
StartingPrice
Harga eceran paket termurah produk
| Nama | Jenis | Deskripsi |
|---|---|---|
| currency |
string |
Mata uang untuk harga |
| market |
string |
Pasar yang harga awalnya dihitung |
| meterUnits |
string |
Unit model harga meteran |
| minMeterPrice |
number |
Harga meter awal (minimal) |
| minTermPrice |
number |
Harga istilah mulai (minimal) |
| termUnits |
string |
Unit model harga istilah |
VmArchitectureType
Jenis Arsitektur VM. Hanya berlaku untuk produk Komputer Virtual. Nilai yang mungkin:
-
Arm64- Arsitektur gambar VM dari paket ini adalah Arm64 -
X64Gen1- Arsitektur gambar VM dari paket ini adalah X64 Generation1 -
X64Gen2- Arsitektur gambar VM dari paket ini adalah X64 Generation2
| Nilai | Deskripsi |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Jenis keamanan VM. Hanya berlaku untuk produk Komputer Virtual. Nilai yang mungkin:
- Standar - Tingkat keamanan dasar untuk komputer virtual
- Tepercaya - melindungi dari serangan persisten dan tingkat lanjut pada komputer virtual Gen2 dengan fitur yang dapat dikonfigurasi seperti boot keamanan dan Modul Platform Tepercaya virtual (vTPM)
- Rahasia - selain Peluncuran Tepercaya, komputer virtual Rahasia menawarkan kerahasiaan dan integritas yang lebih tinggi yang dijamin dengan lingkungan eksekusi tepercaya berbasis perangkat keras
| Nilai | Deskripsi |
|---|---|
| None | |
| Trusted | |
| Confidential |