Endpoints - List Resource Usage

Service:

CDN

API Version:

2025-04-15

Checks the quota and usage of geo filters and custom domains under the given endpoint.

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

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	Name of the endpoint under the profile which is unique globally.
profileName	path	True	string	Name of the CDN profile which is unique within the resource group.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ResourceUsageListResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	CDN 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

Endpoints_ListResourceUsage

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/checkResourceUsage?api-version=2025-04-15

Sample response

Status code:

200

{
  "value": [
    {
      "resourceType": "customdomain",
      "unit": "count",
      "currentValue": 1,
      "limit": 20
    },
    {
      "resourceType": "geofilter",
      "unit": "count",
      "currentValue": 0,
      "limit": 25
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ResourceUsage	Output of check resource usage API.
ResourceUsageListResult	Output of check resource usage API.
ResourceUsageUnit	Unit of the usage. e.g. count.

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.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ResourceUsage

Object

Output of check resource usage API.

Name	Type	Description
currentValue	integer (int32)	Actual value of usage on the specified resource type.
limit	integer (int32)	Quota of the specified resource type.
resourceType	string	Resource type for which the usage is provided.
unit	ResourceUsageUnit	Unit of the usage. e.g. count.

ResourceUsageListResult

Object

Output of check resource usage API.

Name	Type	Description
nextLink	string	URL to get the next set of custom domain objects if there are any.
value	ResourceUsage[]	List of resource usages.

ResourceUsageUnit

Enumeration

Unit of the usage. e.g. count.

Value	Description
count