Api Management Skus - List
Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus?api-version=2022-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
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 |
OK |
|
Other Status Codes |
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
Lists all available Resource SKUs
Sample request
Sample response
{
"value": [
{
"resourceType": "service",
"name": "Developer",
"locations": [
"centralindia"
],
"locationInfo": [
{
"location": "centralindia",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 1,
"default": 1,
"scaleType": "None"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Standard",
"locations": [
"centralindia"
],
"locationInfo": [
{
"location": "centralindia",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 4,
"default": 1,
"scaleType": "Automatic"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Premium",
"locations": [
"centralindia"
],
"locationInfo": [
{
"location": "centralindia",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 10,
"default": 1,
"scaleType": "Automatic"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Basic",
"locations": [
"centralindia"
],
"locationInfo": [
{
"location": "centralindia",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 2,
"default": 1,
"scaleType": "Manual"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Consumption",
"locations": [
"centralindia"
],
"locationInfo": [
{
"location": "centralindia",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 0,
"maximum": 0,
"default": 0,
"scaleType": "None"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Developer",
"locations": [
"uaenorth"
],
"locationInfo": [
{
"location": "uaenorth",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 1,
"default": 1,
"scaleType": "None"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Standard",
"locations": [
"uaenorth"
],
"locationInfo": [
{
"location": "uaenorth",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 4,
"default": 1,
"scaleType": "Automatic"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Premium",
"locations": [
"uaenorth"
],
"locationInfo": [
{
"location": "uaenorth",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 10,
"default": 1,
"scaleType": "Automatic"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Basic",
"locations": [
"uaenorth"
],
"locationInfo": [
{
"location": "uaenorth",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 2,
"default": 1,
"scaleType": "Manual"
},
"restrictions": []
},
{
"resourceType": "service",
"name": "Developer",
"locations": [
"australiacentral"
],
"locationInfo": [
{
"location": "australiacentral",
"zones": [],
"zoneDetails": []
}
],
"capacity": {
"minimum": 1,
"maximum": 1,
"default": 1,
"scaleType": "None"
},
"restrictions": []
}
]
}
Definitions
Name | Description |
---|---|
Api |
Describes an available ApiManagement SKU. |
Api |
Describes The SKU capabilities object. |
Api |
Describes scaling information of a SKU. |
Api |
The scale type applicable to the sku. |
Api |
Describes metadata for retrieving price info. |
Api |
|
Api |
|
Api |
Describes scaling information of a SKU. |
Api |
The reason for restriction. |
Api |
The type of restrictions. |
Api |
The List Resource Skus operation response. |
Api |
Describes The zonal capabilities of a SKU. |
Error |
Error Field contract. |
Error |
Error Response. |
ApiManagementSku
Describes an available ApiManagement SKU.
Name | Type | Description |
---|---|---|
apiVersions |
string[] |
The api versions that support this SKU. |
capabilities |
A name value pair to describe the capability. |
|
capacity |
Specifies the number of virtual machines in the scale set. |
|
costs |
Metadata for retrieving price info. |
|
family |
string |
The Family of this particular SKU. |
kind |
string |
The Kind of resources that are supported in this SKU. |
locationInfo |
A list of locations and availability zones in those locations where the SKU is available. |
|
locations |
string[] |
The set of locations that the SKU is available. |
name |
string |
The name of SKU. |
resourceType |
string |
The type of resource the SKU applies to. |
restrictions |
The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. |
|
size |
string |
The Size of the SKU. |
tier |
string |
Specifies the tier of virtual machines in a scale set. |
ApiManagementSkuCapabilities
Describes The SKU capabilities object.
Name | Type | Description |
---|---|---|
name |
string |
An invariant to describe the feature. |
value |
string |
An invariant if the feature is measured by quantity. |
ApiManagementSkuCapacity
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 |
The scale type applicable to the sku. |
ApiManagementSkuCapacityScaleType
The scale type applicable to the sku.
Name | Type | Description |
---|---|---|
Automatic |
string |
|
Manual |
string |
|
None |
string |
ApiManagementSkuCosts
Describes metadata for retrieving price info.
Name | Type | Description |
---|---|---|
extendedUnit |
string |
An invariant to show the extended unit. |
meterID |
string |
Used for querying price from commerce. |
quantity |
integer |
The multiplier is needed to extend the base metered cost. |
ApiManagementSkuLocationInfo
Name | Type | Description |
---|---|---|
location |
string |
Location of the SKU |
zoneDetails |
Details of capabilities available to a SKU in specific zones. |
|
zones |
string[] |
List of availability zones where the SKU is supported. |
ApiManagementSkuRestrictionInfo
Name | Type | Description |
---|---|---|
locations |
string[] |
Locations where the SKU is restricted |
zones |
string[] |
List of availability zones where the SKU is restricted. |
ApiManagementSkuRestrictions
Describes scaling information of a SKU.
Name | Type | Description |
---|---|---|
reasonCode |
The reason for restriction. |
|
restrictionInfo |
The information about the restriction where the SKU cannot be used. |
|
type |
The type of restrictions. |
|
values |
string[] |
The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. |
ApiManagementSkuRestrictionsReasonCode
The reason for restriction.
Name | Type | Description |
---|---|---|
NotAvailableForSubscription |
string |
|
QuotaId |
string |
ApiManagementSkuRestrictionsType
The type of restrictions.
Name | Type | Description |
---|---|---|
Location |
string |
|
Zone |
string |
ApiManagementSkusResult
The List Resource Skus operation response.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus |
value |
The list of skus available for the subscription. |
ApiManagementSkuZoneDetails
Describes The zonal capabilities of a SKU.
Name | Type | Description |
---|---|---|
capabilities |
A list of capabilities that are available for the SKU in the specified list of zones. |
|
name |
string[] |
The set of zones that the SKU is available in with the specified capabilities. |
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 |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |