Share via

ApplicationGateway Interface

  • Reference
Package:
com.azure.resourcemanager.network.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-network:2.44.0

Implements

HasPrivateIpAddress UpdatableWithTags<ApplicationGateway> GroupableResource<NetworkManager,ApplicationGatewayInner> HasSubnet Refreshable<ApplicationGateway> Updatable<Update>

public interface ApplicationGateway
extends GroupableResource<NetworkManager,ApplicationGatewayInner>, Refreshable<ApplicationGateway>, Updatable<Update>, UpdatableWithTags<ApplicationGateway>, HasSubnet, HasPrivateIpAddress

Entry point for application gateway management API in Azure.

Method Summary

Modifier and Type Method and Description
abstract Map<String,ApplicationGatewayAuthenticationCertificate> authenticationCertificates()
abstract ApplicationGatewayAutoscaleConfiguration autoscaleConfiguration()
abstract Set<AvailabilityZoneId> availabilityZones()

The availability zones assigned to the application gateway.
abstract Map<String,ApplicationGatewayBackendHttpConfiguration> backendHttpConfigurations()
abstract Map<String,ApplicationGatewayBackend> backends()
abstract Map<String,ApplicationGatewayBackendHealth> checkBackendHealth()

Checks the backend health.
abstract Mono<Map<String,ApplicationGatewayBackendHealth>> checkBackendHealthAsync()

Checks the backend health asynchronously.
abstract ApplicationGatewayIpConfiguration defaultIPConfiguration()
abstract ApplicationGatewayFrontend defaultPrivateFrontend()
abstract ApplicationGatewayFrontend defaultPublicFrontend()
abstract Collection<ApplicationGatewaySslProtocol> disabledSslProtocols()

Deprecated

Application Gateway V1 is officially deprecated on April 28, 2023. This attribute has no effect for V2 gateways, instead, use sslPolicy().

Get the disabled SSL protocols.
abstract String frontendPortNameFromNumber(int portNumber)

Returns the name of the existing port, if any, that is associated with the specified port number.
abstract Map<String,Integer> frontendPorts()
abstract Map<String,ApplicationGatewayFrontend> frontends()
abstract WebApplicationFirewallPolicy getWebApplicationFirewallPolicy()

Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API.
abstract Mono<WebApplicationFirewallPolicy> getWebApplicationFirewallPolicyAsync()

Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API in async manner.
abstract String getWebApplicationFirewallPolicyId()
abstract int instanceCount()
abstract Map<String,ApplicationGatewayIpConfiguration> ipConfigurations()
abstract boolean isHttp2Enabled()
abstract boolean isPrivate()
abstract boolean isPublic()
abstract ApplicationGatewayListener listenerByPortNumber(int portNumber)

Finds a front end listener associated with the specified front end port number, if any.
abstract Map<String,ApplicationGatewayListener> listeners()
abstract ApplicationGatewayOperationalState operationalState()
abstract Map<String,ApplicationGatewayFrontend> privateFrontends()
abstract Map<String,ApplicationGatewayProbe> probes()
abstract Map<String,ApplicationGatewayFrontend> publicFrontends()
abstract Map<String,ApplicationGatewayRedirectConfiguration> redirectConfigurations()
abstract Map<String,ApplicationGatewayRequestRoutingRule> requestRoutingRules()
abstract ApplicationGatewaySkuName size()
abstract ApplicationGatewaySku sku()
abstract Map<String,ApplicationGatewaySslCertificate> sslCertificates()
abstract ApplicationGatewaySslPolicy sslPolicy()

Get the SSL policy for the application gateway.
abstract void start()

Starts the application gateway.
abstract Mono<Void> startAsync()

Starts the application gateway asynchronously.
abstract void stop()

Stops the application gateway.
abstract Mono<Void> stopAsync()

Stops the application gateway asynchronously.
abstract ApplicationGatewayTier tier()
abstract Map<String,ApplicationGatewayUrlPathMap> urlPathMaps()
abstract ApplicationGatewayWebApplicationFirewallConfiguration webApplicationFirewallConfiguration()

Method Details

authenticationCertificates

public abstract Map authenticationCertificates()

Returns:

authentication certificates

autoscaleConfiguration

public abstract ApplicationGatewayAutoscaleConfiguration autoscaleConfiguration()

Returns:

the autoscaleConfiguration value.

availabilityZones

public abstract Set 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.

backendHttpConfigurations

public abstract Map backendHttpConfigurations()

Returns:

backend HTTP configurations of this application gateway, indexed by name

backends

public abstract Map backends()

Returns:

backend address pools of this application gateway, indexed by name

checkBackendHealth

public abstract Map checkBackendHealth()

Checks the backend health.

Returns:

backend healths indexed by backend name

checkBackendHealthAsync

public abstract Mono> checkBackendHealthAsync()

Checks the backend health asynchronously.

Returns:

a representation of the future computation of this call

defaultIPConfiguration

public abstract ApplicationGatewayIpConfiguration defaultIPConfiguration()

Returns:

the existing IP configurations if only one exists, else null

defaultPrivateFrontend

public abstract 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

defaultPublicFrontend

public abstract 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

disabledSslProtocols

@Deprecated
public abstract Collection disabledSslProtocols()

Deprecated

Application Gateway V1 is officially deprecated on April 28, 2023. This attribute has no effect for V2 gateways, instead, use sslPolicy().

Get the disabled SSL protocols.

Returns:

disabled SSL protocols

frontendPortNameFromNumber

public abstract 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

frontendPorts

public abstract Map frontendPorts()

Returns:

named frontend ports of this application gateway, indexed by name

frontends

public abstract Map frontends()

Returns:

frontend IP configurations, indexed by name

getWebApplicationFirewallPolicy

public abstract WebApplicationFirewallPolicy getWebApplicationFirewallPolicy()

Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API.

Returns:

Web Application Firewall Policy (if any) associated with the application gateway

getWebApplicationFirewallPolicyAsync

public abstract Mono getWebApplicationFirewallPolicyAsync()

Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API in async manner.

Returns:

Mono of Web Application Firewall Policy (if any) associated with the application gateway

getWebApplicationFirewallPolicyId

public abstract String getWebApplicationFirewallPolicyId()

Returns:

resource id of the Web Application Firewall Policy (if any) associated with the application gateway

instanceCount

public abstract int instanceCount()

Returns:

number of instances

ipConfigurations

public abstract Map ipConfigurations()

Returns:

IP configurations of this application gateway, indexed by name

isHttp2Enabled

public abstract boolean isHttp2Enabled()

Returns:

whether HTTP2 enabled for the application gateway

isPrivate

public abstract boolean isPrivate()

Returns:

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

isPublic

public abstract boolean isPublic()

Returns:

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

listenerByPortNumber

public abstract 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

listeners

public abstract Map listeners()

Returns:

frontend listeners, indexed by name

operationalState

public abstract ApplicationGatewayOperationalState operationalState()

Returns:

the operational state of the application gateway

privateFrontends

public abstract Map privateFrontends()

Returns:

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

probes

public abstract Map probes()

Returns:

probes of this application gateway, indexed by name

publicFrontends

public abstract Map publicFrontends()

Returns:

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

redirectConfigurations

public abstract Map redirectConfigurations()

Returns:

redirect configurations, indexed by name

requestRoutingRules

public abstract Map requestRoutingRules()

Returns:

request routing rules, indexed by name

size

public abstract ApplicationGatewaySkuName size()

Returns:

the size of the application gateway

sku

public abstract ApplicationGatewaySku sku()

Returns:

the SKU of this application gateway

sslCertificates

public abstract Map sslCertificates()

Returns:

SSL certificates, indexed by name

sslPolicy

public abstract ApplicationGatewaySslPolicy sslPolicy()

Get the SSL policy for the application gateway.

Returns:

SSL policy of the application gateway

start

public abstract void start()

Starts the application gateway.

startAsync

public abstract Mono startAsync()

Starts the application gateway asynchronously.

Returns:

a representation of the deferred computation of this call

stop

public abstract void stop()

Stops the application gateway.

stopAsync

public abstract Mono stopAsync()

Stops the application gateway asynchronously.

Returns:

a representation of the deferred computation of this call

tier

public abstract ApplicationGatewayTier tier()

Returns:

the tier of the application gateway

urlPathMaps

public abstract Map urlPathMaps()

Returns:

URL path maps, indexed by name (case sensitive)

webApplicationFirewallConfiguration

public abstract ApplicationGatewayWebApplicationFirewallConfiguration webApplicationFirewallConfiguration()

Returns:

the webApplicationFirewallConfiguration value.

Applies to