Rule Sets - List Resource Usage

Service:

Front Door Service

API Version:

2025-04-15

Checks the quota and actual usage of endpoints under the given Azure Front Door profile..

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages?api-version=2025-04-15

URI Parameters

Name	In	Required	Type	Description
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Name of the Resource group within the Azure subscription.
ruleSetName	path	True	string	Name of the rule set under the profile which is unique globally.
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2025-04-15.

Responses

Name	Type	Description
200 OK	UsagesListResult	OK. The request has succeeded.
Other Status Codes	AfdErrorResponse	Azure Front Door 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

RuleSets_ListResourceUsage

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1/usages?api-version=2025-04-15

Sample response

Status code:

200

{
  "value": [
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": 25,
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1",
      "name": {
        "value": "rule",
        "localizedValue": "rule"
      }
    }
  ]
}

Definitions

Name	Description
AfdErrorResponse	Error response
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
Usage	Describes resource usage.
UsageName	The usage names.
UsagesListResult	The list usages operation response.
UsageUnit	An enum describing the unit of measurement.

AfdErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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.

Usage

Object

Describes resource usage.

Name	Type	Description
currentValue	integer (int64)	The current value of the usage.
id	string	Resource identifier.
limit	integer (int64)	The limit of usage.
name	UsageName	The name of the type of usage.
unit	UsageUnit	An enum describing the unit of measurement.

UsageName

Object

The usage names.

Name	Type	Description
localizedValue	string	A localized string describing the resource name.
value	string	A string describing the resource name.

UsagesListResult

Object

The list usages operation response.

Name	Type	Description
nextLink	string	URL to get the next set of results.
value	Usage[]	The list of resource usages.

UsageUnit

Enumeration

An enum describing the unit of measurement.

Value	Description
Count