Skip to content

Commit a1a50ee

Browse files
authored
Update get-networkcontrollerloadbalancingrule.md
Added description and example
1 parent fac31dd commit a1a50ee

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docset/windows/network-controller/get-networkcontrollerloadbalancingrule.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ms.assetid: 14B8D7E0-560B-4BFB-ACEF-338E8BAE0FF5
2020
# Get-NetworkControllerLoadBalancingRule
2121

2222
## SYNOPSIS
23+
This cmdlet retrieves a load balancing rule associated with a load balancer.
2324

2425
## SYNTAX
2526

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

3233
## DESCRIPTION
34+
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
3335

3436
## EXAMPLES
35-
37+
This example retrieves all the load balancing rules associated with a load balancer resource named lb1
38+
```
39+
Get-NetworkControllerLoadBalancingRule -ConnectionUri https://networkcontroller -LoadBalancerId lb1
40+
```
3641

3742
## PARAMETERS
3843

3944
### -CertificateThumbprint
45+
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.
46+
4047
```yaml
4148
Type: String
4249
Parameter Sets: (All)
@@ -50,6 +57,8 @@ Accept wildcard characters: False
5057
```
5158
5259
### -ConnectionUri
60+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
61+
5362
```yaml
5463
Type: Uri
5564
Parameter Sets: (All)
@@ -63,6 +72,8 @@ Accept wildcard characters: False
6372
```
6473
6574
### -Credential
75+
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.
76+
6677
```yaml
6778
Type: PSCredential
6879
Parameter Sets: (All)
@@ -76,6 +87,8 @@ Accept wildcard characters: False
7687
```
7788
7889
### -LoadBalancerId
90+
Specifies the load balancer where the load balancing rule belongs.
91+
7992
```yaml
8093
Type: String[]
8194
Parameter Sets: (All)
@@ -102,6 +115,7 @@ Accept wildcard characters: False
102115
```
103116
104117
### -ResourceId
118+
Specifies the unique identifier for the load balancing rule resource
105119
```yaml
106120
Type: String[]
107121
Parameter Sets: (All)
@@ -120,6 +134,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
120134
## INPUTS
121135
122136
## OUTPUTS
137+
Following properties of a load balancing rule can be retrieved:
138+
1. Front end IP configuration
139+
2. Back end address pool
140+
3. Protocol
141+
4. Front end port
142+
5. Health probe for the rule
143+
6. Load distribution
144+
7. Back End port
145+
8. Whether floating IP is enabled
146+
9. Idle timeout (in minutes)
123147
124148
## NOTES
125149

0 commit comments

Comments
 (0)