New-NetworkControllerLoadBalancingRule

This cmdlet adds/updates a load balancing rule associated with a load balancer.

Syntax

New-NetworkControllerLoadBalancingRule
   -ConnectionUri <Uri>
   -LoadBalancerId <string>
   -Properties <LoadBalancingRuleProperties>
   -ResourceId <string>
   [-CertificateThumbPrint <string>]
   [-Credential <PSCredential>]
   [-Etag <string>]
   [-Force]
   [-ResourceMetadata <ResourceMetadata>]

Description

This cmdlet adds/updates a load balancing rule associated with a load balancer. This load balancing rule defines how traffic that arrives at the front-end IP is to be sent to the backend IP

Examples

Example 1

This example creates a new load balancing rule associated with load balancer resource lb1. The example creates front end IP configuration resource, health probe resource, backend address pool resource and finally load balancing rule resource.

//Retrieve the subnet for front end IP
$subnet = Get-NetworkControllerSubnet -ConnectionUri https://networkcontroller -NetworkId ln1 -ResourceId subnet1

//Create the front end IP resource
$frontEndIp=New-Object Microsoft.Windows.NetworkController.LoadBalancerFrontEndIpConfigurationProperties
$frontEndIp.PrivateIpAddress="10.127.32.12"
$frontEndIp.PrivateIPAllocationMethod="Static"

//Add the front end IP resource to Network Controller
$lbfrontEndIP = New-NetworkControllerLoadBalancerFrontEndIpConfiguration -ConnectionUri https://networkcontroller -LoadBalancerId lb1 -ResourceId front1 -Properties $frontEndIp

//Create a probe object and add it to Network Controller
$probe=New-Object Microsoft.Windows.NetworkController.LoadBalancerProbeProperties
$probe.protocol="HTTP"
$probe.port="80"
$probe.RequestPath="/health.htm"
$probe.IntervalInSeconds=5
$probe.NumberofProbes=8
$lbProbe=New-NetworkControllerLoadBalancerProbe -ConnectionUri https://networkcontroller -LoadBalance

Required Parameters

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LoadBalancerId

Specifies the load balancer resource where the load balancing rule belongs

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Properties

Specifies the properties of the load balancing rule

Type:LoadBalancingRuleProperties
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the unique identifier of the load balancing rule

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-CertificateThumbPrint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate. This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a user credential that has permission to perform this action. The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Etag

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:switch
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceMetadata

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

Type:ResourceMetadata
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Following properties of a load balancing rule can be added/changed:

  • Front end IP configuration
  • Back end address pool
  • Protocol
  • Front end port
  • Health probe for the rule
  • Load distribution
  • Back End port
  • Whether floating IP is enabled
  • Idle timeout (in minutes)