Quota - Create Or Update

Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps:

  1. Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in this example.
  2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.
PUT https://management.azure.com/{scope}/providers/Microsoft.Quota/quotas/{resourceName}?api-version=2023-02-01

URI Parameters

Name In Required Type Description
resourceName
path True

string

Resource name for a given resource provider. For example:

  • SKU name for Microsoft.Compute
  • SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices

For Microsoft.Network PublicIPAddresses.

scope
path True

string

The target Azure resource URI. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/. This is the target Azure resource URI for the List GET operation. If a {resourceName} is added after /quotas, then it's the target Azure resource URI in the GET operation for the specific resource.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
properties

QuotaProperties

Quota properties for the specified resource, based on the API called, Quotas or Usages.

Responses

Name Type Description
200 OK

CurrentQuotaLimitBase

OK. Returns the quota request details.

202 Accepted

The request is accepted and is being processed. To check the status for this request, use the value for the quota request ID id obtained in the response of a Quota Request Status GET operation.

Other Status Codes

ExceptionResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth 2.0 authorization

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Impersonate your user account.

Examples

Quotas_Put_Request_ForCompute
Quotas_PutRequest_ForNetwork
Quotas_PutRequest_ForNetwork_StandardSkuPublicIpAddressesResource
Quotas_Request_ForMachineLearningServices_LowPriorityResource

Quotas_Put_Request_ForCompute

Sample Request

PUT https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotas/standardFSv2Family?api-version=2023-02-01

{
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "standardFSv2Family"
    }
  }
}

Sample Response

Retry-After: 30
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
{
  "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotas/standardFSv2Family",
  "type": "Microsoft.Quota/quotas",
  "name": "standardFSv2Family",
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "standardFSv2Family"
    }
  }
}

Quotas_PutRequest_ForNetwork

Sample Request

PUT https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/quotas/MinPublicIpInterNetworkPrefixLength?api-version=2023-02-01

{
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "MinPublicIpInterNetworkPrefixLength"
    },
    "resourceType": "MinPublicIpInterNetworkPrefixLength"
  }
}

Sample Response

Retry-After: 30
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
{
  "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "type": "Microsoft.Quota/quotas",
  "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "MinPublicIpInterNetworkPrefixLength"
    },
    "resourceType": "MinPublicIpInterNetworkPrefixLength"
  }
}

Quotas_PutRequest_ForNetwork_StandardSkuPublicIpAddressesResource

Sample Request

PUT https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/quotas/StandardSkuPublicIpAddresses?api-version=2023-02-01

{
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "StandardSkuPublicIpAddresses"
    },
    "resourceType": "PublicIpAddresses"
  }
}

Sample Response

Retry-After: 30
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/quotaRequest/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
{
  "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Network/locations/eastus/providers/Microsoft.Quota/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "type": "Microsoft.Quota/quotas",
  "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "StandardSkuPublicIpAddresses"
    },
    "resourceType": "PublicIpAddresses"
  }
}

Quotas_Request_ForMachineLearningServices_LowPriorityResource

Sample Request

PUT https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotas/TotalLowPriorityCores?api-version=2023-02-01

{
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "TotalLowPriorityCores"
    },
    "resourceType": "lowPriority"
  }
}

Sample Response

Retry-After: 30
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
location: https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2023-02-01
{
  "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotas/TotalLowPriorityCores",
  "type": "Microsoft.Quota/quotas",
  "name": "TotalLowPriorityCores",
  "properties": {
    "limit": {
      "limitObjectType": "LimitValue",
      "value": 10
    },
    "name": {
      "value": "TotalLowPriorityCores"
    },
    "resourceType": "lowPriority"
  }
}

Definitions

Name Description
CurrentQuotaLimitBase

Quota limit.

ExceptionResponse

Error.

LimitObject

The resource quota limit value.

quotaLimitTypes

The quota or usages limit types.

QuotaProperties

Quota properties for the specified resource.

ResourceName

Name of the resource provided by the resource Provider. When requesting quota, use this property name.

ServiceError

API error details.

ServiceErrorDetail

Error details.

CurrentQuotaLimitBase

Quota limit.

Name Type Description
id

string

The resource ID.

name

string

The resource name.

properties

QuotaProperties

Quota properties for the specified resource, based on the API called, Quotas or Usages.

type

string

The resource type.

ExceptionResponse

Error.

Name Type Description
error

ServiceError

API error details.

LimitObject

The resource quota limit value.

Name Type Description
limitObjectType string:

LimitValue

The limit object type.

limitType

quotaLimitTypes

The quota or usages limit types.

value

integer

The quota/limit value

quotaLimitTypes

The quota or usages limit types.

Name Type Description
Independent

string

Shared

string

QuotaProperties

Quota properties for the specified resource.

Name Type Description
isQuotaApplicable

boolean

States if quota can be requested for this resource.

limit LimitJsonObject:

LimitObject

Resource quota limit properties.

name

ResourceName

Resource name provided by the resource provider. Use this property name when requesting quota.

properties

object

Additional properties for the specific 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) *PT1S (per one second). This parameter is optional because, for some resources like compute, the period is irrelevant.

resourceType

string

The name of the resource type. Optional field.

unit

string

The quota units, such as Count and Bytes. When requesting quota, use the unit value returned in the GET response in the request body of your PUT operation.

ResourceName

Name of the resource provided by the resource Provider. When requesting quota, use this property name.

Name Type Description
localizedValue

string

Resource display name.

value

string

Resource name.

ServiceError

API error details.

Name Type Description
code

string

Error code.

details

ServiceErrorDetail[]

List of error details.

message

string

Error message.

ServiceErrorDetail

Error details.

Name Type Description
code

string

Error code.

message

string

Error message.