New-NetworkControllerLoadBalancer

Syntax

New-NetworkControllerLoadBalancer
   [-ResourceId] <String>
   [[-Tags] <PSObject>]
   [-Properties] <LoadBalancerProperties>
   [[-Etag] <String>]
   [[-ResourceMetadata] <ResourceMetadata>]
   [-Force]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The load balancer resource allows fine-grained configuration of how incoming traffic is distributed across VM instances in a virtual network.

It contains the following:

Front End IP configuration - This describes the exposed IP address of the load balancer. For example, this address can be a reserved public or private IP address previously obtained by the customer, or an IP address dynamically allocated from a subnet of a virtual network.

BackEnd address pools - This describes the backend VMs behind the front end IP resource.

Load balancing rules - This defines how traffic that arrives at the front-end IP is to be sent to the backend IP

Health probe - Health probes are used by the load balancer to determine the health state of the backend pool members.

Inbound NAT rules - This can be used to forward external traffic to a specific VM in the virtual network

Outbound NAT rules - This can be used to forward VM network traffic from the virtual network to external destinations using network address translation (NAT).

Examples

Example 1

This example creates a public VIP for load balancing a pool of two VMs on a virtual network. This also adds a HTTP health probe to detect whether one of the pool members becomes non-responsive.

//Prepare the load balancer object
$lbresourceId = "LB2"

$lbproperties = @{}
$lbproperties.frontendipconfigurations = @()
$lbproperties.backendAddressPools = @()
$lbproperties.probes = @()
$lbproperties.loadbalancingRules = @()
$lbproperties.OutboundNatRules = @()

//Assign front end IP
$vipip = "10.127.132.5"
$vipln = get-networkcontrollerlogicalnetwork -ConnectionUri $uri -resourceid "f8f67956-3906-4303-94c5-09cf91e7e311"

$fe = @{}
$fe.resourceId = "FE1"
$fe.resourceRef = "/loadBalancers/$lbresourceId/frontendIPConfigurations/$($fe.resourceId)"
$fe.properties = @{}
$fe.properties.subnet = @{}
$fe.properties.subnet.ResourceRef = $vipln.properties.Subnets[0].ResourceRef
$fe.properties.privateIPAddress = $vipip
$fe.properties.privateIPAllocationMethod = "Static"
$lbproperties.frontendipconfigurations += $fe

//Allocate backend address pool
$backend = @{}
$backend.resourceId = "BE1"
$backend.resourceRef = "/loadBalancers/$lbresourceId/backendAddressPools/$($b)"
$lbproperties.backendAddressPools += $backend

//Define health probe
$lbprobe = @{}
$lbprobe.ResourceId = "Probe1"
$lbprobe.resourceRef = "/loadBalancers/$lbresourceId/Probes/$($lbprobe.resourceId)"
$lbprobe.properties = @{}
$lbprobe.properties.protocol = "HTTP"
$lbprobe.properties.port = "80"
$lbprobe.properties.RequestPath = "/health.htm"
$lbprobe.properties.IntervalInSeconds = 5
$lbprobe.properties.NumberOfProbes = 11
$lbproperties.probes += $lbprobe

//Define load balancing rule
$lbrule = @{}
$lbrule.ResourceId = "webserver1"
$lbrule.properties = @{}
$lbrule.properties.FrontEndIPConfigurations = @()
$lbrule.properties.FrontEndIPConfigurations += $fe
$lbrule.properties.backendaddresspool = $backend 
$lbrule.properties.protocol = "TCP"
$lbrule.properties.frontendPort = 80
$lbrule.properties.Probe = $lbprobe
$lbproperties.loadbalancingRules += $lbrule

//Add the load balancer to Network Controller
New-NetworkControllerLoadBalancer -ConnectionUri https://networkcontroller -ResourceId $lbresourceId -Properties $lbproperties

Parameters

-CertificateThumbPrint

-Confirm

-ConnectionUri

-Credential

-Etag

-Force

-PassInnerException

-Properties

-ResourceId

-ResourceMetadata

-Tags

-WhatIf

Inputs

String

Microsoft.Windows.NetworkController.LoadBalancerProperties

Following properties can be added/modified for a load balancer resource:

• Front end IP configuration
• Back end address pool
• Health probe
• Load balancing rule
• Outbound NAT rules
• Inbound NAT rules

Outputs

Object