Share via

LoadBalancer Class

  • Reference

LoadBalancer resource.

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

Constructor

LoadBalancer(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, sku: _models.LoadBalancerSku | None = None, frontend_ip_configurations: List[_models.FrontendIPConfiguration] | None = None, backend_address_pools: List[_models.BackendAddressPool] | None = None, load_balancing_rules: List[_models.LoadBalancingRule] | None = None, probes: List[_models.Probe] | None = None, inbound_nat_rules: List[_models.InboundNatRule] | None = None, inbound_nat_pools: List[_models.InboundNatPool] | None = None, outbound_rules: List[_models.OutboundRule] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
location
str

Resource location.

Default value: None
tags
dict[str, str]

Resource tags.

Default value: None
extended_location
ExtendedLocation

The extended location of the load balancer.

Default value: None
sku
LoadBalancerSku

The load balancer SKU.

Default value: None
frontend_ip_configurations
list[FrontendIPConfiguration]

Object representing the frontend IPs to be used for the load balancer.

Default value: None
backend_address_pools
list[BackendAddressPool]

Collection of backend address pools used by a load balancer.

Default value: None
load_balancing_rules
list[LoadBalancingRule]

Object collection representing the load balancing rules Gets the provisioning.

Default value: None
probes
list[Probe]

Collection of probe objects used in the load balancer.

Default value: None
inbound_nat_rules
list[InboundNatRule]

Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.

Default value: None
inbound_nat_pools
list[InboundNatPool]

Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.

Default value: None
outbound_rules
list[OutboundRule]

The outbound rules.

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location.
tags
dict[str, str]

Resource tags.
extended_location
ExtendedLocation

The extended location of the load balancer.
sku
LoadBalancerSku

The load balancer SKU.
etag
str

A unique read-only string that changes whenever the resource is updated.
frontend_ip_configurations
list[FrontendIPConfiguration]

Object representing the frontend IPs to be used for the load balancer.
backend_address_pools
list[BackendAddressPool]

Collection of backend address pools used by a load balancer.
load_balancing_rules
list[LoadBalancingRule]

Object collection representing the load balancing rules Gets the provisioning.
probes
list[Probe]

Collection of probe objects used in the load balancer.
inbound_nat_rules
list[InboundNatRule]

Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.
inbound_nat_pools
list[InboundNatPool]

Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.
outbound_rules
list[OutboundRule]

The outbound rules.
resource_guid
str

The resource GUID property of the load balancer resource.
provisioning_state
str or ProvisioningState

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