CheckNameAvailabilityResult interface

Package:

@azure/arm-batch

The CheckNameAvailability operation response.

Properties

message	Gets an error message explaining the Reason value in more detail. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
reason	Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

message

Gets an error message explaining the Reason value in more detail. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

reason?: NameAvailabilityReason

Property Value

NameAvailabilityReason