ApplicationGatewayBackendHttpSettingsPropertiesFormat Class

Properties of Backend address pool settings of an application gateway.

Constructor

ApplicationGatewayBackendHttpSettingsPropertiesFormat(*args: Any, **kwargs: Any)

Variables

Name	Description
port	int The destination port on the backend.
protocol	str or ApplicationGatewayProtocol The protocol used to communicate with the backend. Known values are: "Http", "Https", "Tcp", and "Tls".
cookie_based_affinity	str or ApplicationGatewayCookieBasedAffinity Cookie based affinity. Known values are: "Enabled" and "Disabled".
request_timeout	int 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.
probe	SubResource Probe resource of an application gateway.
authentication_certificates	list[SubResource] Array of references to application gateway authentication certificates.
trusted_root_certificates	list[SubResource] Array of references to application gateway trusted root certificates.
connection_draining	ApplicationGatewayConnectionDraining Connection draining of the backend http settings resource.
host_name	str Host header to be sent to the backend servers.
pick_host_name_from_backend_address	bool Whether to pick host header should be picked from the host name of the backend server. Default value is false.
affinity_cookie_name	str Cookie name to use for the affinity cookie.
probe_enabled	bool Whether the probe is enabled. Default value is false.
path	str Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.
dedicated_backend_connection	bool Enable or disable dedicated connection per backend server. Default is set to false.
validate_cert_chain_and_expiry	bool Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.
validate_sni	bool 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.
sni_name	str 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.
provisioning_state	str or ProvisioningState The provisioning state of the backend HTTP settings resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

Attributes

affinity_cookie_name

Cookie name to use for the affinity cookie.

affinity_cookie_name: str | None

authentication_certificates

Array of references to application gateway authentication certificates.

authentication_certificates: list['_models.SubResource'] | None

connection_draining

Connection draining of the backend http settings resource.

connection_draining: _models.ApplicationGatewayConnectionDraining | None

cookie_based_affinity

"Enabled" and "Disabled".

cookie_based_affinity: str | _models.ApplicationGatewayCookieBasedAffinity | None

dedicated_backend_connection

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

dedicated_backend_connection: bool | None

host_name

Host header to be sent to the backend servers.

host_name: str | None

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: str | None

pick_host_name_from_backend_address

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

pick_host_name_from_backend_address: bool | None

port

The destination port on the backend.

port: int | None

probe

Probe resource of an application gateway.

probe: _models.SubResource | None

probe_enabled

Whether the probe is enabled. Default value is false.

probe_enabled: bool | None

protocol

"Http", "Https", "Tcp", and "Tls".

protocol: str | _models.ApplicationGatewayProtocol | None

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

request_timeout

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.

request_timeout: int | None

sni_name

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.

sni_name: str | None

trusted_root_certificates

Array of references to application gateway trusted root certificates.

trusted_root_certificates: list['_models.SubResource'] | None

validate_cert_chain_and_expiry

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

validate_cert_chain_and_expiry: bool | None

validate_sni

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.

validate_sni: bool | None