Sign in

v11

latestSwagger 2.02026-07-13204672.0 KB
CheckNameAvailability

Checks if the specified management group or service group name is valid and unique

post/providers/Microsoft.Management/checkNameAvailability

Query parameters

api-versionstring required

Version of the API to be used with the client request. The current version is 2018-01-01-preview.

Request body

namestring

the name to check for availability

type'Microsoft.Management/managementGroups' | 'Microsoft.Management/serviceGroups'

fully qualified resource type which includes provider namespace

Response

OK. The request has succeeded.

nameAvailableboolean

Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.

reason'Invalid' | 'AlreadyExists'

Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

messagestring

Required if nameAvailable == false. Localized. 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 is already in use, and direct them to select a different name.