Sign in

Checks if the specified management group name is valid and unique

post/providers/Microsoft.Management/checkNameAvailability

Parameters

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

Request body

namestring

the name to check for availability

type'Microsoft.Management/managementGroups'

fully qualified resource type which includes provider namespace

Response

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.

Changes

Changed in 3 of the 11 revisions of this API.113

  • 2017-08-31-preview2a185afab70111See the full diff
    • ●

      deleted the query request parameter api-version

      request-parameter-removed

    • ○

      api tag CheckNameAvailability removed

      api-tag-removed

  • 2017-08-31-preview8a88b7130da611See the full diff
    • ▲

      added the new required query request parameter api-version

      new-required-request-parameter

    • ○

      api tag CheckNameAvailability added

      api-tag-added

  • 2017-08-31-preview88ed6e4623fb1See the full diff
    • ○

      endpoint added

      endpoint-added