Sign in

v1

latestSwagger 2.02026-07-13172340.3 KB

Check if a resource name is available.

Check if a resource name is available.

post/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability

Path parameters

subscriptionIdstring required

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

Query parameters

api-versionstring required

API Version

Request body

namestring required

Resource name to verify.

type'Site' | 'Slot' | 'HostingEnvironment' | 'PublishingUser' | 'Microsoft.Web/sites' | 'Microsoft.Web/sites/slots' | 'Microsoft.Web/hostingEnvironments' | 'Microsoft.Web/publishingUsers' required

Resource type used for verification.

isFqdnboolean

Is fully qualified domain name.

Response

OK

nameAvailableboolean

<code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.

reason'Invalid' | 'AlreadyExists'

<code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.

messagestring

If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.