你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Api Management Service Skus - List Available Service Skus

参考

服务:: API Management

API 版本:: 2022-08-01

获取API 管理服务的可用 SKU
获取给定API 管理服务的所有可用 SKU

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
serviceName	path	True	string	API 管理服务的名称。正则表达式模式: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ResourceSkuResults	成功。响应描述 SKU 列表。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementListSKUs-Consumption

ApiManagementListSKUs-Dedicated

ApiManagementListSKUs-Consumption

示例请求

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

/** Samples for ApiManagementServiceSkus ListAvailableServiceSkus. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Consumption.json
     */
    /**
     * Sample code: ApiManagementListSKUs-Consumption.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListSKUsConsumption(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServiceSkus()
            .listAvailableServiceSkus("rg1", "apimService1", 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

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_sk_us_consumption.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_service_skus.list_available_service_skus(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Consumption.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

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/ApiManagementListSKUs-Consumption.json
func ExampleServiceSKUsClient_NewListAvailableServiceSKUsPager_apiManagementListSkUsConsumption() {
	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.NewServiceSKUsClient().NewListAvailableServiceSKUsPager("rg1", "apimService1", 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.ResourceSKUResults = armapimanagement.ResourceSKUResults{
		// 	Value: []*armapimanagement.ResourceSKUResult{
		// 		{
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeConsumption),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets all available SKU for a given API Management service
 *
 * @summary Gets all available SKU for a given API Management service
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Consumption.json
 */
async function apiManagementListSkUsConsumption() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiManagementServiceSkus.listAvailableServiceSkus(
    resourceGroupName,
    serviceName
  )) {
    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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Consumption.json
// this example is just showing the usage of "ApiManagementServiceSkus_ListAvailableServiceSkus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (AvailableApiManagementServiceSkuResult item in apiManagementService.GetAvailableApiManagementServiceSkusAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Consumption"
      },
      "capacity": null
    }
  ],
  "nextLink": null
}

ApiManagementListSKUs-Dedicated

示例请求

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

/** Samples for ApiManagementServiceSkus ListAvailableServiceSkus. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Dedicated.json
     */
    /**
     * Sample code: ApiManagementListSKUs-Dedicated.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListSKUsDedicated(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServiceSkus()
            .listAvailableServiceSkus("rg1", "apimService1", 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

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_sk_us_dedicated.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_service_skus.list_available_service_skus(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Dedicated.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

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/ApiManagementListSKUs-Dedicated.json
func ExampleServiceSKUsClient_NewListAvailableServiceSKUsPager_apiManagementListSkUsDedicated() {
	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.NewServiceSKUsClient().NewListAvailableServiceSKUsPager("rg1", "apimService1", 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.ResourceSKUResults = armapimanagement.ResourceSKUResults{
		// 	Value: []*armapimanagement.ResourceSKUResult{
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](1),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeNone),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeDeveloper),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](2),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeManual),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeBasic),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](4),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeStandard),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](10),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypePremium),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](1),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeIsolated),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets all available SKU for a given API Management service
 *
 * @summary Gets all available SKU for a given API Management service
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Dedicated.json
 */
async function apiManagementListSkUsDedicated() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiManagementServiceSkus.listAvailableServiceSkus(
    resourceGroupName,
    serviceName
  )) {
    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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListSKUs-Dedicated.json
// this example is just showing the usage of "ApiManagementServiceSkus_ListAvailableServiceSkus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (AvailableApiManagementServiceSkuResult item in apiManagementService.GetAvailableApiManagementServiceSkusAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Developer"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "none"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Basic"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 2,
        "default": 1,
        "scaleType": "manual"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Standard"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "automatic"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Premium"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "automatic"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Isolated"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "automatic"
      }
    }
  ],
  "nextLink": null
}

定义

名称	说明
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。
ResourceSku	介绍可用的API 管理 SKU。
ResourceSkuCapacity	描述 SKU 的缩放信息。
ResourceSkuCapacityScaleType	适用于 SKU 的规模类型。
ResourceSkuResult	介绍可用的API 管理服务 SKU。
ResourceSkuResults	API 管理服务 SKU 操作响应。
SkuType	SKU 的名称。

ErrorFieldContract

错误字段协定。

名称	类型	说明
code	string	属性级错误代码。
message	string	属性级错误的可读表示形式。
target	string	属性名称。

ErrorResponse

错误响应。

名称	类型	说明
error.code	string	服务定义的错误代码。此代码用作响应中指定的 HTTP 错误代码的子状态。
error.details	ErrorFieldContract[]	在发生验证错误的情况下，在请求中发送的无效字段列表。
error.message	string	错误的用户可读表示形式。

ResourceSku

介绍可用的API 管理 SKU。

名称	类型	说明
name	SkuType	SKU 的名称。

ResourceSkuCapacity

描述 SKU 的缩放信息。

名称	类型	说明
default	integer	默认容量。
maximum	integer	可设置的最大容量。
minimum	integer	最小容量。
scaleType	ResourceSkuCapacityScaleType	适用于 SKU 的规模类型。

ResourceSkuCapacityScaleType

适用于 SKU 的规模类型。

名称	类型	说明
automatic	string	支持的缩放类型自动。
manual	string	支持的缩放类型手册。
none	string	不支持缩放。

ResourceSkuResult

介绍可用的API 管理服务 SKU。

名称	类型	说明
capacity	ResourceSkuCapacity	指定API 管理单位数。
resourceType	string	SKU 适用的资源类型。
sku	ResourceSku	指定API 管理 SKU。

ResourceSkuResults

API 管理服务 SKU 操作响应。

名称	类型	说明
nextLink	string	用于提取下一页API 管理服务 SKU 的 URI。
value	ResourceSkuResult[]	可用于服务的 SKU 列表。

SkuType

SKU 的名称。

名称	类型	说明
Basic	string	Api 管理的基本 SKU。
Consumption	string	Api 管理的消耗 SKU。
Developer	string	Api 管理的开发人员 SKU。
Isolated	string	Api 管理的独立 SKU。
Premium	string	Api 管理的高级 SKU。
Standard	string	Api 管理的标准 SKU。

通过

Api Management Service Skus - List Available Service Skus

URI 参数

响应

安全性

azure_auth

作用域

示例

ApiManagementListSKUs-Consumption

示例请求

示例响应

ApiManagementListSKUs-Dedicated

示例请求

示例响应

定义

ErrorFieldContract

ErrorResponse

ResourceSku

ResourceSkuCapacity

ResourceSkuCapacityScaleType

ResourceSkuResult

ResourceSkuResults

SkuType

其他资源