Public Products - List

Hizmet:: Marketplace Catalog

API Sürümü:: 2023-01-01-preview

Ticari kamu ürünlerinin bir listesini alın.

GET https://catalogapi.azure.com/products?api-version=2023-01-01-preview

İsteğe bağlı parametrelerle:

GET https://catalogapi.azure.com/products?api-version=2023-01-01-preview&storefront={storefront}&language={language}&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: `displayName` `popularity` `categoryIds` `industryIds` `publisherId` `uniqueProductId` `productType` `operatingSystems` `pricingTypes` `publisherDisplayName` `longSummary` `summary` `linkedAddinsTypes` `description` `supportedProducts` `applicableProducts` `lastModifiedDateTime` `plan.planId` `plan.displayName` `plan.cspState` `plan.altStackReference` `plan.stackType` `plan.categoryIds` `plan.hasProtectedArtifacts` `plan.pricingTypes` `plan.summary` `plan.description` `plan.skuId` `plan.displayRank` `plan.isPrivate`
hideKeys	query		string[]	Önizleme öğelerini almak için gizleme anahtarı ekleyin. Hidekey'ler 'multi' biçiminde sağlanır. Örnek: HideKey[]=first
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"
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: `lastModifiedDateTime` `uniqueProductId` `productType` `displayName` `publisherId`
select	query		string[]	Sonuçlara eklenecek özellikleri seçer. Örnek: 'select=displayName'
storefront	query		string	İlgili vitrin, olası değerler : 'azure, amp, appsource'. Varsayılan='azure'

İ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	CatalogApiResponse	Genel veya önizleme ürünlerinin listesini döndürür
Other Status Codes	ErrorResponse	Hata Yanıtları: 400 - Yanlış yapılandırılmış bir istek durumunda. 401 - Eksik api anahtarı üst bilgisi olması durumunda 500 - İç hata durumunda. Üst Bilgiler x-ms-error-code: string

Name

Tür

Description

200 OK

CatalogApiResponse

Genel veya önizleme ürünlerinin listesini döndürür

Other Status Codes

ErrorResponse

Hata Yanıtları:

400 - Yanlış yapılandırılmış bir istek durumunda.
401 - Eksik api anahtarı üst bilgisi olması durumunda
500 - İç hata durumunda.

Üst Bilgiler

x-ms-error-code: string

Örnekler

Product_Get

Örnek isteği

HTTP

GET https://catalogapi.azure.com/products?api-version=2023-01-01-preview&language=en&market=US

Örnek yanıt

Durum kodu:: 200

{
  "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",
      "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"
      ],
      "lastModifiedDateTime": "2022-02-14T23:31:25.5733368+00:00"
    }
  ],
  "nextPageLink": "https://catalogapi.azure.com/products?api-version=2023-01-01-preview&$skiptoken=W3sidG9rZW4iOiIrUklEOn4yVk53QU9LeFJIQWNBZ0FBQUFBQURnPT0jUlQ6MSNUUkM6MTU0I0lTVjoyI0lFTzo2NTU1MSNRQ0Y6OCIsInJhbmdlIjp7Im1pbiI6IjA1QzFFNzMzOTlDRDVFIiwibWF4IjoiMDVDMUU5NDk2NTMxMTIifX1d"
}

Tanımlar

Name	Description
AzureBenefit	Azure tüketim taahhüdü avantajı için uygunluk (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)
Badge	Rozet türü
CatalogApiResponse	Sonraki sayfa bağlantısıyla birlikte Ürün Özetleri listesinden oluşan yanıt sayfası
CspState	Planın CSP kanalı üzerinden satın alınıp alınamayacağını gösteren değer. Daha fazla bilgi için bkz. https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
ErrorResponse	Katalog API'sinin hata yanıtı nesnesi
ErrorResponseDetails	Katalog API'sinde hata yanıtı ayrıntıları nesnesi
Metadata	Ek plan meta verileri
PlanSkuRelation	İlgili plan bilgileri
PlanSummary	Planın özet açıklaması
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ü
ProductSummary	Ürünün özet açıklaması
ProductType	Teslim yöntemi veya dağıtım modeli
PublisherType	Bunun bir Microsoft ürünü mü yoksa üçüncü taraf ürün mü olduğunu gösteren değer
PublishingStage	Ürün yayımlama aşaması. Olası değerler şunlardır: Önizleme, Genel
RatingBucket	Derecelendirme Demetleri
Sku	SKU (Sıkça Kullanılanlar)
StartingPrice	Ürünün en ucuz planının perakende fiyatı
VmArchitectureType	VM Mimari Türü
VmSecurityType	VM Güvenlik türü

AzureBenefit

Listeleme

Azure tüketim taahhüdü avantajı için uygunluk (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)

Değer	Description
Eligible
NotEligible

Badge

Listeleme

Rozet türü

Değer	Description
AdditionalPurchaseRequirement
PowerBICertified
PreferredSolution

CatalogApiResponse

Object

Sonraki sayfa bağlantısıyla birlikte Ürün Özetleri listesinden oluşan yanıt sayfası

Name	Tür	Description
items	ProductSummary[]	Döndürülen öğelerin listesi
nextPageLink	string (uri)	İsteğin tek bir sayfadan fazla sonuç döndürdüğü sonraki sayfaya bağlantı

CspState

Listeleme

Planın CSP kanalı üzerinden satın alınıp alınamayacağını gösteren değer. Daha fazla bilgi için bkz. https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers

Değer	Description
OptIn
OptOut
SelectiveOptIn

ErrorResponse

Object

Katalog API'sinin hata yanıtı nesnesi

Name	Tür	Description
error	ErrorResponseDetails	Katalog API'sinin yanıt ayrıntıları

ErrorResponseDetails

Object

Katalog API'sinde 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

Object

Ek plan 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	PlanSkuRelation[]	Bu planla ilgili bir plan kimliğine işaret etme

PlanSkuRelation

Object

İlgili plan bilgileri

Name	Tür	Description
relationType	string	İlişki Türü
sku	Sku	SKU (Sıkça Kullanılanlar)

PlanSummary

Object

Planın özet açıklaması

Name	Tür	Description
altArchitectureReference	string	Alternatif mimari başvurusu
altStackReference	string	Alternatif yığın başvurusu
categoryIds	string[]	CategoryId'leri planlama
cspState	CspState	Ürünün CSP kanalı üzerinden satın alınıp alınamayacağını gösteren değer
description	string	Plan açıklaması
displayName	string	Planın 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
isPrivate	boolean	Plana yalnızca kısıtlı hedef kitle tarafından erişilebildiğinin göstergesi
metadata	Metadata	Ek plan meta verileri
planId	string	Plan kimliği
planType	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)
pricingTypes	PricingType[]	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	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
vmSecuritytypes	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

PlanType

Object

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

Listeleme

Fiyatlandırma türü

Değer	Description
Byol
Free
FreeTrial
Payg
Ri

ProductSummary

Object

Ürünün özet açıklaması

Name	Tür	Description
applicableProducts	string[]	Teklifin ait olduğu ürün kategorileri
azureBenefit	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
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
description	string	Ürün açıklaması metni
displayName	string	Ürün görünen adı
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
longSummary	string	Ürün uzun özeti
operatingSystems	string[]	Bu ürün için işletim sistemi bilgileri
plans	PlanSummary[]	Bu ürün için kullanılabilen planların listesi
popularity	number (double)	Ürünün popülerliği
pricingTypes	PricingType[]	Bu teklifin belirlendiği fiyatlandırma türlerinin listesi. Olası Değerler: `Free` - Ürünün ücretsiz olarak en az bir planı vardır. `FreeTrial` - Ürünün ücretsiz deneme sürümü olan en az bir planı vardır. `Byol` - Ürün, kendi lisansınızı getiren en az bir plana sahiptir. `Payg` - Ürünün Kullandıkça öde, kullanım tabanlı faturalama modeli olan en az bir planı vardır. `Ri` - Ürünün Ayrılmış Örnek faturalama modeli olan en az bir planı vardır.
productType	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 `ConsultingServices` - Danış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ı
publisherDisplayName	string	Yayımcı görünen adı
publisherId	string	Yayımcı kimliği
publisherType	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
publishingStage	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
ratingAverage	number (double)	Teklif için ortalama derecelendirme
ratingBuckets	RatingBucket[]	Derecelendirme demetleri, Above1, Above2, Above3, Above4
ratingCount	integer (int32)	Teklif için toplam derecelendirme sayısı
smallIconUri	string	Küçük ürün simgesine URI
startingPrice	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

Listeleme

Teslim yöntemi veya dağıtım modeli

Değer	Description
AADApps
AppService
AzureApplication
AzureServices
ConsultingServices
Container
ContainerApps
CoreVirtualMachine
CosellOnly
DevService
DynamicsBC
DynamicsCE
DynamicsOps
IotEdgeModules
LogAnalytics
ManagedApplication
ManagedServices
None
Office365
PowerBI
PowerBIVisuals
SaaS
SolutionTemplate
VirtualMachine
VisualStudioExtension

PublisherType

Listeleme

Bunun bir Microsoft ürünü mü yoksa üçüncü taraf ürün mü olduğunu gösteren değer

Değer	Description
Microsoft
ThirdParty

PublishingStage

Listeleme

Ürün yayımlama aşaması. Olası değerler şunlardır: Önizleme, Genel

Değer	Description
Preview
Public

RatingBucket

Listeleme

Derecelendirme Demetleri

Değer	Description
AboveFour
AboveOne
AboveThree
AboveTwo

Sku

Object

SKU (Sıkça Kullanılanlar)

Name	Tür	Description
generation	string	Nesil
identity	string	Kimlik
name	string	Ad

StartingPrice

Object

Ü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

Listeleme

VM Mimari Türü

Değer	Description
Arm64
X64Gen1
X64Gen2

VmSecurityType

Listeleme

VM Güvenlik türü

Değer	Description
Confidential
None
Trusted

Aracılığıyla paylaş

Public Products - List

URI Parametreleri

İstek Başlığı

Yanıtlar

Örnekler

Product_Get

Örnek isteği

Örnek yanıt

Tanımlar

AzureBenefit

Badge

CatalogApiResponse

CspState

ErrorResponse

ErrorResponseDetails

Metadata

PlanSkuRelation

PlanSummary

PlanType

PricingType

ProductSummary

ProductType

PublisherType

PublishingStage

RatingBucket

Sku

StartingPrice

VmArchitectureType

VmSecurityType