Share via

ApiManagementServiceNameAvailabilityResult interface

  • Reference
Package:
@azure/arm-apimanagement

Response of the CheckNameAvailability operation.

Properties

message

If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. NOTE: This property will not be serialized. It can only be populated by the server.
nameAvailable

True if the name is available and can be used to create a new API Management service; otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.
reason

Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

Property Details

message

If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. NOTE: This property will not be serialized. It can only be populated by the server.

message?: string

Property Value

string

nameAvailable

True if the name is available and can be used to create a new API Management service; otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

nameAvailable?: boolean

Property Value

boolean

reason

Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

reason?: NameAvailabilityReason

Property Value

NameAvailabilityReason