ApplicationGatewayBackendHttpConfiguration Interface

Package:

com.azure.resourcemanager.network.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.47.0

Implements

HasPort HasProtocol<ApplicationGatewayProtocol> ChildResource<ApplicationGateway> HasInnerModel<ApplicationGatewayBackendHttpSettings>

public interface ApplicationGatewayBackendHttpConfiguration
extends HasInnerModel<ApplicationGatewayBackendHttpSettings>, ChildResource<ApplicationGateway>, HasProtocol<ApplicationGatewayProtocol>, HasPort

A client-side representation of an application gateway's backend HTTP configuration.

Method Summary

Modifier and Type	Method and Description
abstract String	affinityCookieName() Gets name used for the affinity cookie.
abstract Map<String,ApplicationGatewayAuthenticationCertificate>	authenticationCertificates() Gets authentication certificates associated with this backend HTTPS configuration.
abstract int	connectionDrainingTimeoutInSeconds() Gets the number of seconds when connection draining is active.
abstract boolean	cookieBasedAffinity() Checks whether cookie based affinity (sticky sessions) is enabled.
abstract String	hostHeader() Gets host header to be sent to the backend servers.
abstract boolean	isHostHeaderFromBackend() Checks whether the host header should come from the host name of the backend server.
abstract boolean	isProbeEnabled() Checks whether the probe is enabled.
abstract String	path() Gets the path used as a prefix for all HTTP requests.
abstract ApplicationGatewayProbe	probe() Gets the probe associated with this backend.
abstract int	requestTimeout() Gets HTTP request timeout in seconds.

Method Details

affinityCookieName

public abstract String affinityCookieName()

Gets name used for the affinity cookie.

Returns:

name used for the affinity cookie

authenticationCertificates

public abstract Map authenticationCertificates()

Gets authentication certificates associated with this backend HTTPS configuration.

Returns:

authentication certificates associated with this backend HTTPS configuration

connectionDrainingTimeoutInSeconds

public abstract int connectionDrainingTimeoutInSeconds()

Gets the number of seconds when connection draining is active.

Returns:

if 0 then connection draining is not enabled, otherwise if between 1 and 3600, then the number of seconds when connection draining is active

cookieBasedAffinity

public abstract boolean cookieBasedAffinity()

Checks whether cookie based affinity (sticky sessions) is enabled.

Returns:

true if cookie based affinity (sticky sessions) is enabled, else false

hostHeader

public abstract String hostHeader()

Gets host header to be sent to the backend servers.

Returns:

host header to be sent to the backend servers

isHostHeaderFromBackend

public abstract boolean isHostHeaderFromBackend()

Checks whether the host header should come from the host name of the backend server.

Returns:

whether the host header should come from the host name of the backend server

isProbeEnabled

public abstract boolean isProbeEnabled()

Checks whether the probe is enabled.

Returns:

true if the probe is enabled

path

public abstract String path()

Gets the path used as a prefix for all HTTP requests.

Returns:

the path, if any, used as a prefix for all HTTP requests

probe

public abstract ApplicationGatewayProbe probe()

Gets the probe associated with this backend.

Returns:

the probe associated with this backend

requestTimeout

public abstract int requestTimeout()

Gets HTTP request timeout in seconds.

Returns:

HTTP request timeout in seconds. Requests will fail if no response is received within the specified time.