Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ms.assetid: 50F1391A-5F42-4A61-B3C6-9FE0815A01D5
# Get-NetworkControllerLoadBalancer

## SYNOPSIS
This cmdlet retrieves the configuration of a load balancer resource from the Network Controller

## SYNTAX

Expand All @@ -29,13 +30,24 @@ Get-NetworkControllerLoadBalancer [[-ResourceId] <String[]>] -ConnectionUri <Uri
```

## DESCRIPTION
This cmdlet retrieves the configuration of a load balancer resource. 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:
1. 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.
2. BackEnd address pools - This describes the backend VMs behind the front end IP resource.
3. Load balancing rules - This defines how traffic that arrives at the front-end IP is to be sent to the backend IP
4. Health probe - Health probes are used by the load balancer to determine the health state of the backend pool members.
5. Inbound NAT rules - This can be used to forward external traffic to a specific VM in the virtual network
6. 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


This example retrieves the configuration of a load balancer resource named lb1 from the Network Controller
```
Get-NetworkControllerLoadBalancer -ConnectionUri https://networkcontroller -ResourceId lb1
```
## 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.

```yaml
Type: String
Parameter Sets: (All)
Expand All @@ -49,6 +61,8 @@ Accept wildcard characters: False
```

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

```yaml
Type: Uri
Parameter Sets: (All)
Expand All @@ -62,6 +76,8 @@ 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.

```yaml
Type: PSCredential
Parameter Sets: (All)
Expand All @@ -88,6 +104,8 @@ Accept wildcard characters: False
```

### -ResourceId
Specifies the unique identifier for the load balancer resource.

```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -106,7 +124,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

## OUTPUTS

Following properties can be retrieved for a load balancer resource:
1. Front end IP configuration
2. Back end address pools
3. Load balancing rules
4. Inbound NAT rules
5. Outbound NAT rules
6. Health Probes
## NOTES

## RELATED LINKS
Expand Down