Check Dns Name Availability

Service:
Virtual Networks
API Version:
2017-09-01

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={api-version}

URI Parameters

Name In Required Type Description
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.
location
 path True
  • string

The location of the domain name.
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]$.
api-version
 query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Request successful. Returns whether the DNS name is available.

Media Types: "application/json", "text/json"

Examples

Check Dns Name Availability

Sample Request

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

Sample Response

Status code:
200 
{
  "available": false
}

Definitions

Name Type Description
available
  • boolean

Domain availability (True/False).