Share via


ApplicationGatewayBackendHttpSettingsPropertiesFormat interface

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.

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.

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.

trustedRootCertificates

Array of references to application gateway trusted root certificates.

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

connectionDraining

Connection draining of the backend http settings resource.

connectionDraining?: ApplicationGatewayConnectionDraining

Property Value

cookieBasedAffinity

Cookie based affinity.

cookieBasedAffinity?: "Enabled" | "Disabled"

Property Value

"Enabled" | "Disabled"

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

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?: "Http" | "Https" | "Tcp" | "Tls"

Property Value

"Http" | "Https" | "Tcp" | "Tls"

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

trustedRootCertificates

Array of references to application gateway trusted root certificates.

trustedRootCertificates?: SubResource[]

Property Value