Quota - List

Gets a list of current quotas (service limits) and usage for all resources. The response from the list quota operation can be leveraged to request quota updates.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimits?api-version=2020-10-25

URI Parameters

Name In Required Type Description
location
path True

string

Azure region.

providerId
path True

string

Azure resource provider ID.

subscriptionId
path True

string

Azure subscription ID.

api-version
query True

string

API version.

Responses

Name Type Description
200 OK

QuotaLimits

OK. Returns the paginated quota information.

Headers

ETag: string

Other Status Codes

ExceptionResponse

Error description in the response.

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

Quotas_listUsagesForCompute
Quotas_listUsagesMachineLearningServices

Quotas_listUsagesForCompute

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits?api-version=2020-10-25

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardFSv2Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 100,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardFSv2Family",
          "localizedValue": "Standard FSv2 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardNDSFamily",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 0,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardNDSFamily",
          "localizedValue": "Standard NDS Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardNCSv2Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 0,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardNCSv2Family",
          "localizedValue": "Standard NCSv2 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardNCSv3Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 0,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardNCSv3Family",
          "localizedValue": "Standard NCSv3 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardLSv2Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 100,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardLSv2Family",
          "localizedValue": "Standard LSv2 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardPBSFamily",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 6,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardPBSFamily",
          "localizedValue": "Standard PBS Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardEIv3Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 100,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardEIv3Family",
          "localizedValue": "Standard EIv3 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardEISv3Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 100,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardEISv3Family",
          "localizedValue": "Standard EISv3 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardDCSFamily",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 8,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardDCSFamily",
          "localizedValue": "Standard DCS Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardNVSv2Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 0,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardNVSv2Family",
          "localizedValue": "Standard NVSv2 Family vCPUs"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardMSv2Family",
      "name": "standardNDSFamily",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "limit": 0,
        "unit": "Count",
        "currentValue": 0,
        "name": {
          "value": "standardMSv2Family",
          "localizedValue": "Standard MSv2 Family vCPUs"
        }
      }
    }
  ],
  "nextLink": ""
}

Quotas_listUsagesMachineLearningServices

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimits?api-version=2020-10-25

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimits/standardDv2Family",
      "name": "standardDv2Family",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "currentValue": 15,
        "limit": 20,
        "name": {
          "value": "standardDv2Family",
          "localizedValue": "Standard Dv2 Family vCPUs"
        },
        "resourceType": "dedicated"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimits/totalLowPriorityCores",
      "name": "totalLowPriorityCores",
      "type": "Microsoft.Capacity/ServiceLimits",
      "properties": {
        "currentValue": 49,
        "limit": 600,
        "name": {
          "value": "totalLowPriorityCores",
          "localizedValue": "Total Regional Low-priority vCPUs"
        },
        "resourceType": "lowPriority"
      }
    }
  ]
}

Definitions

Name Description
CurrentQuotaLimitBase

Quota properties.

ExceptionResponse

The API error.

QuotaLimits

Quota limits.

QuotaProperties

Quota properties for the resource.

ResourceName

Resource name provided by the resource provider. Use this property for quotaRequest parameter.

ResourceType

The name of the resource type.

ServiceError

The API error details.

ServiceErrorDetail

The error details.

CurrentQuotaLimitBase

Quota properties.

Name Type Description
id

string

The quota request ID.

name

string

The name of the quota request.

properties

QuotaProperties

Quota properties for the resource.

type

string

Type of resource. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

The API error.

Name Type Description
error

ServiceError

The API error details.

QuotaLimits

Quota limits.

Name Type Description
nextLink

string

The URI for fetching the next page of quotas (service limits). When no more pages exist, the value is null.

value

CurrentQuotaLimitBase[]

List of quotas (service limits).

QuotaProperties

Quota properties for the resource.

Name Type Description
currentValue

integer

Current usage value for the resource.

limit

integer

Quota properties.

name

ResourceName

Name of the resource provide by the resource provider. Use this property for quotaRequests resource operations.

properties

object

Additional properties for the specified resource provider.

quotaPeriod

string

The time period over which the quota usage values are summarized. For example, P1D (per one day), PT1M (per one minute), and PT1S (per one second). This parameter is optional because, for some resources such as compute, the time period is irrelevant.

resourceType

ResourceType

The name of the resource type.

unit

string

The limit units, such as count and bytes. Use the unit field provided in the response of the GET quota operation.

ResourceName

Resource name provided by the resource provider. Use this property for quotaRequest parameter.

Name Type Description
localizedValue

string

Resource display localized name.

value

string

Resource name.

ResourceType

The name of the resource type.

Name Type Description
dedicated

string

lowPriority

string

serviceSpecific

string

shared

string

standard

string

ServiceError

The API error details.

Name Type Description
code

string

The error code.

details

ServiceErrorDetail[]

The list of error details.

message

string

The error message text.

ServiceErrorDetail

The error details.

Name Type Description
code

string

The error code.

message

string

The error message.