Api Management Service Skus - List Available Service Skus

Service:

API Management

API Version:

2024-05-01

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=2024-05-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 uuid	The ID of the target subscription. The value must be an UUID.
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

ApiManagementListSKUs-Dedicated

ApiManagementListSKUs-Consumption

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/skus?api-version=2024-05-01

Sample response

Status code:

200

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

ApiManagementListSKUs-Dedicated

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/skus?api-version=2024-05-01

Sample response

Status code:

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
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ResourceSku	Describes an available API Management SKU.
ResourceSkuCapacity	Describes scaling information of a SKU.
ResourceSkuCapacityScaleType	The scale type applicable to the sku.
ResourceSkuResult	Describes an available API Management service SKU.
ResourceSkuResults	The API Management service SKUs operation response.
SkuType	Name of the Sku.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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.
BasicV2	string	BasicV2 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.
StandardV2	string	StandardV2 SKU of Api Management.