Check Dns Name Availability - Check Dns Name Availability

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability?domainNameLabel={domainNameLabel}&api-version=2021-03-01

URI Parameters

Name In Required Type Description
location
path True
  • string

The location of the domain name.

subscriptionId
path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client API version.

domainNameLabel
query True
  • string

The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.

Responses

Name Type Description
200 OK

Request successful. Returns whether the DNS name is available.

Other Status Codes

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

Check Dns Name Availability

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/CheckDnsNameAvailability?domainNameLabel=testdns&api-version=2021-03-01

Sample Response

{
  "available": false
}

Definitions

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

DnsNameAvailabilityResult

Response for the CheckDnsNameAvailability API service call.

CloudError

An error response from the service.

Name Type Description
error

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.

DnsNameAvailabilityResult

Response for the CheckDnsNameAvailability API service call.

Name Type Description
available
  • boolean

Domain availability (True/False).