Check Name Availability

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

POST https://management.azure.com/providers/Microsoft.Cdn/checkNameAvailability?api-version={api-version}

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string
Azure Subscription ID.
resourceGroupName
path True
  • string
Name of the Resource group within the Azure subscription.

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

api-version
query True
  • string

Version of the API to be used with the client request. Current version is 2016-10-02.

Request Body

Name Required Type Description
name True
  • string

The resource name to validate.

type True
  • enum:
    • Microsoft.Cdn/Profiles/Endpoints

The type of the resource whose name is to be validated.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

Other Status Codes

CDN error response describing why the operation failed.

Definitions

CheckNameAvailabilityOutput
ErrorResponse
Name Type Description
message
  • string

The detailed error message describing why the name is not available.

nameAvailable
  • boolean

Indicates whether the name is available.

reason
  • string

The reason why the name is not available.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.