Endpoints - List Resource Usage

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=2024-02-01

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

Name of the Resource group within the Azure subscription.

Regex pattern: ^[-\w\._\(\)]+$

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 2024-02-01.

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/checkResourceUsage?api-version=2024-02-01

Sample response

{
  "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

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

ResourceUsage

Output of check resource usage API.

Name Type Description
currentValue

integer

Actual value of usage on the specified resource type.

limit

integer

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

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

Unit of the usage. e.g. count.

Name Type Description
count

string