Get-NetworkControllerLoadBalancingRule

This cmdlet retrieves a load balancing rule associated with a load balancer.

Syntax

Get-NetworkControllerLoadBalancingRule
   [-LoadBalancerId] <String[]>
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

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

Examples

Example 1

This example retrieves all the load balancing rules associated with a load balancer resource named lb1

Get-NetworkControllerLoadBalancingRule -ConnectionUri https://networkcontroller -LoadBalancerId lb1

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 where the load balancing rule belongs.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
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
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the unique identifier for the load balancing rule resource

Type:String[]
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Following properties of a load balancing rule can be retrieved:

  1. Front end IP configuration
  2. Back end address pool
  3. Protocol
  4. Front end port
  5. Health probe for the rule
  6. Load distribution
  7. Back End port
  8. Whether floating IP is enabled
  9. Idle timeout (in minutes)