Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CheckNameAvailabilityOutput

Package version

interface

An interface representing CheckNameAvailabilityOutput. Output of check name availability API.

Hierarchy

  • CheckNameAvailabilityOutput

Index

Properties

Properties

Optional isNameAvailable

isNameAvailable: undefined | false | true
member

{boolean} [isNameAvailable] A value indicating whether the name is available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string
member

{string} [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.

Optional reason

reason: UnavailableNameReason
member

{UnavailableNameReason} [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. Possible values include: 'Invalid', 'AlreadyExists' NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc