Sign in

v8

latestSwagger 2.0raw.githubusercontent.com2021-08-27243267.7 KB

Check resource name availability

Check if a resource name is available.

post/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/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.

locationstring required

The location

Query parameters

api-versionstring required

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

Request body

namestring required

Resource name to verify.

type'Microsoft.NetApp/netAppAccounts' | 'Microsoft.NetApp/netAppAccounts/capacityPools' | 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes' | 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots' required

Resource type used for verification.

resourceGroupstring required

Resource group name.

Response

OK

isAvailableboolean

<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.