Share via

CheckNameAvailabilityOutput interface

  • Reference
Package:
@azure/arm-search

Output of check name availability API.

Properties

isNameAvailable

A value indicating whether the name is available. NOTE: This property will not be serialized. It can only be populated by the server.
message

A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. NOTE: This property will not be serialized. It can only be populated by the server.
reason

The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

isNameAvailable

A value indicating whether the name is available. NOTE: This property will not be serialized. It can only be populated by the server.

isNameAvailable?: boolean

Property Value

boolean

message

A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. NOTE: This property will not be serialized. It can only be populated by the server.

message?: string

Property Value

string

reason

The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. NOTE: This property will not be serialized. It can only be populated by the server.

reason?: string

Property Value

string