Package com.azure.resourcemanager.apimanagement.models

Class AdditionalLocation

java.lang.Object
com.azure.resourcemanager.apimanagement.models.AdditionalLocation
All Implemented Interfaces:
com.azure.json.JsonSerializable<AdditionalLocation>
public final class AdditionalLocation extends Object implements com.azure.json.JsonSerializable<AdditionalLocation>
Description of an additional API Management resource location.

  • Constructor Details

    • AdditionalLocation

      public AdditionalLocation()
      Creates an instance of AdditionalLocation class.

  • Method Details

    • location

      public String location()
      Get the location property: The location name of the additional region among Azure Data center regions.
      Returns:
      the location value.

    • withLocation

      public AdditionalLocation withLocation(String location)
      Set the location property: The location name of the additional region among Azure Data center regions.
      Parameters:
      location - the location value to set.
      Returns:
      the AdditionalLocation object itself.

    • sku

      public ApiManagementServiceSkuProperties sku()
      Get the sku property: SKU properties of the API Management service.
      Returns:
      the sku value.

    • withSku

      public AdditionalLocation withSku(ApiManagementServiceSkuProperties sku)
      Set the sku property: SKU properties of the API Management service.
      Parameters:
      sku - the sku value to set.
      Returns:
      the AdditionalLocation object itself.

    • zones

      public List<String> zones()
      Get the zones property: A list of availability zones denoting where the resource needs to come from.
      Returns:
      the zones value.

    • withZones

      public AdditionalLocation withZones(List<String> zones)
      Set the zones property: A list of availability zones denoting where the resource needs to come from.
      Parameters:
      zones - the zones value to set.
      Returns:
      the AdditionalLocation object itself.

    • publicIpAddresses

      public List<String> publicIpAddresses()
      Get the publicIpAddresses property: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
      Returns:
      the publicIpAddresses value.

    • privateIpAddresses

      public List<String> privateIpAddresses()
      Get the privateIpAddresses property: Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
      Returns:
      the privateIpAddresses value.

    • publicIpAddressId

      public String publicIpAddressId()
      Get the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
      Returns:
      the publicIpAddressId value.

    • withPublicIpAddressId

      public AdditionalLocation withPublicIpAddressId(String publicIpAddressId)
      Set the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
      Parameters:
      publicIpAddressId - the publicIpAddressId value to set.
      Returns:
      the AdditionalLocation object itself.

    • virtualNetworkConfiguration

      public VirtualNetworkConfiguration virtualNetworkConfiguration()
      Get the virtualNetworkConfiguration property: Virtual network configuration for the location.
      Returns:
      the virtualNetworkConfiguration value.

    • withVirtualNetworkConfiguration

      public AdditionalLocation withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)
      Set the virtualNetworkConfiguration property: Virtual network configuration for the location.
      Parameters:
      virtualNetworkConfiguration - the virtualNetworkConfiguration value to set.
      Returns:
      the AdditionalLocation object itself.

    • gatewayRegionalUrl

      public String gatewayRegionalUrl()
      Get the gatewayRegionalUrl property: Gateway URL of the API Management service in the Region.
      Returns:
      the gatewayRegionalUrl value.

    • natGatewayState

      public NatGatewayState natGatewayState()
      Get the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.
      Returns:
      the natGatewayState value.

    • withNatGatewayState

      public AdditionalLocation withNatGatewayState(NatGatewayState natGatewayState)
      Set the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.
      Parameters:
      natGatewayState - the natGatewayState value to set.
      Returns:
      the AdditionalLocation object itself.

    • outboundPublicIpAddresses

      public List<String> outboundPublicIpAddresses()
      Get the outboundPublicIpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
      Returns:
      the outboundPublicIpAddresses value.

    • disableGateway

      public Boolean disableGateway()
      Get the disableGateway property: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
      Returns:
      the disableGateway value.

    • withDisableGateway

      public AdditionalLocation withDisableGateway(Boolean disableGateway)
      Set the disableGateway property: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
      Parameters:
      disableGateway - the disableGateway value to set.
      Returns:
      the AdditionalLocation object itself.

    • platformVersion

      public PlatformVersion platformVersion()
      Get the platformVersion property: Compute Platform Version running the service.
      Returns:
      the platformVersion value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AdditionalLocation>
      Throws:
      IOException

    • fromJson

      public static AdditionalLocation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AdditionalLocation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AdditionalLocation if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AdditionalLocation.