Interface ApplicationGateway
- All Superinterfaces:
GroupableResource<NetworkManager,,ApplicationGatewayInner> HasId,HasInnerModel<ApplicationGatewayInner>,HasManager<NetworkManager>,HasName,HasPrivateIpAddress,HasResourceGroup,HasSubnet,Indexable,Refreshable<ApplicationGateway>,Resource,Updatable<ApplicationGateway.Update>,UpdatableWithTags<ApplicationGateway>
public interface ApplicationGateway
extends GroupableResource<NetworkManager,ApplicationGatewayInner>, Refreshable<ApplicationGateway>, Updatable<ApplicationGateway.Update>, UpdatableWithTags<ApplicationGateway>, HasSubnet, HasPrivateIpAddress
Entry point for application gateway management API in Azure.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the application gateway definition.static interfaceGrouping of application gateway definition stages.static interfaceThe template for an application gateway update operation, containing all the settings that can be modified.static interfaceGrouping of application gateway update stages.Nested classes/interfaces inherited from interface com.azure.resourcemanager.network.models.HasPrivateIpAddress
HasPrivateIpAddress.UpdateDefinitionStagesNested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasSubnet
HasSubnet.UpdateDefinitionStagesNested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>Nested classes/interfaces inherited from interface com.azure.resourcemanager.network.models.UpdatableWithTags
UpdatableWithTags.UpdateWithTags<T> -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets authentication certificates.Gets the autoscaleConfiguration value.The availability zones assigned to the application gateway.Gets backend HTTP configurations of this application gateway.backends()Gets backend address pools of this application gateway.Checks the backend health.Checks the backend health asynchronously.Gets the existing IP configurations.Gets the frontend IP configuration associated with a private IP address.Gets the frontend IP configuration associated with a public IP address.Deprecated.Application Gateway V1 is officially deprecated on April 28, 2023.frontendPortNameFromNumber(int portNumber) Returns the name of the existing port, if any, that is associated with the specified port number.Gets named frontend ports of this application gateway.Gets frontend IP configurations.Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API.Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API in async manner.Gets resource ID of the Web Application Firewall Policy (if any) associated with the application gateway.intGets number of instances.Gets IP configurations of this application gateway.booleanChecks whether HTTP2 is enabled for the application gateway.booleanChecks whether the application gateway has at least one internally load balanced frontend accessible within the virtual network.booleanisPublic()Checks whether the application gateway has at least one Internet-facing frontend.listenerByPortNumber(int portNumber) Finds a front end listener associated with the specified front end port number, if any.Gets frontend listeners.Gets the operational state of the application gateway.Gets frontend IP configurations with a private IP address within a subnet.probes()Gets probes of this application gateway.Gets frontend IP configurations with a public IP address.Gets redirect configurations.Gets request routing rules.size()Gets the size of the application gateway.sku()Gets the SKU of this application gateway.Gets SSL certificates.Get the SSL policy for the application gateway.voidstart()Starts the application gateway.Starts the application gateway asynchronously.voidstop()Stops the application gateway.Stops the application gateway asynchronously.tier()Gets the tier of the application gateway.Gets URL path maps.Gets the webApplicationFirewallConfiguration value.Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModelMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager
managerMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
nameMethods inherited from interface com.azure.resourcemanager.network.models.HasPrivateIpAddress
privateIpAddress, privateIpAllocationMethodMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupNameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasSubnet
networkId, subnetNameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable
refresh, refreshAsyncMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
region, regionName, tags, typeMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable
updateMethods inherited from interface com.azure.resourcemanager.network.models.UpdatableWithTags
updateTags
-
Method Details
-
start
void start()Starts the application gateway. -
checkBackendHealth
Map<String,ApplicationGatewayBackendHealth> checkBackendHealth()Checks the backend health.- Returns:
- backend healths indexed by backend name
-
checkBackendHealthAsync
Mono<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
Starts the application gateway asynchronously.- Returns:
- a representation of the deferred computation of this call
-
stopAsync
Stops the application gateway asynchronously.- Returns:
- a representation of the deferred computation of this call
-
disabledSslProtocols
Deprecated.Application Gateway V1 is officially deprecated on April 28, 2023. This attribute has no effect for V2 gateways, instead, usesslPolicy().Get the disabled SSL protocols.- Returns:
- disabled SSL protocols
-
isPrivate
boolean isPrivate()Checks whether the application gateway has at least one internally load balanced frontend accessible within the virtual network.- Returns:
- true if the application gateway has at least one internally load balanced frontend accessible within the virtual network
-
isPublic
boolean isPublic()Checks whether the application gateway has at least one Internet-facing frontend.- Returns:
- true if the application gateway has at least one Internet-facing frontend
-
defaultPublicFrontend
ApplicationGatewayFrontend defaultPublicFrontend()Gets the frontend IP configuration associated with a public IP address.- 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()Gets the frontend IP configuration associated with a private IP address.- 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()Gets the SKU of this application gateway.- Returns:
- the SKU of this application gateway
-
instanceCount
int instanceCount()Gets number of instances.- Returns:
- number of instances
-
size
ApplicationGatewaySkuName size()Gets the size of the application gateway.- Returns:
- the size of the application gateway
-
tier
ApplicationGatewayTier tier()Gets the tier of the application gateway.- Returns:
- the tier of the application gateway
-
autoscaleConfiguration
ApplicationGatewayAutoscaleConfiguration autoscaleConfiguration()Gets the autoscaleConfiguration value.- Returns:
- the autoscaleConfiguration value.
-
webApplicationFirewallConfiguration
ApplicationGatewayWebApplicationFirewallConfiguration webApplicationFirewallConfiguration()Gets the webApplicationFirewallConfiguration value.- Returns:
- the webApplicationFirewallConfiguration value.
-
operationalState
ApplicationGatewayOperationalState operationalState()Gets the operational state of the application gateway.- Returns:
- the operational state of the application gateway
-
ipConfigurations
Map<String,ApplicationGatewayIpConfiguration> ipConfigurations()Gets IP configurations of this application gateway.- Returns:
- IP configurations of this application gateway, indexed by name
-
backends
Map<String,ApplicationGatewayBackend> backends()Gets backend address pools of this application gateway.- Returns:
- backend address pools of this application gateway, indexed by name
-
probes
Map<String,ApplicationGatewayProbe> probes()Gets probes of this application gateway.- Returns:
- probes of this application gateway, indexed by name
-
defaultIPConfiguration
ApplicationGatewayIpConfiguration defaultIPConfiguration()Gets the existing IP configurations.- Returns:
- the existing IP configurations if only one exists, else null
-
frontends
Map<String,ApplicationGatewayFrontend> frontends()Gets frontend IP configurations.- Returns:
- frontend IP configurations, indexed by name
-
publicFrontends
Map<String,ApplicationGatewayFrontend> publicFrontends()Gets frontend IP configurations with a public IP address.- Returns:
- frontend IP configurations with a public IP address, indexed by name
-
privateFrontends
Map<String,ApplicationGatewayFrontend> privateFrontends()Gets frontend IP configurations with a private IP address within a subnet.- Returns:
- frontend IP configurations with a private IP address within a subnet, indexed by name
-
frontendPorts
Gets named frontend ports of this application gateway.- Returns:
- named frontend ports of this application gateway, indexed by name
-
backendHttpConfigurations
Map<String,ApplicationGatewayBackendHttpConfiguration> backendHttpConfigurations()Gets backend HTTP configurations of this application gateway.- Returns:
- backend HTTP configurations of this application gateway, indexed by name
-
sslCertificates
Map<String,ApplicationGatewaySslCertificate> sslCertificates()Gets SSL certificates.- Returns:
- SSL certificates, indexed by name
-
listeners
Map<String,ApplicationGatewayListener> listeners()Gets frontend listeners.- Returns:
- frontend listeners, indexed by name
-
redirectConfigurations
Map<String,ApplicationGatewayRedirectConfiguration> redirectConfigurations()Gets redirect configurations.- Returns:
- redirect configurations, indexed by name
-
urlPathMaps
Map<String,ApplicationGatewayUrlPathMap> urlPathMaps()Gets URL path maps.- Returns:
- URL path maps, indexed by name (case sensitive)
-
requestRoutingRules
Map<String,ApplicationGatewayRequestRoutingRule> requestRoutingRules()Gets request routing rules.- Returns:
- request routing rules, indexed by name
-
authenticationCertificates
Map<String,ApplicationGatewayAuthenticationCertificate> authenticationCertificates()Gets authentication certificates.- Returns:
- authentication certificates
-
isHttp2Enabled
boolean isHttp2Enabled()Checks whether HTTP2 is enabled for the application gateway.- Returns:
- whether HTTP2 enabled for the application gateway
-
availabilityZones
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
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
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
-
getWebApplicationFirewallPolicyId
String getWebApplicationFirewallPolicyId()Gets resource ID of the Web Application Firewall Policy (if any) associated with the application gateway.- Returns:
- resource ID of the Web Application Firewall Policy (if any) associated with the application gateway
-
getWebApplicationFirewallPolicy
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
Mono<WebApplicationFirewallPolicy> getWebApplicationFirewallPolicyAsync()Get the Web Application Firewall Policy (if any) associated with the application gateway by calling REST API in async manner.- Returns:
Monoof Web Application Firewall Policy (if any) associated with the application gateway
-
sslPolicy
ApplicationGatewaySslPolicy sslPolicy()Get the SSL policy for the application gateway.- Returns:
- SSL policy of the application gateway
-