Gets available SKUs for API Management service
Gets all available SKU for a given API Management service
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus?api-version=2022-08-01
URI Parameters
Name |
In |
Required |
Type |
Description |
resourceGroupName
|
path |
True
|
string
|
The name of the resource group. The name is case insensitive.
|
serviceName
|
path |
True
|
string
|
The name of the API Management service.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Responses
Name |
Type |
Description |
200 OK
|
ResourceSkuResults
|
Success. The response describes the list of SKUs.
|
Other Status Codes
|
ErrorResponse
|
Error response describing why the operation failed.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
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
}
Definitions
ErrorFieldContract
Error Field contract.
Name |
Type |
Description |
code
|
string
|
Property level error code.
|
message
|
string
|
Human-readable representation of property-level error.
|
target
|
string
|
Property name.
|
ErrorResponse
Error Response.
Name |
Type |
Description |
error.code
|
string
|
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
|
error.details
|
ErrorFieldContract[]
|
The list of invalid fields send in request, in case of validation error.
|
error.message
|
string
|
Human-readable representation of the error.
|
ResourceSku
Describes an available API Management SKU.
Name |
Type |
Description |
name
|
SkuType
|
Name of the Sku.
|
ResourceSkuCapacity
Describes scaling information of a SKU.
Name |
Type |
Description |
default
|
integer
|
The default capacity.
|
maximum
|
integer
|
The maximum capacity that can be set.
|
minimum
|
integer
|
The minimum capacity.
|
scaleType
|
ResourceSkuCapacityScaleType
|
The scale type applicable to the sku.
|
ResourceSkuCapacityScaleType
The scale type applicable to the sku.
Name |
Type |
Description |
automatic
|
string
|
Supported scale type automatic.
|
manual
|
string
|
Supported scale type manual.
|
none
|
string
|
Scaling not supported.
|
ResourceSkuResult
Describes an available API Management service SKU.
Name |
Type |
Description |
capacity
|
ResourceSkuCapacity
|
Specifies the number of API Management units.
|
resourceType
|
string
|
The type of resource the SKU applies to.
|
sku
|
ResourceSku
|
Specifies API Management SKU.
|
ResourceSkuResults
The API Management service SKUs operation response.
Name |
Type |
Description |
nextLink
|
string
|
The uri to fetch the next page of API Management service Skus.
|
value
|
ResourceSkuResult[]
|
The list of skus available for the service.
|
SkuType
Name of the Sku.
Name |
Type |
Description |
Basic
|
string
|
Basic SKU of Api Management.
|
Consumption
|
string
|
Consumption SKU of Api Management.
|
Developer
|
string
|
Developer SKU of Api Management.
|
Isolated
|
string
|
Isolated SKU of Api Management.
|
Premium
|
string
|
Premium SKU of Api Management.
|
Standard
|
string
|
Standard SKU of Api Management.
|