API Management サービスで使用可能な SKU を取得します
特定のAPI Management サービスで使用可能なすべての 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 Management サービスの名前。
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
ターゲット サブスクリプションの ID。
|
api-version
|
query |
True
|
string
|
この操作に使用する API バージョン。
|
応答
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 |
説明 |
user_impersonation
|
ユーザー アカウントの借用
|
例
ApiManagementListSKUs-Consumption
Sample Request
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
Sample Response
{
"value": [
{
"resourceType": "Microsoft.ApiManagement/service",
"sku": {
"name": "Consumption"
},
"capacity": null
}
],
"nextLink": null
}
ApiManagementListSKUs-Dedicated
Sample Request
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
Sample Response
{
"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
エラー フィールド コントラクト。
名前 |
型 |
説明 |
code
|
string
|
プロパティ レベルのエラー コード。
|
message
|
string
|
プロパティ レベルエラーの人間が判読できる表現。
|
target
|
string
|
プロパティ名。
|
ErrorResponse
エラー応答。
名前 |
型 |
説明 |
error.code
|
string
|
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
|
error.details
|
ErrorFieldContract[]
|
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
|
error.message
|
string
|
人が判読できるエラーの表現。
|
ResourceSku
使用可能なAPI Management SKU について説明します。
ResourceSkuCapacity
SKU のスケーリング情報について説明します。
ResourceSkuCapacityScaleType
SKU に適用できるスケールの種類。
名前 |
型 |
説明 |
automatic
|
string
|
サポートされているスケールの種類は自動です。
|
manual
|
string
|
サポートされているスケールの種類の手動。
|
none
|
string
|
スケーリングはサポートされていません。
|
ResourceSkuResult
使用可能なAPI Managementサービス SKU について説明します。
ResourceSkuResults
API Management サービス SKU 操作応答。
名前 |
型 |
説明 |
nextLink
|
string
|
API Management サービス SKU の次のページをフェッチする URI。
|
value
|
ResourceSkuResult[]
|
サービスで使用できる SKU の一覧。
|
SkuType
Sku の名前。
名前 |
型 |
説明 |
Basic
|
string
|
Api Management の基本 SKU。
|
Consumption
|
string
|
Api Management の従量課金 SKU。
|
Developer
|
string
|
Api Management の開発者 SKU。
|
Isolated
|
string
|
Api Management の分離された SKU。
|
Premium
|
string
|
Api Management の Premium SKU。
|
Standard
|
string
|
Api Management の Standard SKU。
|