Sign in

v5

latestSwagger 2.02026-07-13202858.8 KB
B2CTenants
CIAMTenants

Checks the availability and validity of a domain name for the tenant.

post/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/checkNameAvailability

Path parameters

subscriptionIdstring required

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

Query parameters

api-versionstring required

Version of the API to be used with the client request.

Request body

namestring required

The sub domain name to check for availability.

countryCodestring required

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

Response

The result of checking for the name availability.

messagestring

Description of the reason if name is not available.

nameAvailableboolean

True if the name is available and can be used to create a new tenant. Otherwise false.

reason'AlreadyExists' | 'Invalid'

Describes the reason for the 'nameAvailable' value.

All 20 operations