Skip to content

Commit 2ee6032

Browse files
committed
#ConnectionDraining Updated cmdlet documentation of connection draining related operations. Updated application gateway cmdlets that were not up to date.
1 parent 4699da3 commit 2ee6032

9 files changed

+75
-17
lines changed

src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayBackendHttpSettings.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Adds back-end HTTP settings to an application gateway.
1414

1515
```
1616
Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway <PSApplicationGateway> -Name <String>
17-
-Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <UInt32>] [-ProbeId <String>]
17+
-Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <UInt32>]
18+
[-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>]
1819
[-Probe <PSApplicationGatewayProbe>]
1920
[-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>]
2021
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
@@ -213,6 +214,19 @@ Accept pipeline input: False
213214
Accept wildcard characters: False
214215
```
215216
217+
### -ConnectionDraining
218+
Connection draining of the backend http settings resource.```yaml
219+
Type: PSApplicationGatewayConnectionDraining
220+
Parameter Sets: (All)
221+
Aliases:
222+
223+
Required: False
224+
Position: Named
225+
Default value: None
226+
Accept pipeline input: False
227+
Accept wildcard characters: False
228+
```
229+
216230
### CommonParameters
217231
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
218232

src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendHealth.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets application gateway backend health.
1414

1515
```
1616
Get-AzureRmApplicationGatewayBackendHealth -Name <String> -ResourceGroupName <String>
17-
[-ExpandResource <String>]
17+
[-ExpandResource <String>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -25,6 +25,8 @@ The Get-AzureRmApplicationGatewayBackendHealth cmdlet gets application gateway b
2525
### -------------------------- Example 1: Gets backend health without expanded resources. --------------------------
2626
@{paragraph=PS C:\\\>}
2727

28+
29+
2830
```
2931
PS C:\>$BackendHealth = Get-AzureRmApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01
3032
```
@@ -34,6 +36,8 @@ This command gets the backend health of application gateway named ApplicationGat
3436
### -------------------------- Example 1: Gets backend health with expanded resources. --------------------------
3537
@{paragraph=PS C:\\\>}
3638

39+
40+
3741
```
3842
PS C:\>$BackendHealth = Get-AzureRmApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 -ExpandResource "backendhealth/applicationgatewayresource"
3943
```
@@ -73,8 +77,6 @@ Accept wildcard characters: False
7377
```
7478
7579
### -ExpandResource
76-
77-
7880
```yaml
7981
Type: String
8082
Parameter Sets: (All)
@@ -87,6 +89,9 @@ Accept pipeline input: True (ByPropertyName)
8789
Accept wildcard characters: False
8890
```
8991
92+
### CommonParameters
93+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
94+
9095
## INPUTS
9196
9297
### System.String

src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayConnectionDraining.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Gets the connection draining configuration of a back-end HTTP settings object.
1313

1414
```
1515
Get-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
16+
[<CommonParameters>]
1617
```
1718

1819
## DESCRIPTION
@@ -48,16 +49,17 @@ Accept pipeline input: True (ByValue)
4849
Accept wildcard characters: False
4950
```
5051
52+
### CommonParameters
53+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
54+
5155
## INPUTS
5256
5357
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings
5458
55-
5659
## OUTPUTS
5760
5861
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining
5962
60-
6163
## NOTES
6264
6365
## RELATED LINKS

src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayBackendHttpSettings.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Creates back-end HTTP settings for an application gateway.
1414

1515
```
1616
New-AzureRmApplicationGatewayBackendHttpSettings -Name <String> -Port <Int32> -Protocol <String>
17-
-CookieBasedAffinity <String> [-RequestTimeout <UInt32>] [-ProbeId <String>]
17+
-CookieBasedAffinity <String> [-RequestTimeout <UInt32>]
18+
[-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>]
1819
[-Probe <PSApplicationGatewayProbe>]
1920
[-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>]
2021
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
@@ -196,6 +197,19 @@ Accept pipeline input: False
196197
Accept wildcard characters: False
197198
```
198199
200+
### -ConnectionDraining
201+
Connection draining of the backend http settings resource.```yaml
202+
Type: PSApplicationGatewayConnectionDraining
203+
Parameter Sets: (All)
204+
Aliases:
205+
206+
Required: False
207+
Position: Named
208+
Default value: None
209+
Accept pipeline input: False
210+
Accept wildcard characters: False
211+
```
212+
199213
### CommonParameters
200214
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
201215

src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayConnectionDraining.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Creates a new connection draining configuration for back-end HTTP settings.
1313

1414
```
1515
New-AzureRmApplicationGatewayConnectionDraining -Enabled <Boolean> -DrainTimeoutInSec <UInt32>
16+
[<CommonParameters>]
1617
```
1718

1819
## DESCRIPTION
@@ -60,16 +61,17 @@ Accept pipeline input: False
6061
Accept wildcard characters: False
6162
```
6263
64+
### CommonParameters
65+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
66+
6367
## INPUTS
6468
6569
### None
6670
67-
6871
## OUTPUTS
6972
7073
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining
7174
72-
7375
## NOTES
7476
7577
## RELATED LINKS

src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayConnectionDraining.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Removes the connection draining configuration of a back-end HTTP settings object
1313

1414
```
1515
Remove-AzureRmApplicationGatewayConnectionDraining
16-
-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
16+
-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -49,16 +49,17 @@ Accept pipeline input: True (ByValue)
4949
Accept wildcard characters: False
5050
```
5151
52+
### CommonParameters
53+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
54+
5255
## INPUTS
5356
5457
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings
5558
56-
5759
## OUTPUTS
5860
5961
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings
6062
61-
6263
## NOTES
6364
6465
## RELATED LINKS

src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewaySslPolicy.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Removes an SSL policy from an Azure application gateway.
1414

1515
```
1616
Remove-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> [-Force] [-WhatIf]
17-
[-Confirm]
17+
[-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -25,6 +25,8 @@ The Remove-AzureRmApplicationGatewaySslPolicy cmdlet removes SSL policy from an
2525
### -------------------------- Example 1: Remove an SSL policy from an application gateway --------------------------
2626
@{paragraph=PS C:\\\>}
2727

28+
29+
2830
```
2931
PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
3032
PS C:\> $AppGW = Remove-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $AppGW
@@ -95,6 +97,9 @@ Accept pipeline input: False
9597
Accept wildcard characters: False
9698
```
9799
100+
### CommonParameters
101+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
102+
98103
## INPUTS
99104
100105
### System.String

src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayBackendHttpSettings.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Updates back-end HTTP settings for an application gateway.
1414

1515
```
1616
Set-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway <PSApplicationGateway> -Name <String>
17-
-Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <UInt32>] [-ProbeId <String>]
17+
-Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <UInt32>]
18+
[-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>]
1819
[-Probe <PSApplicationGatewayProbe>]
1920
[-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>]
2021
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
@@ -215,6 +216,19 @@ Accept pipeline input: False
215216
Accept wildcard characters: False
216217
```
217218
219+
### -ConnectionDraining
220+
Connection draining of the backend http settings resource.```yaml
221+
Type: PSApplicationGatewayConnectionDraining
222+
Parameter Sets: (All)
223+
Aliases:
224+
225+
Required: False
226+
Position: Named
227+
Default value: None
228+
Accept pipeline input: False
229+
Accept wildcard characters: False
230+
```
231+
218232
### CommonParameters
219233
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
220234

src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayConnectionDraining.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Modifies the connection draining configuration of a back-end HTTP settings objec
1313

1414
```
1515
Set-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
16-
-Enabled <Boolean> -DrainTimeoutInSec <UInt32>
16+
-Enabled <Boolean> -DrainTimeoutInSec <UInt32> [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -80,16 +80,17 @@ Accept pipeline input: False
8080
Accept wildcard characters: False
8181
```
8282
83+
### CommonParameters
84+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
85+
8386
## INPUTS
8487
8588
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings
8689
87-
8890
## OUTPUTS
8991
9092
### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings
9193
92-
9394
## NOTES
9495
9596
## RELATED LINKS

0 commit comments

Comments
 (0)