ApplicationGatewayBackendHttpSettingsPropertiesFormat interface

Package:
@azure/arm-network

Properties of Backend address pool settings of an application gateway.

Properties

affinityCookieName

Cookie name to use for the affinity cookie.
authenticationCertificates

Array of references to application gateway authentication certificates.
connectionDraining

Connection draining of the backend http settings resource.
cookieBasedAffinity

Cookie based affinity.
dedicatedBackendConnection

Enable or disable dedicated connection per backend server. Default is set to false.
hostName

Host header to be sent to the backend servers.
path

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

Whether to pick host header should be picked from the host name of the backend server. Default value is false.
port

The destination port on the backend.
probe

Probe resource of an application gateway.
probeEnabled

Whether the probe is enabled. Default value is false.
protocol

The protocol used to communicate with the backend.
provisioningState

The provisioning state of the backend HTTP settings resource.
requestTimeout

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.
sniName

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.
trustedRootCertificates

Array of references to application gateway trusted root certificates.
validateCertChainAndExpiry

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

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.

Property Details

affinityCookieName

Cookie name to use for the affinity cookie.

affinityCookieName?: string

Property Value

string

authenticationCertificates

Array of references to application gateway authentication certificates.

authenticationCertificates?: SubResource[]

Property Value

SubResource[]

connectionDraining

Connection draining of the backend http settings resource.

connectionDraining?: ApplicationGatewayConnectionDraining

Property Value

ApplicationGatewayConnectionDraining

cookieBasedAffinity

Cookie based affinity.

cookieBasedAffinity?: string

Property Value

string

dedicatedBackendConnection

Enable or disable dedicated connection per backend server. Default is set to false.

dedicatedBackendConnection?: boolean

Property Value

boolean

hostName

Host header to be sent to the backend servers.

hostName?: string

Property Value

string

path

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

path?: string

Property Value

string

pickHostNameFromBackendAddress

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

pickHostNameFromBackendAddress?: boolean

Property Value

boolean

port

The destination port on the backend.

port?: number

Property Value

number

probe

Probe resource of an application gateway.

probe?: SubResource

Property Value

SubResource

probeEnabled

Whether the probe is enabled. Default value is false.

probeEnabled?: boolean

Property Value

boolean

protocol

The protocol used to communicate with the backend.

protocol?: string

Property Value

string

provisioningState

The provisioning state of the backend HTTP settings resource.

provisioningState?: string

Property Value

string

requestTimeout

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.

requestTimeout?: number

Property Value

number

sniName

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.

sniName?: string

Property Value

string

trustedRootCertificates

Array of references to application gateway trusted root certificates.

trustedRootCertificates?: SubResource[]

Property Value

SubResource[]

validateCertChainAndExpiry

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

validateCertChainAndExpiry?: boolean

Property Value

boolean

validateSNI

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.

validateSNI?: boolean

Property Value

boolean