Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CheckNameAvailabilityResult

Package version

interface

An interface representing CheckNameAvailabilityResult. Describes the result of the request to check management group name availability.

Hierarchy

  • CheckNameAvailabilityResult

Index

Properties

Optional message

message: undefined | string
member

{string} [message] 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.

Optional nameAvailable

nameAvailable: undefined | false | true
member

{boolean} [nameAvailable] 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.

Optional reason

reason: Reason
member

{Reason} [reason] 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. Possible values include: 'Invalid', 'AlreadyExists' NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc