Dela via

ApplicationGatewayBackendSettings 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

ApplicationGatewayBackendSettings(*, id: str | None = None, name: str | None = None, port: int | None = None, protocol: str | _models.ApplicationGatewayProtocol | None = None, timeout: int | None = None, probe: _models.SubResource | None = None, trusted_root_certificates: List[_models.SubResource] | None = None, host_name: str | None = None, pick_host_name_from_backend_address: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
name
str

Name of the backend 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
timeout
int

Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.

Default value: None
probe
SubResource

Probe resource of an application gateway.

Default value: None
trusted_root_certificates
list[SubResource]

Array of references to application gateway trusted root certificates.

Default value: None
host_name
str

Server name indication to be sent to the backend servers for Tls protocol.

Default value: None
pick_host_name_from_backend_address
bool

Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Name of the backend 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".
timeout
int

Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.
probe
SubResource

Probe resource of an application gateway.
trusted_root_certificates
list[SubResource]

Array of references to application gateway trusted root certificates.
host_name
str

Server name indication to be sent to the backend servers for Tls protocol.
pick_host_name_from_backend_address
bool

Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.
provisioning_state
str or ProvisioningState

The provisioning state of the backend HTTP settings resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".