Api Management Skus - List

Service:

API Management

API Version:

2022-08-01

サブスクリプションで使用できる Microsoft.ApiManagement SKU の一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus?api-version=2022-08-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ApiManagementSkusResult	OK
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Lists all available Resource SKUs

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.ApiManagement/skus?api-version=2022-08-01

Java

/** Samples for ApiManagementSkus List. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSku.json
     */
    /**
     * Sample code: Lists all available Resource SKUs.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void listsAllAvailableResourceSKUs(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementSkus().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_sku.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_management_skus.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSku.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSku.json
func ExampleSKUsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSKUsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SKUsResult = armapimanagement.SKUsResult{
		// 	Value: []*armapimanagement.SKU{
		// 		{
		// 			Name: to.Ptr("Developer"),
		// 			Capacity: &armapimanagement.SKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](1),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeNone),
		// 			},
		// 			LocationInfo: []*armapimanagement.SKULocationInfo{
		// 				{
		// 					Location: to.Ptr("centralindia"),
		// 					ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 					},
		// 					Zones: []*string{
		// 					},
		// 			}},
		// 			Locations: []*string{
		// 				to.Ptr("centralindia")},
		// 				ResourceType: to.Ptr("service"),
		// 				Restrictions: []*armapimanagement.SKURestrictions{
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("Standard"),
		// 				Capacity: &armapimanagement.SKUCapacity{
		// 					Default: to.Ptr[int32](1),
		// 					Maximum: to.Ptr[int32](4),
		// 					Minimum: to.Ptr[int32](1),
		// 					ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeAutomatic),
		// 				},
		// 				LocationInfo: []*armapimanagement.SKULocationInfo{
		// 					{
		// 						Location: to.Ptr("centralindia"),
		// 						ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 						},
		// 						Zones: []*string{
		// 						},
		// 				}},
		// 				Locations: []*string{
		// 					to.Ptr("centralindia")},
		// 					ResourceType: to.Ptr("service"),
		// 					Restrictions: []*armapimanagement.SKURestrictions{
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("Premium"),
		// 					Capacity: &armapimanagement.SKUCapacity{
		// 						Default: to.Ptr[int32](1),
		// 						Maximum: to.Ptr[int32](10),
		// 						Minimum: to.Ptr[int32](1),
		// 						ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeAutomatic),
		// 					},
		// 					LocationInfo: []*armapimanagement.SKULocationInfo{
		// 						{
		// 							Location: to.Ptr("centralindia"),
		// 							ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 							},
		// 							Zones: []*string{
		// 							},
		// 					}},
		// 					Locations: []*string{
		// 						to.Ptr("centralindia")},
		// 						ResourceType: to.Ptr("service"),
		// 						Restrictions: []*armapimanagement.SKURestrictions{
		// 						},
		// 					},
		// 					{
		// 						Name: to.Ptr("Basic"),
		// 						Capacity: &armapimanagement.SKUCapacity{
		// 							Default: to.Ptr[int32](1),
		// 							Maximum: to.Ptr[int32](2),
		// 							Minimum: to.Ptr[int32](1),
		// 							ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeManual),
		// 						},
		// 						LocationInfo: []*armapimanagement.SKULocationInfo{
		// 							{
		// 								Location: to.Ptr("centralindia"),
		// 								ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 								},
		// 								Zones: []*string{
		// 								},
		// 						}},
		// 						Locations: []*string{
		// 							to.Ptr("centralindia")},
		// 							ResourceType: to.Ptr("service"),
		// 							Restrictions: []*armapimanagement.SKURestrictions{
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("Consumption"),
		// 							Capacity: &armapimanagement.SKUCapacity{
		// 								Default: to.Ptr[int32](0),
		// 								Maximum: to.Ptr[int32](0),
		// 								Minimum: to.Ptr[int32](0),
		// 								ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeNone),
		// 							},
		// 							LocationInfo: []*armapimanagement.SKULocationInfo{
		// 								{
		// 									Location: to.Ptr("centralindia"),
		// 									ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 									},
		// 									Zones: []*string{
		// 									},
		// 							}},
		// 							Locations: []*string{
		// 								to.Ptr("centralindia")},
		// 								ResourceType: to.Ptr("service"),
		// 								Restrictions: []*armapimanagement.SKURestrictions{
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("Developer"),
		// 								Capacity: &armapimanagement.SKUCapacity{
		// 									Default: to.Ptr[int32](1),
		// 									Maximum: to.Ptr[int32](1),
		// 									Minimum: to.Ptr[int32](1),
		// 									ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeNone),
		// 								},
		// 								LocationInfo: []*armapimanagement.SKULocationInfo{
		// 									{
		// 										Location: to.Ptr("uaenorth"),
		// 										ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 										},
		// 										Zones: []*string{
		// 										},
		// 								}},
		// 								Locations: []*string{
		// 									to.Ptr("uaenorth")},
		// 									ResourceType: to.Ptr("service"),
		// 									Restrictions: []*armapimanagement.SKURestrictions{
		// 									},
		// 								},
		// 								{
		// 									Name: to.Ptr("Standard"),
		// 									Capacity: &armapimanagement.SKUCapacity{
		// 										Default: to.Ptr[int32](1),
		// 										Maximum: to.Ptr[int32](4),
		// 										Minimum: to.Ptr[int32](1),
		// 										ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeAutomatic),
		// 									},
		// 									LocationInfo: []*armapimanagement.SKULocationInfo{
		// 										{
		// 											Location: to.Ptr("uaenorth"),
		// 											ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 											},
		// 											Zones: []*string{
		// 											},
		// 									}},
		// 									Locations: []*string{
		// 										to.Ptr("uaenorth")},
		// 										ResourceType: to.Ptr("service"),
		// 										Restrictions: []*armapimanagement.SKURestrictions{
		// 										},
		// 									},
		// 									{
		// 										Name: to.Ptr("Premium"),
		// 										Capacity: &armapimanagement.SKUCapacity{
		// 											Default: to.Ptr[int32](1),
		// 											Maximum: to.Ptr[int32](10),
		// 											Minimum: to.Ptr[int32](1),
		// 											ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeAutomatic),
		// 										},
		// 										LocationInfo: []*armapimanagement.SKULocationInfo{
		// 											{
		// 												Location: to.Ptr("uaenorth"),
		// 												ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 												},
		// 												Zones: []*string{
		// 												},
		// 										}},
		// 										Locations: []*string{
		// 											to.Ptr("uaenorth")},
		// 											ResourceType: to.Ptr("service"),
		// 											Restrictions: []*armapimanagement.SKURestrictions{
		// 											},
		// 										},
		// 										{
		// 											Name: to.Ptr("Basic"),
		// 											Capacity: &armapimanagement.SKUCapacity{
		// 												Default: to.Ptr[int32](1),
		// 												Maximum: to.Ptr[int32](2),
		// 												Minimum: to.Ptr[int32](1),
		// 												ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeManual),
		// 											},
		// 											LocationInfo: []*armapimanagement.SKULocationInfo{
		// 												{
		// 													Location: to.Ptr("uaenorth"),
		// 													ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 													},
		// 													Zones: []*string{
		// 													},
		// 											}},
		// 											Locations: []*string{
		// 												to.Ptr("uaenorth")},
		// 												ResourceType: to.Ptr("service"),
		// 												Restrictions: []*armapimanagement.SKURestrictions{
		// 												},
		// 											},
		// 											{
		// 												Name: to.Ptr("Developer"),
		// 												Capacity: &armapimanagement.SKUCapacity{
		// 													Default: to.Ptr[int32](1),
		// 													Maximum: to.Ptr[int32](1),
		// 													Minimum: to.Ptr[int32](1),
		// 													ScaleType: to.Ptr(armapimanagement.APIManagementSKUCapacityScaleTypeNone),
		// 												},
		// 												LocationInfo: []*armapimanagement.SKULocationInfo{
		// 													{
		// 														Location: to.Ptr("australiacentral"),
		// 														ZoneDetails: []*armapimanagement.SKUZoneDetails{
		// 														},
		// 														Zones: []*string{
		// 														},
		// 												}},
		// 												Locations: []*string{
		// 													to.Ptr("australiacentral")},
		// 													ResourceType: to.Ptr("service"),
		// 													Restrictions: []*armapimanagement.SKURestrictions{
		// 													},
		// 											}},
		// 										}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.
 *
 * @summary Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSku.json
 */
async function listsAllAvailableResourceSkUs() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiManagementSkus.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "resourceType": "service",
      "name": "Developer",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "None"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Standard",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Premium",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Basic",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 2,
        "default": 1,
        "scaleType": "Manual"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Consumption",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 0,
        "maximum": 0,
        "default": 0,
        "scaleType": "None"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Developer",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "None"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Standard",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Premium",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Basic",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 2,
        "default": 1,
        "scaleType": "Manual"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Developer",
      "locations": [
        "australiacentral"
      ],
      "locationInfo": [
        {
          "location": "australiacentral",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "None"
      },
      "restrictions": []
    }
  ]
}

定義

名前	説明
ApiManagementSku	使用可能な ApiManagement SKU について説明します。
ApiManagementSkuCapabilities	SKU 機能オブジェクトについて説明します。
ApiManagementSkuCapacity	SKU のスケーリング情報について説明します。
ApiManagementSkuCapacityScaleType	SKU に適用できるスケールの種類。
ApiManagementSkuCosts	価格情報を取得するためのメタデータについて説明します。
ApiManagementSkuLocationInfo
ApiManagementSkuRestrictionInfo
ApiManagementSkuRestrictions	SKU のスケーリング情報について説明します。
ApiManagementSkuRestrictionsReasonCode	制限の理由。
ApiManagementSkuRestrictionsType	制限の種類。
ApiManagementSkusResult	リソース SKU の一覧表示操作の応答。
ApiManagementSkuZoneDetails	SKU のゾーン機能について説明します。
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。

ApiManagementSku

使用可能な ApiManagement SKU について説明します。

名前	型	説明
apiVersions	string[]	この SKU をサポートする API バージョン。
capabilities	ApiManagementSkuCapabilities[]	機能を記述する名前と値のペア。
capacity	ApiManagementSkuCapacity	スケール セット内の仮想マシンの数を指定します。
costs	ApiManagementSkuCosts[]	価格情報を取得するためのメタデータ。
family	string	この特定の SKU のファミリ。
kind	string	この SKU でサポートされているリソースの種類。
locationInfo	ApiManagementSkuLocationInfo[]	SKU が使用可能な場所の場所と可用性ゾーンの一覧。
locations	string[]	SKU が使用可能な場所のセット。
name	string	SKU の名前。
resourceType	string	SKU が適用されるリソースの種類。
restrictions	ApiManagementSkuRestrictions[]	SKU を使用できないための制限。 制限がない場合、これは空です。
size	string	SKU のサイズ。
tier	string	スケール セット内の仮想マシンの層を指定します。 有効値は次のとおりです。 Standard Basic

ApiManagementSkuCapabilities

SKU 機能オブジェクトについて説明します。

名前	型	説明
name	string	機能を記述するための不変。
value	string	特徴量が数量で測定される場合は不変です。

ApiManagementSkuCapacity

SKU のスケーリング情報について説明します。

名前	型	説明
default	integer	既定の容量。
maximum	integer	設定できる最大容量。
minimum	integer	最小容量。
scaleType	ApiManagementSkuCapacityScaleType	SKU に適用できるスケールの種類。

ApiManagementSkuCapacityScaleType

SKU に適用できるスケールの種類。

名前	型	説明
Automatic	string
Manual	string
None	string

ApiManagementSkuCosts

価格情報を取得するためのメタデータについて説明します。

名前	型	説明
extendedUnit	string	拡張単位を表示するインバリアント。
meterID	string	コマースから価格を照会するために使用されます。
quantity	integer	基準従量制課金コストを拡張するには、乗数が必要です。

ApiManagementSkuLocationInfo

名前	型	説明
location	string	SKU の場所
zoneDetails	ApiManagementSkuZoneDetails[]	特定のゾーンの SKU で使用できる機能の詳細。
zones	string[]	SKU がサポートされている可用性ゾーンの一覧。

ApiManagementSkuRestrictionInfo

名前	型	説明
locations	string[]	SKU が制限されている場所
zones	string[]	SKU が制限されている可用性ゾーンの一覧。

ApiManagementSkuRestrictions

SKU のスケーリング情報について説明します。

名前	型	説明
reasonCode	ApiManagementSkuRestrictionsReasonCode	制限の理由。
restrictionInfo	ApiManagementSkuRestrictionInfo	SKU を使用できない制限に関する情報。
type	ApiManagementSkuRestrictionsType	制限の種類。
values	string[]	制限の値。 制限の種類が location に設定されている場合。 これは、SKU が制限されている別の場所になります。

ApiManagementSkuRestrictionsReasonCode

制限の理由。

名前	型	説明
NotAvailableForSubscription	string
QuotaId	string

ApiManagementSkuRestrictionsType

制限の種類。

名前	型	説明
Location	string
Zone	string

ApiManagementSkusResult

リソース SKU の一覧表示操作の応答。

名前	型	説明
nextLink	string	Resource Sku の次のページをフェッチする URI。 この URI で ListNext() を呼び出して、Resource Sku の次のページをフェッチします
value	ApiManagementSku[]	サブスクリプションで使用できる SKU の一覧。

ApiManagementSkuZoneDetails

SKU のゾーン機能について説明します。

名前	型	説明
capabilities	ApiManagementSkuCapabilities[]	指定したゾーンの一覧の SKU で使用できる機能の一覧。
name	string[]	指定した機能を使用して SKU が使用できるゾーンのセット。

ErrorFieldContract

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。