Skip to content

Commit 6b90ff0

Browse files
authored
Update get-networkcontrollerloadbalancerprobe.md
Added descriptions and example
1 parent fac31dd commit 6b90ff0

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

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

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ms.assetid: 3DE80088-3F0E-4BBA-8A9C-C6259BBF5CBD
2020
# Get-NetworkControllerLoadBalancerProbe
2121

2222
## SYNOPSIS
23+
This cmdlet retrieves the health probes associated with a load balancer resource
2324

2425
## SYNTAX
2526

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

3233
## DESCRIPTION
34+
This cmdlet retrieves the health probes associated with a load balancer resource. Health probes are used by the load balancer to determine the health state of the backend pool members.
3335

3436
## EXAMPLES
35-
36-
37+
This example retrieves all the health probe rules associated with the load balancer resource named lb1
38+
```
39+
Get-NetworkControllerLoadBalancerProbe -ConnectionUri https://networkcontroller -LoadBalancerId lb1
40+
```
3741
## PARAMETERS
3842

3943
### -CertificateThumbprint
44+
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.
45+
4046
```yaml
4147
Type: String
4248
Parameter Sets: (All)
@@ -50,6 +56,8 @@ Accept wildcard characters: False
5056
```
5157
5258
### -ConnectionUri
59+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
60+
5361
```yaml
5462
Type: Uri
5563
Parameter Sets: (All)
@@ -63,6 +71,8 @@ Accept wildcard characters: False
6371
```
6472
6573
### -Credential
74+
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.
75+
6676
```yaml
6777
Type: PSCredential
6878
Parameter Sets: (All)
@@ -76,6 +86,8 @@ Accept wildcard characters: False
7686
```
7787
7888
### -LoadBalancerId
89+
Specifies the load balancer where the halth probe belongs
90+
7991
```yaml
8092
Type: String[]
8193
Parameter Sets: (All)
@@ -102,6 +114,8 @@ Accept wildcard characters: False
102114
```
103115
104116
### -ResourceId
117+
Specifies the unique identifier for the health probe reource.
118+
105119
```yaml
106120
Type: String[]
107121
Parameter Sets: (All)
@@ -120,7 +134,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
120134
## INPUTS
121135
122136
## OUTPUTS
123-
137+
Following properties can be retrieved for a load balancer probe:
138+
1. Protocol
139+
2. Port
140+
3. Request path that has to be probed
141+
4. Probe interval (in seconds)
142+
5. Number of retries after which a backend resource is deemed unhealthy
143+
6. Load balancing rules that are associated with this probe
124144
## NOTES
125145
126146
## RELATED LINKS

0 commit comments

Comments
 (0)