Share via

CheckNameAvailabilityResult interface

Package:
@azure/arm-batch

The CheckNameAvailability operation response.

Properties

message

Gets an error message explaining the Reason value in more detail.
nameAvailable

Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
reason

Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.

Property Details

message

Gets an error message explaining the Reason value in more detail.

message?: string

Property Value

string

nameAvailable

Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.

nameAvailable?: boolean

Property Value

boolean

reason

Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.

reason?: NameAvailabilityReason

Property Value

NameAvailabilityReason