Skus - List

サービス:: Marketplace Catalog

API バージョン:: 2023-05-01-preview

商用SKUをリストします。

GET https://catalogapi.azure.com/skus?api-version=2023-05-01-preview&serviceFamily={serviceFamily}&service={service}

省略可能なパラメーターを含む:

GET https://catalogapi.azure.com/skus?api-version=2023-05-01-preview&serviceFamily={serviceFamily}&service={service}&language={language}&locations={locations}&market={market}&select={select}&filter={filter}&orderby={orderby}

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	要求に使用される REST API のバージョン。
service	query	True	string	製品のサービス名 ("Virtual Machines" など)
serviceFamily	query	True	string	製品のサービスファミリ ("コンピューティング" など)
filter	query		string	ブール条件に基づいて結果をフィルター処理します。例: 'filter=productType eq "VirtualMachine"' フィルター処理できるフィールドは次のとおりです。 `productId` `productDisplayName` `productDescription` `publisherId` `publisherType` `productType` `productSubType` `productAttributes` `skuName` `skuId` `skuType` `skuDescription` `skuTitle` `armRegionName` `skuGroupId` `cloud` `locationType` `region` `lastModifiedDateTime` `zone` `serviceType` `skuAttributes` `skuProperties` `offeringProperties`
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[]	選択した場所で利用可能な SKU を返します。 Azure データセンターリージョンの列挙。 https://azure.microsoft.com/regions/ を参照してください
market	query		string	製品の市場価値 (応答には、指定された市場で販売できる SKU のみが含まれます) 可能な値は、https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currenciesにあります。例: 'US'
orderby	query		string	OData 表記を使用した結果の順序付け式。要求の待機時間に影響を与える可能性があるため、必須でない限り、orderby を使用しないでください。例: 'orderby=skuName desc'。この API では、1 つのフィールドによる順序付けのみがサポートされます。並べ替え可能なフィールドは次のとおりです。 `lastModifiedDateTime` `publisherId` `productType` `skuName` `skuType`
select	query		string[]	結果に含めるプロパティを選択します。例: 'select=skuTitle'

要求ヘッダー

名前	必須	型	説明
X-API-Key	True	string	Marketplace カタログチームによって提供される API キーをヘッダーに指定されたパラメーターとして使用する

応答

名前	型	説明
200 OK	SkuApiResponse	パブリック製品またはプレビュー製品の一覧を返します。
Other Status Codes	ErrorResponse	エラー応答: 400 - 要求が正しく構成されていない場合。 401 - API キーヘッダーが見つからない場合 500 - 内部エラーが発生した場合。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

SkuApiResponse

パブリック製品またはプレビュー製品の一覧を返します。

Other Status Codes

ErrorResponse

エラー応答:

400 - 要求が正しく構成されていない場合。
401 - API キーヘッダーが見つからない場合
500 - 内部エラーが発生した場合。

ヘッダー

x-ms-error-code: string

例

List_Skus

要求のサンプル

HTTP

GET https://catalogapi.azure.com/skus?api-version=2023-05-01-preview&serviceFamily=Compute&service=Virtual Machines&language=en&locations=US East 2

応答のサンプル

状態コード:: 200

{
  "items": [
    {
      "productId": "product id",
      "productDisplayName": "product display name",
      "productDescription": "product descripiton",
      "serviceFamily": "Compute",
      "service": "Virtual Machines",
      "publisherId": "Microsoft",
      "publisherType": "Microsoft",
      "productType": "MicrosoftProduct",
      "productSubType": "Azure",
      "productAttributes": [],
      "skuName": "sku_1",
      "skuId": "0001",
      "skuType": "OnDemand",
      "language": "en",
      "skuDescription": "sku description",
      "skuTitle": "sku title",
      "lastModifiedDateTime": "2023-06-14T17:22:13.7231431Z",
      "location": "US East 2",
      "armRegionName": "eastus2",
      "cloud": "Global",
      "locationType": "Region",
      "region": "US East 2",
      "skuGroupId": "sku group id",
      "zone": "Zone 1",
      "feature": "Spot",
      "serviceType": "service type",
      "skuAttributes": [
        {
          "key": "attr1",
          "value": "val1"
        }
      ],
      "skuProperties": {
        "category": "General purpose",
        "dataDiskType": "Ssd",
        "diskType": "Ssd",
        "numberOfCores": "8",
        "ram": "64",
        "vCpu": "8",
        "armSkuName": "sku name"
      },
      "offeringProperties": [
        {
          "productCode": "00000000-0000-0000-0000-000000000000",
          "termId": "term id",
          "meterType": "meter type",
          "billingMeterId": "00000000-0000-0000-0000-000000000000",
          "offeringId": "00000000-0000-0000-0000-00000000000000000000-0000-0000-0000-000000000000",
          "type": "Consumption"
        }
      ]
    }
  ],
  "nextPageLink": "https://catalogapi.azure.com/skus?serviceFamily=Compute&service=Virtual+Machines&api-version=2023-05-01-preview&language=en&$filter=...&$skiptoken=W3s..."
}

定義

名前	説明
Attribute	キーと値で構成される SKU 属性を表します。属性は、さまざまなサービスで異なる場合があります。
CspState	プランが CSP チャネル経由で購入できるかどうかを示す値。使用可能な値: `OptIn` - CSP プログラムのパートナーに対して構成された CSP プログラムオプトインを計画する `Optout` - 構成済みの CSP プログラムのオプトアウトを計画する `SelectiveOptIn` - CSP プログラム ISV が選択する特定のパートナーに対して構成された CSP プログラムオプトインを計画します。詳細については、https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers を参照してください。
ErrorResponse	API エラー応答オブジェクト
ErrorResponseDetails	API エラー応答の詳細オブジェクト
OfferingProperties	SKU 価格関連のプロパティ
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 製品
PublisherType	これが Microsoft 製品かサードパーティ製品かを示す値。使用可能な値: `Microsoft` - 製品は Microsoft (ファーストパーティ製品) によって公開されています `Third Party` - 製品はサードパーティベンダーによって公開されています
SkuApiResponse	SKU の概要の一覧と次のページリンクで構成される応答ページ
SkuProperties	SKU プロパティには、OData フィルターを高速化するための属性がいくつか含まれています
SkuSummary	SKU の概要の説明

Attribute

Object

キーと値で構成される SKU 属性を表します。属性は、さまざまなサービスで異なる場合があります。

名前	型	説明
key	string	属性キー
value	string	属性値

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

Object

API エラー応答オブジェクト

名前	型	説明
error	ErrorResponseDetails	API 応答の詳細

ErrorResponseDetails

Object

API エラー応答の詳細オブジェクト

名前	型	説明
code	string	エラーコードの説明。 code=InternalError など
message	string	エラーメッセージ。 message=Internal サーバーエラーなど

OfferingProperties

Object

SKU 価格関連のプロパティ

名前	型	説明
billingMeterId	string	課金メーター ID
meterType	string	メーターの種類
offeringId	string	オファリング ID
productCode	string	製品コード (UPN)
termId	string	用語 ID
type	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

SkuApiResponse

Object

SKU の概要の一覧と次のページリンクで構成される応答ページ

名前	型	説明
items	SkuSummary[]	返される項目の一覧
nextPageLink	string (uri)	要求が複数の結果ページを返す次のページへのリンク

SkuProperties

Object

SKU プロパティには、OData フィルターを高速化するための属性がいくつか含まれています

名前	型	説明
accessTier	string	アクセス層 ("Standard" など)
armSkuName	string	Arm SKU 名
category	string	SKU カテゴリ
dataDiskType	string	"Ssd" などのデータディスクの種類
diskType	string	ディスクの種類 ("Ssd" など)
numberOfCores	string	コアの数
ram	string	ラム
vCpu	string	仮想 CPU の数

SkuSummary

Object

SKU の概要の説明

名前	型	説明
armRegionName	string	Arm リージョン名
cloud	string	クラウド ("グローバル" など)
cspState	CspState	プランが CSP チャネル経由で購入できるかどうかを示す値。使用可能な値: `OptIn` - CSP プログラムのパートナーに対して構成された CSP プログラムオプトインを計画する `Optout` - 構成済みの CSP プログラムのオプトアウトを計画する `SelectiveOptIn` - CSP プログラム ISV で選択した特定のパートナーの構成済み CSP プログラムオプトインを計画する
feature	string	この機能
hasRI	boolean	SKU が予約をサポートしているかどうかを示す
language	string	言語
lastModifiedDateTime	string (date-time)	SKU の最新の更新日
location	string	場所 (リージョン)
locationType	string	場所の種類 ("Region" など)
maxQuantity	integer (int32)	最大数量
minQuantity	integer (int32)	最小数量
offeringProperties	OfferingProperties[]	SKU 価格関連のプロパティ
productAttributes	Attribute[]	製品属性
productDescription	string	製品の説明テキスト
productDisplayName	string	製品の表示名
productId	string	製品の一意の ID
productSubType	string	製品のサブタイプ
productType	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 拡張機能 `MicrosoftProduct` - ファーストパーティの Azure 製品
publisherId	string	パブリッシャー ID
publisherType	PublisherType	これが Microsoft 製品かサードパーティ製品かを示す値。使用可能な値: `Microsoft` - 製品は Microsoft (ファーストパーティ製品) によって公開されています `Third Party` - 製品はサードパーティベンダーによって公開されています
region	string	リージョン ID
service	string	製品のサービス名 ("Virtual Machines" など)
serviceFamily	string	製品のサービスファミリ ("コンピューティング" など)
serviceType	string	サービスの種類
skuAttributes	Attribute[]	SKU 属性
skuDescription	string	ローカライズされた SKU の説明
skuGroupId	string	SKU グループ ID
skuId	string	SKU ID
skuName	string	SKU 名
skuProperties	SkuProperties	SKU のプロパティ
skuTitle	string	ローカライズされた SKU タイトル
skuType	string	SKU の種類
summary	string	製品の概要
zone	string	ゾーン ("ゾーン 1" など)

次の方法で共有

Skus - List

URI パラメーター

要求ヘッダー

応答

例

List_Skus

要求のサンプル

応答のサンプル

定義

Attribute

CspState

ErrorResponse

ErrorResponseDetails

OfferingProperties

ProductType

PublisherType

SkuApiResponse

SkuProperties

SkuSummary