CheckNameAvailabilityResult interface

Package:

@azure/arm-keyvault

The CheckNameAvailability operation response.

Properties

message	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	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 is invalid and cannot be used. NOTE: This property will not be serialized. It can only be populated by the server.
reason	The reason that a vault 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

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

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 is 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

The reason that a vault 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?: Reason

Property Value

Reason