Sign in
StorageAccounts

Checks that the storage account name is valid and is not already in use.

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

Parameters

../../../../../common-types/resource-management/v1/types.json#/components/parameters/ApiVersionParameter — unresolved $ref
../../../../../common-types/resource-management/v1/types.json#/components/parameters/SubscriptionIdParameter — unresolved $ref

Request body

namestring required

The storage account name.

type'Microsoft.Storage/storageAccounts' required

The type of resource, Microsoft.Storage/storageAccounts

Response

OK -- Operation to check the storage account name availability was successful.

nameAvailableboolean

Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.

reason'AccountNameInvalid' | 'AlreadyExists'

Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.

messagestring

Gets an error message explaining the Reason value in more detail.

Changes

No recorded changes to this endpoint across all 14 revisions of this API.