ApplicationGatewayBackendHttpSettings Class

Backend address pool settings of an application gateway.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

ApplicationGatewayBackendHttpSettings(*, id: str | None = None, name: str | None = None, port: int | None = None, protocol: str | _models.ApplicationGatewayProtocol | None = None, cookie_based_affinity: str | _models.ApplicationGatewayCookieBasedAffinity | None = None, request_timeout: int | None = None, probe: _models.SubResource | None = None, authentication_certificates: list['_models.SubResource'] | None = None, trusted_root_certificates: list['_models.SubResource'] | None = None, connection_draining: _models.ApplicationGatewayConnectionDraining | None = None, host_name: str | None = None, pick_host_name_from_backend_address: bool | None = None, affinity_cookie_name: str | None = None, probe_enabled: bool | None = None, path: str | None = None, dedicated_backend_connection: bool | None = None, validate_cert_chain_and_expiry: bool = True, validate_sni: bool = True, sni_name: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID. Default value: None
name	str Name of the backend http settings that is unique within an Application Gateway. Default value: None
port	int The destination port on the backend. Default value: None
protocol	str or ApplicationGatewayProtocol The protocol used to communicate with the backend. Known values are: "Http", "Https", "Tcp", and "Tls". Default value: None
cookie_based_affinity	str or ApplicationGatewayCookieBasedAffinity Cookie based affinity. Known values are: "Enabled" and "Disabled". Default value: None
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. Default value: None
probe	SubResource Probe resource of an application gateway. Default value: None
authentication_certificates	list[SubResource] Array of references to application gateway authentication certificates. Default value: None
trusted_root_certificates	list[SubResource] Array of references to application gateway trusted root certificates. Default value: None
connection_draining	ApplicationGatewayConnectionDraining Connection draining of the backend http settings resource. Default value: None
host_name	str Host header to be sent to the backend servers. Default value: None
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. Default value: None
affinity_cookie_name	str Cookie name to use for the affinity cookie. Default value: None
probe_enabled	bool Whether the probe is enabled. Default value is false. Default value: None
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. Default value: None
dedicated_backend_connection	bool Enable or disable dedicated connection per backend server. Default is set to false. Default value: None
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. Default value: 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. Default value: 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. Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Name of the backend http settings that is unique within an Application Gateway.
etag	str A unique read-only string that changes whenever the resource is updated.
type	str Type of the resource.
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".