com.microsoft.azure.management.network

Interface ApplicationGateway

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.network.implementation.NetworkManager,com.microsoft.azure.management.network.implementation.ApplicationGatewayInner>, HasId, HasInner<com.microsoft.azure.management.network.implementation.ApplicationGatewayInner>, HasManager<com.microsoft.azure.management.network.implementation.NetworkManager>, HasName, HasPrivateIPAddress, HasResourceGroup, HasSubnet, Indexable, Refreshable<ApplicationGateway>, Resource, Updatable<ApplicationGateway.Update>, UpdatableWithTags<ApplicationGateway>

public interface ApplicationGateway
extends GroupableResource<com.microsoft.azure.management.network.implementation.NetworkManager,com.microsoft.azure.management.network.implementation.ApplicationGatewayInner>, Refreshable<ApplicationGateway>, Updatable<ApplicationGateway.Update>, UpdatableWithTags<ApplicationGateway>, HasSubnet, HasPrivateIPAddress

Entry point for application gateway management API in Azure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ApplicationGateway.Definition The entirety of the application gateway definition.
static interface	ApplicationGateway.DefinitionStages Grouping of application gateway definition stages.
static interface	ApplicationGateway.Update The template for an application gateway update operation, containing all the settings that can be modified.
static interface	ApplicationGateway.UpdateStages Grouping of application gateway update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Nested classes/interfaces inherited from interface com.microsoft.azure.management.network.model.UpdatableWithTags

UpdatableWithTags.UpdateWithTags<T>

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasSubnet

HasSubnet.UpdateDefinitionStages

Nested classes/interfaces inherited from interface com.microsoft.azure.management.network.model.HasPrivateIPAddress

HasPrivateIPAddress.UpdateDefinitionStages

Method Summary

Modifier and Type	Method and Description
Map<String,ApplicationGatewayAuthenticationCertificate>	authenticationCertificates()
Set<AvailabilityZoneId>	availabilityZones() The availability zones assigned to the application gateway.
Map<String,ApplicationGatewayBackendHttpConfiguration>	backendHttpConfigurations()
Map<String,ApplicationGatewayBackend>	backends()
Map<String,ApplicationGatewayBackendHealth>	checkBackendHealth() Checks the backend health.
rx.Observable<Map<String,ApplicationGatewayBackendHealth>>	checkBackendHealthAsync() Checks the backend health asynchronously.
ApplicationGatewayIPConfiguration	defaultIPConfiguration()
ApplicationGatewayFrontend	defaultPrivateFrontend()
ApplicationGatewayFrontend	defaultPublicFrontend()
Collection<ApplicationGatewaySslProtocol>	disabledSslProtocols()
String	frontendPortNameFromNumber(int portNumber) Returns the name of the existing port, if any, that is associated with the specified port number.
Map<String,Integer>	frontendPorts()
Map<String,ApplicationGatewayFrontend>	frontends()
int	instanceCount()
Map<String,ApplicationGatewayIPConfiguration>	ipConfigurations()
boolean	isHttp2Enabled()
boolean	isPrivate()
boolean	isPublic()
ApplicationGatewayListener	listenerByPortNumber(int portNumber) Finds a front end listener associated with the specified front end port number, if any.
Map<String,ApplicationGatewayListener>	listeners()
ApplicationGatewayOperationalState	operationalState()
Map<String,ApplicationGatewayFrontend>	privateFrontends()
Map<String,ApplicationGatewayProbe>	probes()
Map<String,ApplicationGatewayFrontend>	publicFrontends()
Map<String,ApplicationGatewayRedirectConfiguration>	redirectConfigurations()
Map<String,ApplicationGatewayRequestRoutingRule>	requestRoutingRules()
ApplicationGatewaySkuName	size()
ApplicationGatewaySku	sku()
Map<String,ApplicationGatewaySslCertificate>	sslCertificates()
void	start() Starts the application gateway.
rx.Completable	startAsync() Starts the application gateway asynchronously.
void	stop() Stops the application gateway.
rx.Completable	stopAsync() Stops the application gateway asynchronously.
ApplicationGatewayTier	tier()
Map<String,ApplicationGatewayUrlPathMap>	urlPathMaps()

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Methods inherited from interface com.microsoft.azure.management.network.model.UpdatableWithTags

updateTags

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasSubnet

networkId, subnetName

Methods inherited from interface com.microsoft.azure.management.network.model.HasPrivateIPAddress

privateIPAddress, privateIPAllocationMethod

Method Detail

start

void start()

Starts the application gateway.

checkBackendHealth

@Beta(value=V1_4_0)
Map<String,ApplicationGatewayBackendHealth> checkBackendHealth()

Checks the backend health.

Returns:

backend healths indexed by backend name

checkBackendHealthAsync

@Beta(value=V1_4_0)
rx.Observable<Map<String,ApplicationGatewayBackendHealth>> checkBackendHealthAsync()

Checks the backend health asynchronously.

Returns:

a representation of the future computation of this call

stop

void stop()

Stops the application gateway.

startAsync

rx.Completable startAsync()

Starts the application gateway asynchronously.

Returns:

a representation of the deferred computation of this call

stopAsync

rx.Completable stopAsync()

Stops the application gateway asynchronously.

Returns:

a representation of the deferred computation of this call

disabledSslProtocols

@Beta(value=V1_1_0)
Collection<ApplicationGatewaySslProtocol> disabledSslProtocols()

Returns:

disabled SSL protocols

isPrivate

boolean isPrivate()

Returns:

true if the application gateway has at least one internally load balanced frontend accessible within the virtual network

isPublic

boolean isPublic()

Returns:

true if the application gateway has at least one Internet-facing frontend

defaultPublicFrontend

ApplicationGatewayFrontend defaultPublicFrontend()

Returns:

the frontend IP configuration associated with a public IP address, if any, that frontend listeners and request routing rules can reference implicitly

defaultPrivateFrontend

ApplicationGatewayFrontend defaultPrivateFrontend()

Returns:

the frontend IP configuration associated with a private IP address, if any, that frontend listeners and request routing rules can reference implicitly

sku

ApplicationGatewaySku sku()

Returns:

the SKU of this application gateway

instanceCount

int instanceCount()

Returns:

number of instances

size

ApplicationGatewaySkuName size()

Returns:

the size of the application gateway

tier

ApplicationGatewayTier tier()

Returns:

the tier of the application gateway

operationalState

ApplicationGatewayOperationalState operationalState()

Returns:

the operational state of the application gateway

ipConfigurations

Map<String,ApplicationGatewayIPConfiguration> ipConfigurations()

Returns:

IP configurations of this application gateway, indexed by name

backends

Map<String,ApplicationGatewayBackend> backends()

Returns:

backend address pools of this application gateway, indexed by name

probes

Map<String,ApplicationGatewayProbe> probes()

Returns:

probes of this application gateway, indexed by name

defaultIPConfiguration

ApplicationGatewayIPConfiguration defaultIPConfiguration()

Returns:

the existing IP configurations if only one exists, else null

frontends

Map<String,ApplicationGatewayFrontend> frontends()

Returns:

frontend IP configurations, indexed by name

publicFrontends

Map<String,ApplicationGatewayFrontend> publicFrontends()

Returns:

frontend IP configurations with a public IP address, indexed by name

privateFrontends

Map<String,ApplicationGatewayFrontend> privateFrontends()

Returns:

frontend IP configurations with a private IP address within a subnet, indexed by name

frontendPorts

Map<String,Integer> frontendPorts()

Returns:

named frontend ports of this application gateway, indexed by name

backendHttpConfigurations

Map<String,ApplicationGatewayBackendHttpConfiguration> backendHttpConfigurations()

Returns:

backend HTTP configurations of this application gateway, indexed by name

sslCertificates

Map<String,ApplicationGatewaySslCertificate> sslCertificates()

Returns:

SSL certificates, indexed by name

listeners

Map<String,ApplicationGatewayListener> listeners()

Returns:

frontend listeners, indexed by name

redirectConfigurations

@Beta(value=V1_4_0)
Map<String,ApplicationGatewayRedirectConfiguration> redirectConfigurations()

Returns:

redirect configurations, indexed by name

urlPathMaps

@Beta(value=V1_11_0)
Map<String,ApplicationGatewayUrlPathMap> urlPathMaps()

Returns:

URL path maps, indexed by name (case sensitive)

requestRoutingRules

Map<String,ApplicationGatewayRequestRoutingRule> requestRoutingRules()

Returns:

request routing rules, indexed by name

authenticationCertificates

@Beta(value=V1_4_0)
Map<String,ApplicationGatewayAuthenticationCertificate> authenticationCertificates()

Returns:

authentication certificates

isHttp2Enabled

@Beta(value=V1_14_0)
boolean isHttp2Enabled()

Returns:

whether HTTP2 enabled for the application gateway

availabilityZones

@Beta(value=V1_4_0)
Set<AvailabilityZoneId> availabilityZones()

The availability zones assigned to the application gateway.

Note, this functionality is not enabled for most subscriptions and is subject to significant redesign and/or removal in the future.

Returns:

the availability zones assigned to the application gateway.

frontendPortNameFromNumber

String frontendPortNameFromNumber(int portNumber)

Returns the name of the existing port, if any, that is associated with the specified port number.

Parameters:

portNumber - a port number

Returns:

the existing port name for that port number, or null if none found

listenerByPortNumber

ApplicationGatewayListener listenerByPortNumber(int portNumber)

Finds a front end listener associated with the specified front end port number, if any.

Parameters:

portNumber - a used port number

Returns:

a front end listener, or null if none found