LoadBalancer interface

LoadBalancer resource

Extends

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.

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

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

resourceGuid

The resource GUID property of the load balancer resource.

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

etag

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

etag?: string

Property Value

string

frontendIPConfigurations

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

frontendIPConfigurations?: FrontendIPConfiguration[]

Property Value

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

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

loadBalancingRules

Object collection representing the load balancing rules Gets the provisioning

loadBalancingRules?: LoadBalancingRule[]

Property Value

outboundRules

The outbound rules.

outboundRules?: OutboundRule[]

Property Value

probes

Collection of probe objects used in the load balancer

probes?: Probe[]

Property Value

Probe[]

provisioningState

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

provisioningState?: string

Property Value

string

resourceGuid

The resource GUID property of the load balancer resource.

resourceGuid?: string

Property Value

string

sku

The load balancer SKU.

sku?: LoadBalancerSku

Property Value

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