Api Management Gateway Skus - List Available Skus

Reference

Service:: API Management

API Version:: 2024-05-01

Gets available SKUs for API Management gateway
Gets all available SKU for a given API Management gateway

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/skus?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
gatewayName	path	True	string	The name of the API Management gateway. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
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	GatewayResourceSkuResults	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-Gateways

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "value": [
    {
      "resourceType": "Microsoft.ApiManagement/gateways",
      "sku": {
        "name": "WorkspaceGatewayStandard"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "Manual"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/gateways",
      "sku": {
        "name": "WorkspaceGatewayPremium"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 12,
        "default": 1,
        "scaleType": "Manual"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
ApiGatewaySkuType	Name of the Sku.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GatewayResourceSkuResult	Describes an available API Management gateway SKU.
GatewayResourceSkuResults	The API Management gateway SKUs operation response.
GatewaySku	Describes an available API Management SKU for gateways.
GatewaySkuCapacity	Describes scaling information of a SKU.
GatewaySkuCapacityScaleType	The scale type applicable to the sku.

ApiGatewaySkuType

Name of the Sku.

Name	Type	Description
Standard	string	Standard SKU of the API gateway.
WorkspaceGatewayPremium	string	Premium SKU of the API gateway to be used in Workspaces.
WorkspaceGatewayStandard	string	Standard SKU of the API gateway to be used in Workspaces.

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.

GatewayResourceSkuResult

Describes an available API Management gateway SKU.

Name	Type	Description
capacity	GatewaySkuCapacity	Specifies the number of API Management gateway units.
resourceType	string	The type of resource the SKU applies to.
sku	GatewaySku	Specifies API Management gateway SKU.

GatewayResourceSkuResults

The API Management gateway SKUs operation response.

Name	Type	Description
nextLink	string	The uri to fetch the next page of API Management gateway Skus.
value	GatewayResourceSkuResult[]	The list of skus available for the gateway.

GatewaySku

Describes an available API Management SKU for gateways.

Name	Type	Description
name	ApiGatewaySkuType	Name of the Sku.

GatewaySkuCapacity

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	GatewaySkuCapacityScaleType	The scale type applicable to the sku.

GatewaySkuCapacityScaleType

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.

Share via