ApplicationGatewayBackendHttpSettingsPropertiesFormat Class

Package:
com.azure.resourcemanager.network.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-network:2.59.0
  • java.lang.Object
    • com.azure.resourcemanager.network.fluent.models.ApplicationGatewayBackendHttpSettingsPropertiesFormat

Implements

JsonSerializable<ApplicationGatewayBackendHttpSettingsPropertiesFormat>

public final class ApplicationGatewayBackendHttpSettingsPropertiesFormat
implements JsonSerializable<ApplicationGatewayBackendHttpSettingsPropertiesFormat>

Properties of Backend address pool settings of an application gateway.

Constructor Summary

Constructor Description
ApplicationGatewayBackendHttpSettingsPropertiesFormat()

Creates an instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat 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.
static ApplicationGatewayBackendHttpSettingsPropertiesFormat fromJson(JsonReader jsonReader)

Reads an instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat from the JsonReader.
String hostname()

Get the hostname property: Host header to be sent to the backend servers.
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.
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.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withAffinityCookieName(String affinityCookieName)

Set the affinityCookieName property: Cookie name to use for the affinity cookie.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withAuthenticationCertificates(List<SubResource> authenticationCertificates)

Set the authenticationCertificates property: Array of references to application gateway authentication certificates.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)

Set the connectionDraining property: Connection draining of the backend http settings resource.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)

Set the cookieBasedAffinity property: Cookie based affinity.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withDedicatedBackendConnection(Boolean dedicatedBackendConnection)

Set the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withHostname(String hostname)

Set the hostname property: Host header to be sent to the backend servers.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withPath(String path)

Set the path property: Path which should be used as a prefix for all HTTP requests.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withPickHostnameFromBackendAddress(Boolean pickHostnameFromBackendAddress)

Set the pickHostnameFromBackendAddress property: Whether to pick host header should be picked from the host name of the backend server.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withPort(Integer port)

Set the port property: The destination port on the backend.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withProbe(SubResource probe)

Set the probe property: Probe resource of an application gateway.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withProbeEnabled(Boolean probeEnabled)

Set the probeEnabled property: Whether the probe is enabled.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withProtocol(ApplicationGatewayProtocol protocol)

Set the protocol property: The protocol used to communicate with the backend.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withRequestTimeout(Integer requestTimeout)

Set the requestTimeout property: Request timeout in seconds.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withSniName(String sniName)

Set the sniName property: Specify an SNI value to match the common name of the certificate on the backend.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withTrustedRootCertificates(List<SubResource> trustedRootCertificates)

Set the trustedRootCertificates property: Array of references to application gateway trusted root certificates.
ApplicationGatewayBackendHttpSettingsPropertiesFormat withValidateCertChainAndExpiry(Boolean validateCertChainAndExpiry)

Set the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server.
ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApplicationGatewayBackendHttpSettingsPropertiesFormat

public ApplicationGatewayBackendHttpSettingsPropertiesFormat()

Creates an instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat 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.

fromJson

public static ApplicationGatewayBackendHttpSettingsPropertiesFormat fromJson(JsonReader jsonReader)

Reads an instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat.

hostname

public String hostname()

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

Returns:

the hostname 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)

Parameters:

jsonWriter

Throws:

trustedRootCertificates

public List<SubResource> trustedRootCertificates()

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

Returns:

the trustedRootCertificates 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat withAffinityCookieName(String affinityCookieName)

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

Parameters:

affinityCookieName - the affinityCookieName value to set.

Returns:

the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withAuthenticationCertificates

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withConnectionDraining

public ApplicationGatewayBackendHttpSettingsPropertiesFormat withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)

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

Parameters:

connectionDraining - the connectionDraining value to set.

Returns:

the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withCookieBasedAffinity

public ApplicationGatewayBackendHttpSettingsPropertiesFormat withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)

Set the cookieBasedAffinity property: Cookie based affinity.

Parameters:

cookieBasedAffinity - the cookieBasedAffinity value to set.

Returns:

the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withDedicatedBackendConnection

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withHostname

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withPath

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withPickHostnameFromBackendAddress

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withPort

public ApplicationGatewayBackendHttpSettingsPropertiesFormat withPort(Integer port)

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

Parameters:

port - the port value to set.

Returns:

the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withProbe

public ApplicationGatewayBackendHttpSettingsPropertiesFormat withProbe(SubResource probe)

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

Parameters:

probe - the probe value to set.

Returns:

the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withProbeEnabled

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withProtocol

public ApplicationGatewayBackendHttpSettingsPropertiesFormat withProtocol(ApplicationGatewayProtocol protocol)

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

Parameters:

protocol - the protocol value to set.

Returns:

the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withRequestTimeout

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withSniName

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withTrustedRootCertificates

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withValidateCertChainAndExpiry

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

withValidateSni

public ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

Applies to