Class AdditionalLocation


  • public final class AdditionalLocation
    extends Object
    Description of an additional API Management resource location.
    • Constructor Detail

      • AdditionalLocation

        public AdditionalLocation()
    • Method Detail

      • 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.
      • 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.
      • 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.