ApplicationGatewayBackendHttpSettings Class

Package:

com.azure.resourcemanager.network.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.57.0

• java.lang.Object
• • com.azure.core.management.SubResource
  • • com.azure.resourcemanager.network.models.ApplicationGatewayBackendHttpSettings

public final class ApplicationGatewayBackendHttpSettings
extends SubResource

Backend address pool settings of an application gateway.

Constructor Summary

Constructor	Description
ApplicationGatewayBackendHttpSettings()	Creates an instance of ApplicationGatewayBackendHttpSettings class.

Method Summary

Modifier and Type	Method and Description
String	affinityCookieName() Get the affinityCookieName property: Cookie name to use for the affinity cookie.
List<SubResource>	authenticationCertificates() Get the authenticationCertificates property: Array of references to application gateway authentication certificates.
ApplicationGatewayConnectionDraining	connectionDraining() Get the connectionDraining property: Connection draining of the backend http settings resource.
ApplicationGatewayCookieBasedAffinity	cookieBasedAffinity() Get the cookieBasedAffinity property: Cookie based affinity.
Boolean	dedicatedBackendConnection() Get the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server.
String	etag() Get the etag property: A unique read-only string that changes whenever the resource is updated.
static ApplicationGatewayBackendHttpSettings	fromJson(JsonReader jsonReader) Reads an instance of ApplicationGatewayBackendHttpSettings from the JsonReader.
String	hostname() Get the hostname property: Host header to be sent to the backend servers.
String	name() Get the name property: Name of the backend http settings that is unique within an Application Gateway.
String	path() Get the path property: Path which should be used as a prefix for all HTTP requests.
Boolean	pickHostnameFromBackendAddress() Get the pickHostnameFromBackendAddress property: Whether to pick host header should be picked from the host name of the backend server.
Integer	port() Get the port property: The destination port on the backend.
SubResource	probe() Get the probe property: Probe resource of an application gateway.
Boolean	probeEnabled() Get the probeEnabled property: Whether the probe is enabled.
ApplicationGatewayProtocol	protocol() Get the protocol property: The protocol used to communicate with the backend.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the backend HTTP settings resource.
Integer	requestTimeout() Get the requestTimeout property: Request timeout in seconds.
String	sniName() Get the sniName property: Specify an SNI value to match the common name of the certificate on the backend.
JsonWriter	toJson(JsonWriter jsonWriter)
List<SubResource>	trustedRootCertificates() Get the trustedRootCertificates property: Array of references to application gateway trusted root certificates.
String	type() Get the type property: Type of the resource.
void	validate() Validates the instance.
Boolean	validateCertChainAndExpiry() Get the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server.
Boolean	validateSni() Get the validateSni property: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value.
ApplicationGatewayBackendHttpSettings	withAffinityCookieName(String affinityCookieName) Set the affinityCookieName property: Cookie name to use for the affinity cookie.
ApplicationGatewayBackendHttpSettings	withAuthenticationCertificates(List<SubResource> authenticationCertificates) Set the authenticationCertificates property: Array of references to application gateway authentication certificates.
ApplicationGatewayBackendHttpSettings	withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining) Set the connectionDraining property: Connection draining of the backend http settings resource.
ApplicationGatewayBackendHttpSettings	withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity) Set the cookieBasedAffinity property: Cookie based affinity.
ApplicationGatewayBackendHttpSettings	withDedicatedBackendConnection(Boolean dedicatedBackendConnection) Set the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server.
ApplicationGatewayBackendHttpSettings	withHostname(String hostname) Set the hostname property: Host header to be sent to the backend servers.
ApplicationGatewayBackendHttpSettings	withId(String id)
ApplicationGatewayBackendHttpSettings	withName(String name) Set the name property: Name of the backend http settings that is unique within an Application Gateway.
ApplicationGatewayBackendHttpSettings	withPath(String path) Set the path property: Path which should be used as a prefix for all HTTP requests.
ApplicationGatewayBackendHttpSettings	withPickHostnameFromBackendAddress(Boolean pickHostnameFromBackendAddress) Set the pickHostnameFromBackendAddress property: Whether to pick host header should be picked from the host name of the backend server.
ApplicationGatewayBackendHttpSettings	withPort(Integer port) Set the port property: The destination port on the backend.
ApplicationGatewayBackendHttpSettings	withProbe(SubResource probe) Set the probe property: Probe resource of an application gateway.
ApplicationGatewayBackendHttpSettings	withProbeEnabled(Boolean probeEnabled) Set the probeEnabled property: Whether the probe is enabled.
ApplicationGatewayBackendHttpSettings	withProtocol(ApplicationGatewayProtocol protocol) Set the protocol property: The protocol used to communicate with the backend.
ApplicationGatewayBackendHttpSettings	withRequestTimeout(Integer requestTimeout) Set the requestTimeout property: Request timeout in seconds.
ApplicationGatewayBackendHttpSettings	withSniName(String sniName) Set the sniName property: Specify an SNI value to match the common name of the certificate on the backend.
ApplicationGatewayBackendHttpSettings	withTrustedRootCertificates(List<SubResource> trustedRootCertificates) Set the trustedRootCertificates property: Array of references to application gateway trusted root certificates.
ApplicationGatewayBackendHttpSettings	withValidateCertChainAndExpiry(Boolean validateCertChainAndExpiry) Set the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server.
ApplicationGatewayBackendHttpSettings	withValidateSni(Boolean validateSni) Set the validateSni property: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value.

Methods inherited from SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApplicationGatewayBackendHttpSettings

public ApplicationGatewayBackendHttpSettings()

Creates an instance of ApplicationGatewayBackendHttpSettings class.

Method Details

affinityCookieName

public String affinityCookieName()

Get the affinityCookieName property: Cookie name to use for the affinity cookie.

Returns:

the affinityCookieName value.

authenticationCertificates

public List<SubResource> authenticationCertificates()

Get the authenticationCertificates property: Array of references to application gateway authentication certificates.

Returns:

the authenticationCertificates value.

connectionDraining

public ApplicationGatewayConnectionDraining connectionDraining()

Get the connectionDraining property: Connection draining of the backend http settings resource.

Returns:

the connectionDraining value.

cookieBasedAffinity

public ApplicationGatewayCookieBasedAffinity cookieBasedAffinity()

Get the cookieBasedAffinity property: Cookie based affinity.

Returns:

the cookieBasedAffinity value.

dedicatedBackendConnection

public Boolean dedicatedBackendConnection()

Get the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server. Default is set to false.

Returns:

the dedicatedBackendConnection value.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

fromJson

public static ApplicationGatewayBackendHttpSettings fromJson(JsonReader jsonReader)

Reads an instance of ApplicationGatewayBackendHttpSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApplicationGatewayBackendHttpSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ApplicationGatewayBackendHttpSettings.

hostname

public String hostname()

Get the hostname property: Host header to be sent to the backend servers.

Returns:

the hostname value.

name

public String name()

Get the name property: Name of the backend http settings that is unique within an Application Gateway.

Returns:

the name value.

path

public String path()

Get the path property: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

Returns:

the path value.

pickHostnameFromBackendAddress

public Boolean pickHostnameFromBackendAddress()

Get the pickHostnameFromBackendAddress property: Whether to pick host header should be picked from the host name of the backend server. Default value is false.

Returns:

the pickHostnameFromBackendAddress value.

port

public Integer port()

Get the port property: The destination port on the backend.

Returns:

the port value.

probe

public SubResource probe()

Get the probe property: Probe resource of an application gateway.

Returns:

the probe value.

probeEnabled

public Boolean probeEnabled()

Get the probeEnabled property: Whether the probe is enabled. Default value is false.

Returns:

the probeEnabled value.

protocol

public ApplicationGatewayProtocol protocol()

Get the protocol property: The protocol used to communicate with the backend.

Returns:

the protocol value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the backend HTTP settings resource.

Returns:

the provisioningState value.

requestTimeout

public Integer requestTimeout()

Get the requestTimeout property: Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

Returns:

the requestTimeout value.

sniName

public String sniName()

Get the sniName property: Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null.

Returns:

the sniName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ApplicationGatewayBackendHttpSettings.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

trustedRootCertificates

public List<SubResource> trustedRootCertificates()

Get the trustedRootCertificates property: Array of references to application gateway trusted root certificates.

Returns:

the trustedRootCertificates value.

type

public String type()

Get the type property: Type of the resource.

Returns:

the type value.

validate

public void validate()

Validates the instance.

validateCertChainAndExpiry

public Boolean validateCertChainAndExpiry()

Get the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.

Returns:

the validateCertChainAndExpiry value.

validateSni

public Boolean validateSni()

Get the validateSni property: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true.

Returns:

the validateSni value.

withAffinityCookieName

public ApplicationGatewayBackendHttpSettings withAffinityCookieName(String affinityCookieName)

Set the affinityCookieName property: Cookie name to use for the affinity cookie.

Parameters:

affinityCookieName - the affinityCookieName value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withAuthenticationCertificates

public ApplicationGatewayBackendHttpSettings withAuthenticationCertificates(List<SubResource> authenticationCertificates)

Set the authenticationCertificates property: Array of references to application gateway authentication certificates.

Parameters:

authenticationCertificates - the authenticationCertificates value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withConnectionDraining

public ApplicationGatewayBackendHttpSettings withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)

Set the connectionDraining property: Connection draining of the backend http settings resource.

Parameters:

connectionDraining - the connectionDraining value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withCookieBasedAffinity

public ApplicationGatewayBackendHttpSettings withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)

Set the cookieBasedAffinity property: Cookie based affinity.

Parameters:

cookieBasedAffinity - the cookieBasedAffinity value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withDedicatedBackendConnection

public ApplicationGatewayBackendHttpSettings withDedicatedBackendConnection(Boolean dedicatedBackendConnection)

Set the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server. Default is set to false.

Parameters:

dedicatedBackendConnection - the dedicatedBackendConnection value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withHostname

public ApplicationGatewayBackendHttpSettings withHostname(String hostname)

Set the hostname property: Host header to be sent to the backend servers.

Parameters:

hostname - the hostname value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withId

public ApplicationGatewayBackendHttpSettings withId(String id)

Overrides:

ApplicationGatewayBackendHttpSettings.withId(String id)

Parameters:

id

withName

public ApplicationGatewayBackendHttpSettings withName(String name)

Set the name property: Name of the backend http settings that is unique within an Application Gateway.

Parameters:

name - the name value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withPath

public ApplicationGatewayBackendHttpSettings withPath(String path)

Set the path property: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

Parameters:

path - the path value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withPickHostnameFromBackendAddress

public ApplicationGatewayBackendHttpSettings withPickHostnameFromBackendAddress(Boolean pickHostnameFromBackendAddress)

Set the pickHostnameFromBackendAddress property: Whether to pick host header should be picked from the host name of the backend server. Default value is false.

Parameters:

pickHostnameFromBackendAddress - the pickHostnameFromBackendAddress value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withPort

public ApplicationGatewayBackendHttpSettings withPort(Integer port)

Set the port property: The destination port on the backend.

Parameters:

port - the port value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withProbe

public ApplicationGatewayBackendHttpSettings withProbe(SubResource probe)

Set the probe property: Probe resource of an application gateway.

Parameters:

probe - the probe value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withProbeEnabled

public ApplicationGatewayBackendHttpSettings withProbeEnabled(Boolean probeEnabled)

Set the probeEnabled property: Whether the probe is enabled. Default value is false.

Parameters:

probeEnabled - the probeEnabled value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withProtocol

public ApplicationGatewayBackendHttpSettings withProtocol(ApplicationGatewayProtocol protocol)

Set the protocol property: The protocol used to communicate with the backend.

Parameters:

protocol - the protocol value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withRequestTimeout

public ApplicationGatewayBackendHttpSettings withRequestTimeout(Integer requestTimeout)

Set the requestTimeout property: Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

Parameters:

requestTimeout - the requestTimeout value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withSniName

public ApplicationGatewayBackendHttpSettings withSniName(String sniName)

Set the sniName property: Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null.

Parameters:

sniName - the sniName value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withTrustedRootCertificates

public ApplicationGatewayBackendHttpSettings withTrustedRootCertificates(List<SubResource> trustedRootCertificates)

Set the trustedRootCertificates property: Array of references to application gateway trusted root certificates.

Parameters:

trustedRootCertificates - the trustedRootCertificates value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withValidateCertChainAndExpiry

public ApplicationGatewayBackendHttpSettings withValidateCertChainAndExpiry(Boolean validateCertChainAndExpiry)

Set the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.

Parameters:

validateCertChainAndExpiry - the validateCertChainAndExpiry value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withValidateSni

public ApplicationGatewayBackendHttpSettings withValidateSni(Boolean validateSni)

Set the validateSni property: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true.

Parameters:

validateSni - the validateSni value to set.

Returns:

the ApplicationGatewayBackendHttpSettings object itself.