Share via

BackendAddressPool Class

  • Reference

Pool of backend IP addresses.

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

Constructor

BackendAddressPool(*, id: str | None = None, name: str | None = None, location: str | None = None, tunnel_interfaces: List[_models.GatewayLoadBalancerTunnelInterface] | None = None, load_balancer_backend_addresses: List[_models.LoadBalancerBackendAddress] | None = None, drain_period_in_seconds: int | None = None, virtual_network: _models.SubResource | None = None, sync_mode: str | _models.SyncMode | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
name
str

The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.

Default value: None
location
str

The location of the backend address pool.

Default value: None
tunnel_interfaces
list[GatewayLoadBalancerTunnelInterface]

An array of gateway load balancer tunnel interfaces.

Default value: None
load_balancer_backend_addresses
list[LoadBalancerBackendAddress]

An array of backend addresses.

Default value: None
drain_period_in_seconds
int

Amount of seconds Load Balancer waits for before sending RESET to client and backend address.

Default value: None
virtual_network
SubResource

A reference to a virtual network.

Default value: None
sync_mode
str or SyncMode

Backend address synchronous mode for the backend pool. Known values are: "Automatic" and "Manual".

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.
etag
str

A unique read-only string that changes whenever the resource is updated.
type
str

Type of the resource.
location
str

The location of the backend address pool.
tunnel_interfaces
list[GatewayLoadBalancerTunnelInterface]

An array of gateway load balancer tunnel interfaces.
load_balancer_backend_addresses
list[LoadBalancerBackendAddress]

An array of backend addresses.
backend_ip_configurations
list[NetworkInterfaceIPConfiguration]

An array of references to IP addresses defined in network interfaces.
load_balancing_rules
list[SubResource]

An array of references to load balancing rules that use this backend address pool.
outbound_rule
SubResource

A reference to an outbound rule that uses this backend address pool.
outbound_rules
list[SubResource]

An array of references to outbound rules that use this backend address pool.
inbound_nat_rules
list[SubResource]

An array of references to inbound NAT rules that use this backend address pool.
provisioning_state
str or ProvisioningState

The provisioning state of the backend address pool resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
drain_period_in_seconds
int

Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
virtual_network
SubResource

A reference to a virtual network.
sync_mode
str or SyncMode

Backend address synchronous mode for the backend pool. Known values are: "Automatic" and "Manual".