Skip to content

Update get-networkcontrollerloadbalancingrule.md #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2017
Merged

Update get-networkcontrollerloadbalancingrule.md #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 25 additions & 1 deletion docset/windows/network-controller/get-networkcontrollerloadbalancingrule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ms.assetid: 14B8D7E0-560B-4BFB-ACEF-338E8BAE0FF5
# Get-NetworkControllerLoadBalancingRule

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

## SYNTAX

Expand All @@ -30,13 +31,19 @@ Get-NetworkControllerLoadBalancingRule [-LoadBalancerId] <String[]> [[-ResourceI
```

## 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

This example retrieves all the load balancing rules associated with a load balancer resource named lb1
```
Get-NetworkControllerLoadBalancingRule -ConnectionUri https://networkcontroller -LoadBalancerId 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 @@ -50,6 +57,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 @@ -63,6 +72,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 @@ -76,6 +87,8 @@ Accept wildcard characters: False
```

### -LoadBalancerId
Specifies the load balancer where the load balancing rule belongs.

```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -102,6 +115,7 @@ Accept wildcard characters: False
```

### -ResourceId
Specifies the unique identifier for the load balancing rule resource
```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -120,6 +134,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

## 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)

## NOTES

Expand Down