Microsoft.Quota (preview:2024-12-18)

2024/12/19 • 9 new methods

Usages_Get (new)
Description Get the current usage of a resource.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Quota/usages/{resourceName}
{
resourceName: string ,
api-version: string ,
scope: string ,
}

⚐ Response (200)

{
$headers:
{
etag: string ,
}
,
$schema:
{
id: string ,
type: string ,
name: string ,
properties:
{
usages:
{
value: integer ,
usagesType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
Usages_List (new)
Description Get a list of current usage for all resources for the scope specified.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Quota/usages
{
api-version: string ,
scope: string ,
}

⚐ Response (200)

{
$headers:
{
etag: string ,
}
,
$schema:
{
value:
[
{
id: string ,
type: string ,
name: string ,
properties:
{
usages:
{
value: integer ,
usagesType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
Quota_Get (new)
Description Get the quota limit of a resource. The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Quota/quotas/{resourceName}
{
resourceName: string ,
api-version: string ,
scope: string ,
}

⚐ Response (200)

{
$headers:
{
etag: string ,
}
,
$schema:
{
id: string ,
type: string ,
name: string ,
properties:
{
limit:
{
limitObjectType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
Quota_CreateOrUpdate (new)
Description 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](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.
Reference Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Quota/quotas/{resourceName}
{
resourceName: string ,
api-version: string ,
scope: string ,
createQuotaRequest:
{
id: string ,
type: string ,
name: string ,
properties:
{
limit:
{
limitObjectType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}
,
}

⚐ Response (200)

{
id: string ,
type: string ,
name: string ,
properties:
{
limit:
{
limitObjectType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
Quota_Update (new)
Description Update the quota limit for a specific resource to the specified value: 1. Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.
Reference Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.Quota/quotas/{resourceName}
{
resourceName: string ,
api-version: string ,
scope: string ,
createQuotaRequest:
{
id: string ,
type: string ,
name: string ,
properties:
{
limit:
{
limitObjectType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}
,
}

⚐ Response (200)

{
id: string ,
type: string ,
name: string ,
properties:
{
limit:
{
limitObjectType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
Quota_List (new)
Description Get a list of current quota limits of all resources for the specified scope. The response from this GET operation can be leveraged to submit requests to update a quota.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Quota/quotas
{
api-version: string ,
scope: string ,
}

⚐ Response (200)

{
$headers:
{
etag: string ,
}
,
$schema:
{
value:
[
{
id: string ,
type: string ,
name: string ,
properties:
{
limit:
{
limitObjectType: enum ,
}
,
unit: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
quotaPeriod: string ,
isQuotaApplicable: boolean ,
properties: object ,
}
,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
QuotaRequestStatus_Get (new)
Description Get the quota request details and status by quota request ID for the resources of the resource provider at a specific location. The quota request ID **id** is returned in the response of the PUT operation.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Quota/quotaRequests/{id}
{
id: string ,
api-version: string ,
scope: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
properties:
{
provisioningState: enum ,
message: string ,
error:
{
code: string ,
message: string ,
}
,
requestSubmitTime: string ,
value:
[
{
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
unit: string ,
provisioningState: enum ,
message: string ,
subRequestId: string ,
limit:
{
limitObjectType: enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
QuotaRequestStatus_List (new)
Description For the specified scope, get the current quota requests for a one year period ending at the time is made. Use the **oData** filter to select quota requests.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Quota/quotaRequests
{
api-version: string ,
scope: string ,
$filter: string ,
$top: integer ,
$skiptoken: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
properties:
{
provisioningState: enum ,
message: string ,
error:
{
code: string ,
message: string ,
}
,
requestSubmitTime: string ,
value:
[
{
name:
{
value: string ,
localizedValue: string ,
}
,
resourceType: string ,
unit: string ,
provisioningState: enum ,
message: string ,
subRequestId: string ,
limit:
{
limitObjectType: enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}
QuotaOperation_List (new)
Description List all the operations supported by the Microsoft.Quota resource provider.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Quota/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
details:
[
{
code: string ,
message: string ,
}
,
]
,
}
,
}