Products - List
商用公開製品のリストを取得します。
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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api-version
|
query | True |
string |
要求に使用される REST API のバージョン。 |
expand
|
query |
string[] |
関連エンティティをインラインで展開します。 例: 'expand=startingPrice' |
|
filter
|
query |
string |
ブール条件に基づいて結果をフィルター処理します。 例: 'filter=productType eq "VirtualMachine"' フィルター処理できるフィールドは次のとおりです。
|
|
hide
|
query |
string[] |
このキーはプレビュー製品を取得するために使用され、オファーの発行プロセス中にパートナー センター内で生成されます。 |
|
language
|
query |
string |
検索する言語、ISO 639-1 の 2 文字コード、可能な値 - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl、pt-br、pt-pt、ru、sv、tr、zh-hans、zh-hant'。 既定値は "en" です |
|
locations
|
query |
string[] |
選択した場所で利用可能な返品製品。 Azure データセンター リージョンの列挙。 https://azure.microsoft.com/regions/ を参照してください |
|
market
|
query |
string |
製品の市場価値 (応答には、指定された市場で販売できる製品のみが含まれます) 可能な値は、https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currenciesにあります。 例: 'US' |
|
orderby
|
query |
string |
OData 表記を使用した結果の順序付け式。 要求の待機時間に影響を与える可能性があるため、必須でない限り、orderby を使用しないでください。 例: 'orderby=displayName desc'。この API では、1 つのフィールドによる順序付けのみがサポートされます。 並べ替え可能なフィールドは次のとおりです。
|
|
select
|
query |
string[] |
結果に含めるプロパティを選択します。 例: 'select=displayName' |
|
storefront
|
query |
string |
Azure Portal Marketplace、AppSource、または Azure Marketplace ポータルで利用可能な製品を返します。 指定できる値は次のとおりです。
|
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
X-API-Key | True |
string |
Marketplace カタログ チームによって提供される API キーをヘッダーに指定されたパラメーターとして使用する |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
パブリック製品またはプレビュー製品の一覧を返します。 |
|
Other Status Codes |
エラー応答:
ヘッダー x-ms-error-code: string |
例
List_Products
要求のサンプル
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
応答のサンプル
{
"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..."
}
定義
名前 | 説明 |
---|---|
Attribute |
キーと値で構成される SKU 属性を表します。 属性は、さまざまなサービスで異なる場合があります。 |
Azure |
Azure 従量課金コミットメント特典の対象 (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)。 使用可能な値:
|
Badge |
バッジの種類 |
Catalog |
製品オブジェクトの一覧 (製品属性のサブセットを含む) と次のページ リンクで構成される応答ページ。 通常、一覧で返される製品属性は、Marketplace ギャラリーの製品タイルを作成するために使用されます。 注:ページごとに返されるアイテムの最大数は 100 です。 パフォーマンスの最適化については、Microsoft Marketplace チームにお問い合わせください MKPL_Platform_API_DL@microsoft.com |
Csp |
プランが CSP チャネル経由で購入できるかどうかを示す値。 使用可能な値:
|
Error |
API エラー応答オブジェクト |
Error |
API エラー応答の詳細オブジェクト |
Metadata |
拡張されたプラン/SKU メタデータ。 |
Plan |
関連する SKU オブジェクトを指す |
Plan |
Plan 属性のサブセットを返します。 |
Plan |
マネージド アプリケーションまたはソリューション テンプレート プランの種類 (Azure Applications 製品にのみ適用されます)。 使用可能な値:
|
Pricing |
価格の種類 |
Product |
Product 属性のサブセットを返します。 |
Product |
配信方法またはデプロイ モデル。 使用可能な値:
|
Publisher |
これが Microsoft 製品かサード パーティ製品かを示す値。 使用可能な値:
|
Publishing |
製品発行ステージ。 使用可能な値:
|
Rating |
評価バケット |
Sku |
スクウ |
Starting |
製品の最も安いプランの小売価格 |
Vm |
VM アーキテクチャの種類。 仮想マシン製品にのみ適用されます。 使用可能な値:
|
Vm |
VM のセキュリティの種類。 仮想マシン製品にのみ適用されます。 使用可能な値:
|
Attribute
キーと値で構成される SKU 属性を表します。 属性は、さまざまなサービスで異なる場合があります。
名前 | 型 | 説明 |
---|---|---|
key |
string |
属性キー |
value |
string |
属性値 |
AzureBenefit
Azure 従量課金コミットメント特典の対象 (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)。 使用可能な値:
-
Eligible
- 製品は Azure 従量課金コミットメント特典の対象です -
NotEligible
- 製品は Azure 従量課金コミットメント特典の対象ではありません
値 | 説明 |
---|---|
Eligible | |
NotEligible |
Badge
バッジの種類
値 | 説明 |
---|---|
AdditionalPurchaseRequirement | |
PowerBICertified | |
PreferredSolution |
CatalogApiResponse
製品オブジェクトの一覧 (製品属性のサブセットを含む) と次のページ リンクで構成される応答ページ。 通常、一覧で返される製品属性は、Marketplace ギャラリーの製品タイルを作成するために使用されます。 注:ページごとに返されるアイテムの最大数は 100 です。 パフォーマンスの最適化については、Microsoft Marketplace チームにお問い合わせください MKPL_Platform_API_DL@microsoft.com
名前 | 型 | 説明 |
---|---|---|
items |
返される項目の一覧 |
|
nextPageLink |
string (uri) |
要求が複数の結果ページを返す次のページへのリンク |
CspState
プランが CSP チャネル経由で購入できるかどうかを示す値。 使用可能な値:
-
OptIn
- CSP プログラムのパートナーに対して構成された CSP プログラムオプトインを計画する -
Optout
- 構成済みの CSP プログラムのオプトアウトを計画する -
SelectiveOptIn
- CSP プログラム ISV が選択する特定のパートナーに対して構成された CSP プログラムオプトインを計画します。 詳細については、https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers を参照してください。
値 | 説明 |
---|---|
OptIn | |
OptOut | |
SelectiveOptIn |
ErrorResponse
API エラー応答オブジェクト
名前 | 型 | 説明 |
---|---|---|
error |
API 応答の詳細 |
ErrorResponseDetails
API エラー応答の詳細オブジェクト
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コードの説明。 code=InternalError など |
message |
string |
エラー メッセージ。 message=Internal サーバー エラーなど |
Metadata
拡張されたプラン/SKU メタデータ。
名前 | 型 | 説明 |
---|---|---|
altStackReference |
string |
代替スタック参照を保持する planId を指す |
generation |
string |
VM イメージの生成 (仮想マシン製品にのみ適用されます)、「https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 を参照してください。 |
relatedSkus |
このプランに関連するプランの planId を指す |
PlanSkuRelation
関連する SKU オブジェクトを指す
名前 | 型 | 説明 |
---|---|---|
relationType |
string |
リレーションシップの種類 |
sku |
スクウ |
PlanSummary
Plan 属性のサブセットを返します。
名前 | 型 | 説明 |
---|---|---|
altArchitectureReference |
string |
代替アーキテクチャ リファレンス |
altStackReference |
string |
代替スタック リファレンス |
categoryIds |
string[] |
プラン カテゴリ ID |
cspState |
プランが CSP チャネル経由で購入できるかどうかを示す値。 使用可能な値:
|
|
description |
string |
プラン/SKU の説明 |
displayName |
string |
プラン/SKU の表示名 |
displayRank |
string |
プランが "Plans" テーブルに表示される順序 (発行元によって構成されている) |
hasProtectedArtifacts |
boolean |
認証されていないユーザーに対して非表示にする成果物がプランにある場合は true に設定します |
hasRI |
boolean |
SKU が予約をサポートしているかどうかを示す |
isPrivate |
boolean |
制限付き対象ユーザーのみがプランにアクセス可能であることを示す |
metadata |
拡張されたプラン/SKU メタデータ。 |
|
planId |
string |
プラン ID |
planType |
マネージド アプリケーションまたはソリューション テンプレート プランの種類 (Azure Applications 製品にのみ適用されます)。 使用可能な値:
|
|
pricingTypes |
このプランが指定されている価格の種類の一覧 (使用可能な値は製品レベルと同じです) |
|
skuId |
string |
SKU ID |
stackType |
string |
スタックの種類: クラシック、Gen1、Gen2 |
summary |
string |
プランの概要テキスト |
uniquePlanId |
string |
uniqueProductId と PlanId を組み合わせて先頭に区切り記号がない一意のプラン ID |
vmArchitectureType |
VM アーキテクチャの種類。 仮想マシン製品にのみ適用されます。 使用可能な値:
|
|
vmSecuritytypes |
VM のセキュリティの種類。 仮想マシン製品にのみ適用されます。 使用可能な値:
|
PlanType
マネージド アプリケーションまたはソリューション テンプレート プランの種類 (Azure Applications 製品にのみ適用されます)。 使用可能な値:
-
SolutionTemplate
- ソリューション テンプレートプランの種類 (Azure アプリケーションにのみ適用) -
ManagedApplication
- マネージド アプリケーション プランの種類 (Azure アプリケーションにのみ適用)
PricingType
価格の種類
値 | 説明 |
---|---|
Byol | |
Free | |
FreeTrial | |
Payg | |
Ri |
ProductSummary
Product 属性のサブセットを返します。
名前 | 型 | 説明 |
---|---|---|
applicableProducts |
string[] |
オファーが属する製品カテゴリ |
attributes |
製品属性のセット (製品の種類によって異なります)、各属性はキー (属性名) と value(属性値) のペアで表されます |
|
azureBenefit |
Azure 従量課金コミットメント特典の対象 (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)。 使用可能な値:
|
|
badges |
Badge[] |
次の製品バッジを使用できます。preferredSolution、powerBICertified、AdditionalPurchaseRequirement |
categoryIds |
string[] |
製品カテゴリの配列、https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories。 "生産性" など |
cspLegalTermsUri |
string |
CSP の製品の法的条件 |
description |
string |
製品の説明テキスト |
displayName |
string |
製品の表示名 |
hasMarketplaceFootprint |
boolean |
製品がマーケットプレースに表示されているかどうかを示す |
hasRIPlans |
boolean |
製品に予約があるプランがあるかどうかを示す |
industryIds |
string[] |
項目が属する業界 ID の一覧 |
lastModifiedDateTime |
string (date-time) |
製品の最新の更新日 |
linkedAddInsTypes |
object |
リンクされたアドインの種類 |
locations |
string[] |
SKU で使用可能な場所の一覧 |
longSummary |
string |
製品の長い概要 |
operatingSystems |
string[] |
この製品のオペレーティング システム情報 |
plans |
この製品で使用できるプランの一覧 |
|
popularity |
number (double) |
製品の人気 |
pricingTypes |
このオファーが指定されている価格の種類の一覧。 使用可能な値:
|
|
privacyPolicyUri |
string |
製品のプライバシー ポリシー |
productFamily |
string |
製品ファミリ |
productId |
string |
製品の一意の ID |
productSubType |
string |
製品のサブタイプ |
productType |
配信方法またはデプロイ モデル。 使用可能な値:
|
|
publisherDisplayName |
string |
発行元の表示名 |
publisherId |
string |
パブリッシャー ID |
publisherType |
これが Microsoft 製品かサード パーティ製品かを示す値。 使用可能な値:
|
|
publishingStage |
製品発行ステージ。 使用可能な値:
|
|
ratingAverage |
number (double) |
オファーの平均評価 |
ratingBuckets |
評価バケット、Above1、Above2、Above3、Above4 |
|
ratingCount |
integer (int32) |
オファーの評価の合計数 |
service |
string |
製品のサービス名 ("Virtual Machines" など) |
serviceFamily |
string |
製品のサービス ファミリ ("コンピューティング" など) |
smallIconUri |
string |
小さな製品アイコンへの URI |
startingPrice |
製品の最も安いプランの小売価格 |
|
summary |
string |
製品の概要 |
supportedProducts |
string[] |
発行元が提供する互換性のある製品の一覧にマップされます |
uniqueProductId |
string |
一意の製品識別子 |
ProductType
配信方法またはデプロイ モデル。 使用可能な値:
-
SaaS
- 製品は、クラウド サービス プロバイダーから従量課金制で購入されたソフトウェア ソリューションです -
VirtualMachine
- 製品は、使用量ベースの価格を持つイメージ サービス インスタンスです -
AzureApplication
- 顧客テナントに Azure リソースをデプロイするソリューション テンプレート (ST) または Azure Managed Apps (AMA) プランとして公開された製品 -
DynamicsCE
- DynamicsBC および DynamicsOps を除くすべての Dynamics 製品 -
DynamicsBC
- Dynamics 365 Business Central -
Container
- 製品はコンテナーとして配信されます -
DynamicsOps
- Dynamics 365 Operations アプリ -
None
- Azure サービス、コンテナー拡張機能、VM 拡張機能に対して返される製品の種類 -
IotEdgeModules
- リソースは IoT Edge モジュールとして配信されます -
ContainerApps
- リソースはコンテナー アプリとして配信されます -
ConsultingServices
コンサルティング サービス (リスト オファーとして Azure Marketplace でのみ利用可能) -
ManagedServices
- 製品はマネージド サービスとして配信されます -
PowerBI
- Power BI 製品 -
CosellOnly
- Co-Sell プログラムの範囲でのみ利用可能な製品 -
PowerBIVisuals
- Power BI ビジュアル製品 -
Office365
- Office 365 製品 -
DevService
- Devサービス -
AADApps
- Azure Active Directory アプリケーション -
VisualStudioExtension
- Visual Studio 拡張機能 -
SolutionTemplate
- ソリューション テンプレートプランの種類 (Azure アプリケーションにのみ適用) -
ManagedApplication
- マネージド アプリケーション プランの種類 (Azure アプリケーションにのみ適用) -
MicrosoftProduct
- ファースト パーティの Azure 製品
値 | 説明 |
---|---|
AADApps | |
AppService | |
AzureApplication | |
AzureServices | |
ConsultingServices | |
Container | |
ContainerApps | |
CoreVirtualMachine | |
CosellOnly | |
DevService | |
DynamicsBC | |
DynamicsCE | |
DynamicsOps | |
IotEdgeModules | |
LogAnalytics | |
ManagedApplication | |
ManagedServices | |
MicrosoftProduct | |
None | |
Office365 | |
PowerBI | |
PowerBIVisuals | |
SaaS | |
SolutionTemplate | |
VirtualMachine | |
VisualStudioExtension |
PublisherType
これが Microsoft 製品かサード パーティ製品かを示す値。 使用可能な値:
-
Microsoft
- 製品は Microsoft (ファースト パーティ製品) によって公開されています -
Third Party
- 製品はサード パーティ ベンダーによって公開されています
値 | 説明 |
---|---|
Microsoft | |
ThirdParty |
PublishingStage
製品発行ステージ。 使用可能な値:
-
Preview
- 制限付き対象ユーザーが製品を利用できる -
Public
- 製品は Marketplace で一般公開されています
値 | 説明 |
---|---|
Preview | |
Public |
RatingBucket
評価バケット
値 | 説明 |
---|---|
AboveFour | |
AboveOne | |
AboveThree | |
AboveTwo |
Sku
スクウ
名前 | 型 | 説明 |
---|---|---|
generation |
string |
生成 |
identity |
string |
ID |
name |
string |
名前 |
StartingPrice
製品の最も安いプランの小売価格
名前 | 型 | 説明 |
---|---|---|
currency |
string |
価格の通貨 |
market |
string |
開始価格が計算される市場 |
meterUnits |
string |
メーターの価格モデルユニット |
minMeterPrice |
number |
開始 (最小) メーターの価格 |
minTermPrice |
number |
開始 (最小) 条項の価格 |
termUnits |
string |
価格モデル ユニットという用語 |
VmArchitectureType
VM アーキテクチャの種類。 仮想マシン製品にのみ適用されます。 使用可能な値:
-
Arm64
- プランの VM イメージ アーキテクチャは Arm64 です -
X64Gen1
- プランの VM イメージ アーキテクチャは X64 Generation1 です -
X64Gen2
- プランの VM イメージ アーキテクチャは X64 Generation2 です
値 | 説明 |
---|---|
Arm64 | |
X64Gen1 | |
X64Gen2 |
VmSecurityType
VM のセキュリティの種類。 仮想マシン製品にのみ適用されます。 使用可能な値:
- Standard - 仮想マシンの基本的なセキュリティ レベル
- 信頼 - セキュリティ ブートや仮想トラステッド プラットフォーム モジュール (vTPM) などの構成可能な機能を使用して、Gen2 仮想マシンに対する永続的かつ高度な攻撃から保護します
- 機密 - 信頼された起動に加え、機密仮想マシンは、ハードウェアベースの信頼された実行環境で保証された高い機密性と整合性を提供します
値 | 説明 |
---|---|
Confidential | |
None | |
Trusted |