Products - List
Ticari kamu ürünlerinin bir listesini alın.
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 Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
İstek için kullanılan REST API sürümü. |
|
expand
|
query |
string[] |
İlişkili varlıkları satır içi olarak genişletir. Örnek: 'expand=startingPrice' |
|
|
filter
|
query |
string |
Boole koşuluna göre sonuçları filtreler. Örnek: 'filter=productType eq "VirtualMachine"'. Filtrelenebilen alanlar şunlardır:
|
|
|
hide
|
query |
string[] |
Bu anahtar, önizleme ürünlerini almak için kullanılır ve teklif yayımlama işlemi sırasında İş Ortağı Merkezi'nin içinde oluşturulur. |
|
|
language
|
query |
string |
Aranacak dil, ISO 639-1 iki harfli kod, olası değerler - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Varsayılan değer "en" |
|
|
locations
|
query |
string[] |
Seçili konumda bulunan ürünleri iade edin. Azure veri merkezi bölgelerinin numaralandırması. Bkz. https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Ürün pazar değeri (yanıt yalnızca belirtilen pazarda satılabilir ürünleri içerecektir) Olası değerler https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currenciesadresinde bulunabilir. Örnek: 'US' |
|
|
orderby
|
query |
string |
OData gösterimini kullanarak sonuçlar için ifade sıralama. Bu, isteğinizin gecikme süresini etkileyebilebilmesi için gerekli olmadığı sürece orderby kullanmaktan kaçının. Örnek: 'orderby=displayName desc'. Bu API yalnızca tek bir alana göre sıralamayı destekler. Sıralayabileceğiniz alanlar şunlardır:
|
|
|
select
|
query |
string[] |
Sonuçlara eklenecek özellikleri seçer. Örnek: 'select=displayName' |
|
|
storefront
|
query |
string |
Azure Portal Marketi, AppSource veya Azure Market portalında bulunan ürünleri iade edin. Olası değerler şunlardır:
|
İstek Başlığı
| Name | Gerekli | Tür | Description |
|---|---|---|---|
| X-API-Key | True |
string |
Market Katalog Ekibi tarafından sağlanan Api anahtarını üst bilgide sağlanan bir parametre olarak kullanın |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
Genel veya önizleme ürünlerinin listesini döndürür |
|
| Other Status Codes |
Hata Yanıtları:
Üst Bilgiler x-ms-error-code: string |
Örnekler
List_Products
Örnek isteği
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Örnek yanıt
{
"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..."
}
Tanımlar
| Name | Description |
|---|---|
| Attribute |
Anahtar ve değerden oluşan bir SKU özniteliğini temsil eder. Öznitelikler çeşitli hizmetler arasında farklılık gösterebilir. |
|
Azure |
Azure tüketim taahhüdü avantajı için uygunluk (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Olası değerler:
|
| Badge |
Rozet türü |
|
Catalog |
Sonraki sayfa bağlantısıyla birlikte Product nesnelerinin (ürün özniteliklerinin alt kümesini içeren) bir listeden oluşan yanıt sayfası. Genellikle listede döndürülen ürün öznitelikleri Market Galerisi için ürün kutucukları oluşturmak için kullanılır. Not:not Sayfa başına döndürülen en fazla öğe sayısı 100'dür. Performans iyileştirme için belirli durumlarda lütfen Microsoft Market ekibine başvurun MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Planın CSP kanalı üzerinden satın alınıp alınamayacağını gösteren değer. Olası değerler:
|
|
Error |
API hata yanıtı nesnesi |
|
Error |
API hata yanıtı ayrıntıları nesnesi |
| Metadata |
Genişletilmiş plan/SKU meta verileri. |
|
Plan |
İlgili bir SKU nesnesine işaret etme |
|
Plan |
Plan özniteliklerinin bir alt kümesini döndürür |
|
Plan |
Yönetilen Uygulama veya Çözüm şablonu plan türü (yalnızca Azure Uygulamaları ürünü için geçerlidir). Olası değerler:
|
|
Pricing |
Fiyatlandırma türü |
|
Product |
Product özniteliklerinin bir alt kümesini döndürür |
|
Product |
Teslim yöntemi veya dağıtım modeli. Olası değerler:
|
|
Publisher |
Bunun bir Microsoft ürünü mü yoksa üçüncü taraf ürün mü olduğunu gösteren bir değer. Olası değerler:
|
|
Publishing |
Ürün yayımlama aşaması. Olası değerler:
|
|
Rating |
Derecelendirme Demetleri |
| Sku |
SKU (Sıkça Kullanılanlar) |
|
Starting |
Ürünün en ucuz planının perakende fiyatı |
|
Vm |
VM Mimari Türü. Yalnızca Sanal Makine ürünleri için geçerlidir. Olası değerler:
|
|
Vm |
VM güvenlik türü. Yalnızca Sanal Makine ürünleri için geçerlidir. Olası değerler:
|
Attribute
Anahtar ve değerden oluşan bir SKU özniteliğini temsil eder. Öznitelikler çeşitli hizmetler arasında farklılık gösterebilir.
| Name | Tür | Description |
|---|---|---|
| key |
string |
Öznitelik anahtarı |
| value |
string |
Öznitelik değeri |
AzureBenefit
Azure tüketim taahhüdü avantajı için uygunluk (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Olası değerler:
-
Eligible- Ürün Azure tüketim taahhüdü avantajı için uygundur -
NotEligible- Ürün Azure tüketim taahhüdü avantajı için uygun değil
| Değer | Description |
|---|---|
| Eligible | |
| NotEligible |
Badge
Rozet türü
| Değer | Description |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Sonraki sayfa bağlantısıyla birlikte Product nesnelerinin (ürün özniteliklerinin alt kümesini içeren) bir listeden oluşan yanıt sayfası. Genellikle listede döndürülen ürün öznitelikleri Market Galerisi için ürün kutucukları oluşturmak için kullanılır. Not:not Sayfa başına döndürülen en fazla öğe sayısı 100'dür. Performans iyileştirme için belirli durumlarda lütfen Microsoft Market ekibine başvurun MKPL_Platform_API_DL@microsoft.com
| Name | Tür | Description |
|---|---|---|
| items |
Döndürülen öğelerin listesi |
|
| nextPageLink |
string (uri) |
İsteğin tek bir sayfadan fazla sonuç döndürdüğü sonraki sayfaya bağlantı |
CspState
Planın CSP kanalı üzerinden satın alınıp alınamayacağını gösteren değer. Olası değerler:
-
OptIn- CSP Programı'ndaki herhangi bir iş ortağı için yapılandırılmış CSP programı kabul etme planı -
Optout- Yapılandırılmış CSP programını geri çevirmeyi planlama -
SelectiveOptIn- ISV'nin seçtiği CSP programındaki belirli iş ortakları için yapılandırılmış CSP programı kabul etme işlemini planlayın. Daha fazla bilgi için bkz. https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Değer | Description |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
API hata yanıtı nesnesi
| Name | Tür | Description |
|---|---|---|
| error |
API yanıt ayrıntıları |
ErrorResponseDetails
API hata yanıtı ayrıntıları nesnesi
| Name | Tür | Description |
|---|---|---|
| code |
string |
Hata kodu açıklaması. Code=InternalError gibi |
| message |
string |
Hata iletisi. İleti=İç sunucu hatası gibi |
Metadata
Genişletilmiş plan/SKU meta verileri.
| Name | Tür | Description |
|---|---|---|
| altStackReference |
string |
Alternatif yığın başvurularını barındıran bir planId'ye işaret etme |
| generation |
string |
VM görüntüsü oluşturma (yalnızca Sanal Makine ürünleri için geçerlidir).bkz. https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Bu planla ilgili planların plan kimliğine işaret etme |
PlanSkuRelation
İlgili bir SKU nesnesine işaret etme
| Name | Tür | Description |
|---|---|---|
| relationType |
string |
İlişki Türü |
| sku |
SKU (Sıkça Kullanılanlar) |
PlanSummary
Plan özniteliklerinin bir alt kümesini döndürür
| Name | Tür | Description |
|---|---|---|
| altArchitectureReference |
string |
Alternatif mimari başvurusu |
| altStackReference |
string |
Alternatif yığın başvurusu |
| categoryIds |
string[] |
CategoryId'leri planlama |
| cspState |
Planın CSP kanalı üzerinden satın alınıp alınamayacağını gösteren değer. Olası değerler:
|
|
| description |
string |
Plan / sku açıklaması |
| displayName |
string |
Planın / sku'nun görünen adı |
| displayRank |
string |
Planın 'Planlar' tablosunda görüntülenme sırası (yayımcı tarafından yapılandırıldığı gibi) |
| hasProtectedArtifacts |
boolean |
Plan kimliği doğrulanmamış kullanıcılar için gizlenecek yapıtlara sahipse true olarak ayarlayın |
| hasRI |
boolean |
SKU'nun rezervasyonları destekleyip desteklemediğinin göstergesi |
| isPrivate |
boolean |
Plana yalnızca kısıtlı hedef kitle tarafından erişilebildiğinin göstergesi |
| metadata |
Genişletilmiş plan/SKU meta verileri. |
|
| planId |
string |
Plan kimliği |
| planType |
Yönetilen Uygulama veya Çözüm şablonu plan türü (yalnızca Azure Uygulamaları ürünü için geçerlidir). Olası değerler:
|
|
| pricingTypes |
Bu planın belirlendiği fiyatlandırma türlerinin listesi (Olası değerler ürün düzeyindekilerle aynıdır) |
|
| skuId |
string |
SKU kimliği |
| stackType |
string |
Yığın türü: Klasik, 1. Nesil, 2. Nesil |
| summary |
string |
Plan özet metni |
| uniquePlanId |
string |
BenzersizProductId ve PlanId değerleri arasında ayırıcı olmadan birleştirilerek önekli benzersiz plan kimliği |
| vmArchitectureType |
VM Mimari Türü. Yalnızca Sanal Makine ürünleri için geçerlidir. Olası değerler:
|
|
| vmSecuritytypes |
VM güvenlik türü. Yalnızca Sanal Makine ürünleri için geçerlidir. Olası değerler:
|
PlanType
Yönetilen Uygulama veya Çözüm şablonu plan türü (yalnızca Azure Uygulamaları ürünü için geçerlidir). Olası değerler:
-
SolutionTemplate- Çözüm Şablonu plan türü (yalnızca Azure Uygulamaları için geçerlidir) -
ManagedApplication- Yönetilen Uygulama planı türü (yalnızca Azure Uygulamaları için geçerlidir)
PricingType
Fiyatlandırma türü
| Değer | Description |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Product özniteliklerinin bir alt kümesini döndürür
| Name | Tür | Description |
|---|---|---|
| applicableProducts |
string[] |
Teklifin ait olduğu ürün kategorileri |
| attributes |
Her özniteliğin bir anahtar çifti (öznitelik adı) ve değer (öznitelik değeri) ile temsil edildiği ürün öznitelikleri kümesi (ürün türüne göre değişir) |
|
| azureBenefit |
Azure tüketim taahhüdü avantajı için uygunluk (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Olası değerler:
|
|
| badges |
Badge[] |
Aşağıdaki ürün rozetleri kullanılabilir: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Ürün kategorileri dizisi, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. 'Üretkenlik' gibi |
| cspLegalTermsUri |
string |
CSP için ürünün yasal koşulları |
| description |
string |
Ürün açıklaması metni |
| displayName |
string |
Ürün görünen adı |
| hasMarketplaceFootprint |
boolean |
Ürünün markette temsili olup olmadığının göstergesi |
| hasRIPlans |
boolean |
Ürünün rezervasyonlarla ilgili planları olup olmadığının göstergesi |
| industryIds |
string[] |
Öğenin ait olduğu sektör kimliklerinin listesi |
| lastModifiedDateTime |
string (date-time) |
Ürünün en son güncelleştirme tarihi |
| linkedAddInsTypes |
object |
Bağlı eklenti türleri |
| locations |
string[] |
SKU'larda kullanılabilen konumların listesi |
| longSummary |
string |
Ürün uzun özeti |
| operatingSystems |
string[] |
Bu ürün için işletim sistemi bilgileri |
| plans |
Bu ürün için kullanılabilen planların listesi |
|
| popularity |
number (double) |
Ürünün popülerliği |
| pricingTypes |
Bu teklifin belirlendiği fiyatlandırma türlerinin listesi. Olası Değerler:
|
|
| privacyPolicyUri |
string |
Ürünün gizlilik ilkesi |
| productFamily |
string |
Ürün Ailesi |
| productId |
string |
Ürünün benzersiz kimliği |
| productSubType |
string |
Ürün alt türü |
| productType |
Teslim yöntemi veya dağıtım modeli. Olası değerler:
|
|
| publisherDisplayName |
string |
Yayımcı görünen adı |
| publisherId |
string |
Yayımcı kimliği |
| publisherType |
Bunun bir Microsoft ürünü mü yoksa üçüncü taraf ürün mü olduğunu gösteren bir değer. Olası değerler:
|
|
| publishingStage |
Ürün yayımlama aşaması. Olası değerler:
|
|
| ratingAverage |
number (double) |
Teklif için ortalama derecelendirme |
| ratingBuckets |
Derecelendirme demetleri, Above1, Above2, Above3, Above4 |
|
| ratingCount |
integer (int32) |
Teklif için toplam derecelendirme sayısı |
| service |
string |
Ürünün hizmet adı, örneğin 'Sanal Makineler' |
| serviceFamily |
string |
Ürünün 'İşlem' gibi hizmet ailesi |
| smallIconUri |
string |
Küçük ürün simgesine URI |
| startingPrice |
Ürünün en ucuz planının perakende fiyatı |
|
| summary |
string |
Ürün özeti |
| supportedProducts |
string[] |
Yayımcının sağladığı uyumlu ürünler listesine eşler |
| uniqueProductId |
string |
Benzersiz ürün tanımlayıcısı |
ProductType
Teslim yöntemi veya dağıtım modeli. Olası değerler:
-
SaaS- Ürün, bir bulut hizmeti sağlayıcısından kullandıkça öde temelinde satın alınan bir Yazılım çözümüdür -
VirtualMachine- Ürün, kullanım tabanlı fiyatlandırmaya sahip Görüntü hizmeti örnekleridir -
AzureApplication- Müşteri kiracısına Azure kaynaklarını dağıtan Çözüm Şablonları (ST) veya Azure Yönetilen Uygulamalar (AMA) planları olarak yayımlanan ürünler -
DynamicsCE- DynamicsBC ve DynamicsOps dışındaki tüm Dynamics ürünleri -
DynamicsBC- Dynamics 365 iş merkezi -
Container- Ürün Kapsayıcı olarak teslim edilir -
DynamicsOps- Dynamics 365 İşlemleri Uygulamaları -
None- Azure Hizmetleri, Kapsayıcı Uzantıları ve VM uzantıları için döndürülen ürün türü -
IotEdgeModules- Kaynak IoT Edge Modülü olarak teslim edilir -
ContainerApps- Kaynak Kapsayıcı Uygulaması olarak teslim edilir -
ConsultingServicesDanışmanlık Hizmetleri (yalnızca Azure Market'te listeleme teklifleri olarak kullanılabilir) -
ManagedServices- Ürün Yönetilen Hizmet olarak teslim edilir -
PowerBI- Power BI ürünleri -
CosellOnly- Yalnızca Co-Sell programı kapsamında kullanılabilen ürünler -
PowerBIVisuals- Power BI Görselleri ürünleri -
Office365- Office 365 ürünleri -
DevService- Geliştirme Hizmeti -
AADApps- Azure Active Directory Uygulamaları -
VisualStudioExtension- Visual Studio Uzantıları -
SolutionTemplate- Çözüm Şablonu plan türü (yalnızca Azure Uygulamaları için geçerlidir) -
ManagedApplication- Yönetilen Uygulama planı türü (yalnızca Azure Uygulamaları için geçerlidir) -
MicrosoftProduct- Birinci taraf Azure ürünü
| Değer | 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
Bunun bir Microsoft ürünü mü yoksa üçüncü taraf ürün mü olduğunu gösteren bir değer. Olası değerler:
-
Microsoft- Ürün Microsoft tarafından yayımlanır (birinci taraf ürün) -
Third Party- Ürün Üçüncü Taraf Satıcı tarafından yayımlanır
| Değer | Description |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Ürün yayımlama aşaması. Olası değerler:
-
Preview- Ürün kısıtlı hedef kitle tarafından kullanılabilir -
Public- Ürün Market'te herkese açık
| Değer | Description |
|---|---|
| Preview | |
| Public |
RatingBucket
Derecelendirme Demetleri
| Değer | Description |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
SKU (Sıkça Kullanılanlar)
| Name | Tür | Description |
|---|---|---|
| generation |
string |
Nesil |
| identity |
string |
Kimlik |
| name |
string |
Ad |
StartingPrice
Ürünün en ucuz planının perakende fiyatı
| Name | Tür | Description |
|---|---|---|
| currency |
string |
Fiyat için para birimi |
| market |
string |
Başlangıç fiyatının hesaplandığı pazar |
| meterUnits |
string |
Ölçüm fiyatlandırma modeli birimleri |
| minMeterPrice |
number |
Başlangıç (minimum) metre fiyatı |
| minTermPrice |
number |
Başlangıç (en düşük) terim fiyatı |
| termUnits |
string |
Fiyatlandırma modeli birimleri koşulları |
VmArchitectureType
VM Mimari Türü. Yalnızca Sanal Makine ürünleri için geçerlidir. Olası değerler:
-
Arm64- Planın VM görüntü mimarisi Arm64'tür -
X64Gen1- Planın VM görüntü mimarisi X64 Generation1'dir -
X64Gen2- Planın VM görüntü mimarisi X64 Generation2'dir
| Değer | Description |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
VM güvenlik türü. Yalnızca Sanal Makine ürünleri için geçerlidir. Olası değerler:
- Standart - Sanal makine için temel güvenlik düzeyi
- Güvenilir - Güvenlik önyüklemesi ve sanal Güvenilen Platform Modülü (vTPM) gibi yapılandırılabilir özelliklerle 2. Nesil sanal makinelerine yönelik kalıcı ve gelişmiş saldırılara karşı koruma sağlar
- Gizli - Güvenilir Başlatma'nın üzerine, Gizli sanal makineler donanım tabanlı güvenilir yürütme ortamıyla garanti edilen daha yüksek gizlilik ve bütünlük sunar
| Değer | Description |
|---|---|
| None | |
| Trusted | |
| Confidential |