Package com.azure.resourcemanager.apimanagement.models

Interface ApiManagementServiceNameAvailabilityResult

public interface ApiManagementServiceNameAvailabilityResult
An immutable client-side representation of ApiManagementServiceNameAvailabilityResult.

  • Method Summary

    Modifier and Type
    Method
    Description
    ApiManagementServiceNameAvailabilityResultInner
    innerModel()
    Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceNameAvailabilityResultInner object.
    String
    message()
    Gets the message property: 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.
    Boolean
    nameAvailable()
    Gets the nameAvailable property: True if the name is available and can be used to create a new API Management service; otherwise false.
    NameAvailabilityReason
    reason()
    Gets the reason property: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.)

  • Method Details

    • nameAvailable

      Boolean nameAvailable()
      Gets the nameAvailable property: True if the name is available and can be used to create a new API Management service; otherwise false.
      Returns:
      the nameAvailable value.

    • message

      String message()
      Gets the message property: 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 <resourceName> is already in use, and direct them to select a different name.
      Returns:
      the message value.

    • reason

      NameAvailabilityReason reason()
      Gets the reason property: 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.
      Returns:
      the reason value.

    • innerModel

      ApiManagementServiceNameAvailabilityResultInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceNameAvailabilityResultInner object.
      Returns:
      the inner object.