CheckNameAvailabilityResult interface

Package:: @azure/arm-managementgroups

Describes the result of the request to check management group name availability.

Properties

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.
nameAvailable	Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.
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.

Property Details

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.

message?: string

Property Value

string

nameAvailable

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

nameAvailable?: boolean

Property Value

boolean

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.

reason?: Reason

Property Value

Reason