LoadBalancer interface

Package:

@azure/arm-network

LoadBalancer resource.

Extends

Resource

Properties

backendAddressPools	Collection of backend address pools used by a load balancer.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation	The extended location of the load balancer.
frontendIPConfigurations	Object representing the frontend IPs to be used for the load balancer.
inboundNatPools	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.
inboundNatRules	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.
loadBalancingRules	Object collection representing the load balancing rules Gets the provisioning.
outboundRules	The outbound rules.
probes	Collection of probe objects used in the load balancer.
provisioningState	The provisioning state of the load balancer resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid	The resource GUID property of the load balancer resource. NOTE: This property will not be serialized. It can only be populated by the server.
sku	The load balancer SKU.

Inherited Properties

id	Resource ID.
location	Resource location.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

backendAddressPools

Collection of backend address pools used by a load balancer.

backendAddressPools?: BackendAddressPool[]

Property Value

BackendAddressPool[]

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

extendedLocation

The extended location of the load balancer.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

frontendIPConfigurations

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

frontendIPConfigurations?: FrontendIPConfiguration[]

Property Value

FrontendIPConfiguration[]

inboundNatPools

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.

inboundNatPools?: InboundNatPool[]

Property Value

InboundNatPool[]

inboundNatRules

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.

inboundNatRules?: InboundNatRule[]

Property Value

InboundNatRule[]

loadBalancingRules

Object collection representing the load balancing rules Gets the provisioning.

loadBalancingRules?: LoadBalancingRule[]

Property Value

LoadBalancingRule[]

outboundRules

The outbound rules.

outboundRules?: OutboundRule[]

Property Value

OutboundRule[]

probes

Collection of probe objects used in the load balancer.

probes?: Probe[]

Property Value

Probe[]

provisioningState

The provisioning state of the load balancer resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceGuid

The resource GUID property of the load balancer resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

sku

The load balancer SKU.

sku?: LoadBalancerSku

Property Value

LoadBalancerSku

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type