Sign in
StorageSyncService

Check the give namespace name availability.

post/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability

Path parameters

locationNamestring required

The desired region for the name check.

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 name to check for availability

type'Microsoft.StorageSync/storageSyncServices' required

The resource type. Must be set to Microsoft.StorageSync/storageSyncServices

Response

check availability returned successfully.

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 invalid and cannot be used.

reason'Invalid' | 'AlreadyExists'

Gets the reason that a Storage Sync Service 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 3 revisions of this API.