CheckNameAvailabilityResult.yml

### YamlMime:TSType
name: CheckNameAvailabilityResult
uid: '@azure/arm-managementgroups.CheckNameAvailabilityResult'
package: '@azure/arm-managementgroups'
summary: >-
  Describes the result of the request to check management group name
  availability.
fullName: CheckNameAvailabilityResult
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: message
    uid: '@azure/arm-managementgroups.CheckNameAvailabilityResult.message'
    package: '@azure/arm-managementgroups'
    summary: >-
      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.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: message
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'message?: string'
      return:
        description: ''
        type: string
  - name: nameAvailable
    uid: '@azure/arm-managementgroups.CheckNameAvailabilityResult.nameAvailable'
    package: '@azure/arm-managementgroups'
    summary: >-
      Required. True indicates name is valid and available. False indicates the
      name is invalid, unavailable, or both.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: nameAvailable
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'nameAvailable?: boolean'
      return:
        description: ''
        type: boolean
  - name: reason
    uid: '@azure/arm-managementgroups.CheckNameAvailabilityResult.reason'
    package: '@azure/arm-managementgroups'
    summary: >-
      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.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: reason
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'reason?: Reason'
      return:
        description: ''
        type: <xref uid="@azure/arm-managementgroups.Reason" />