Skip to content

Commit 8d9609d

Browse files
Resolved application gateway example issues. (#19526)
* Resolved application gateway example issues. * Updated the online versions in the help files * Remove the tabs Co-authored-by: wyunchi-ms <[email protected]>
1 parent 6686078 commit 8d9609d

15 files changed

+276
-92
lines changed

src/Network/Network/help/Add-AzApplicationGatewayBackendSetting.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/add-azapplicationgatewaybackendsetting
55
schema: 2.0.0
66
---
77

88
# Add-AzApplicationGatewayBackendSetting
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Adds back-end TCP\TLS settings to an application gateway.
1212

1313
## SYNTAX
1414

@@ -20,21 +20,23 @@ Add-AzApplicationGatewayBackendSetting -ApplicationGateway <PSApplicationGateway
2020
```
2121

2222
## DESCRIPTION
23-
{{ Fill in the Description }}
23+
The Add-AzApplicationGatewayBackendSetting cmdlet adds back-end TCP\TLS settings to an application gateway.
24+
Back-end settings are applied to all back-end servers in the pool.
2425

2526
## EXAMPLES
2627

27-
### Example 1
28+
### Example 1: Add back-end TCP\TLS settings to an application gateway
2829
```powershell
29-
PS C:\> {{ Add example code here }}
30+
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
31+
$AppGw = Add-AzApplicationGatewayBackendSetting -ApplicationGateway $Appgw -Name "Setting01" -Port 88 -Protocol TCP
3032
```
3133

32-
{{ Add example description here }}
34+
The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable.The second command adds back-end settings to the application gateway, setting the port to 88 and the protocol to TCP and names the settings Setting01.
3335

3436
## PARAMETERS
3537

3638
### -ApplicationGateway
37-
The applicationGateway
39+
Specifies the name of application gateway for which this cmdlet adds settings.
3840

3941
```yaml
4042
Type: PSApplicationGateway
@@ -214,3 +216,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
214216
## NOTES
215217
216218
## RELATED LINKS
219+
220+
[Get-AzApplicationGatewayBackendSetting](./Get-AzApplicationGatewayBackendSetting.md)
221+
222+
[New-AzApplicationGatewayBackendSetting](./New-AzApplicationGatewayBackendSetting.md)
223+
224+
[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md)
225+
226+
[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md)

src/Network/Network/help/Add-AzApplicationGatewayListener.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/add-azapplicationgatewaylistener
55
schema: 2.0.0
66
---
77

88
# Add-AzApplicationGatewayListener
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Adds an listener to an application gateway.
1212

1313
## SYNTAX
1414

@@ -29,16 +29,17 @@ Add-AzApplicationGatewayListener -ApplicationGateway <PSApplicationGateway> -Nam
2929
```
3030

3131
## DESCRIPTION
32-
{{ Fill in the Description }}
32+
The **Add-AzApplicationGatewayListener** cmdlet adds a TCP\TLS listener to an application gateway.
3333

3434
## EXAMPLES
3535

36-
### Example 1
36+
### Example 1: Add a listener
3737
```powershell
38-
PS C:\> {{ Add example code here }}
38+
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
39+
$AppGw = Add-AzApplicationGatewayListener -ApplicationGateway $Appgw -Name "Listener01" -Protocol "TCP" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01
3940
```
4041

41-
{{ Add example description here }}
42+
The first command gets the application gateway and stores it in the $AppGw variable.The second command adds the listener to the application gateway.
4243

4344
## PARAMETERS
4445

@@ -237,3 +238,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
237238
## NOTES
238239
239240
## RELATED LINKS
241+
242+
[Get-AzApplicationGatewayListener](./Get-AzApplicationGatewayListener.md)
243+
244+
[New-AzApplicationGatewayListener](./New-AzApplicationGatewayListener.md)
245+
246+
[Remove-AzApplicationGatewayListener](./Remove-AzApplicationGatewayListener.md)
247+
248+
[Set-AzApplicationGatewayListener](./Set-AzApplicationGatewayListener.md)

src/Network/Network/help/Add-AzApplicationGatewayRoutingRule.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/add-azapplicationgatewayroutingrule
55
schema: 2.0.0
66
---
77

88
# Add-AzApplicationGatewayRoutingRule
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Adds a routing rule to an application gateway.
1212

1313
## SYNTAX
1414

@@ -28,16 +28,18 @@ Add-AzApplicationGatewayRoutingRule -ApplicationGateway <PSApplicationGateway> -
2828
```
2929

3030
## DESCRIPTION
31-
{{ Fill in the Description }}
31+
The **Add-AzApplicationGatewayRoutingRule** cmdlet adds a routing rule to an application gateway.
3232

3333
## EXAMPLES
3434

35-
### Example 1
35+
### Example 1: Add a routing rule to an application gateway
3636
```powershell
37-
PS C:\> {{ Add example code here }}
37+
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
38+
$Appgw = Add-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -Priority 100 -BackendSettings $Setting -Listener $Listener -BackendAddressPool $Pool
3839
```
3940

40-
{{ Add example description here }}
41+
The first command gets the application gateway and stores it in the $AppGw variable.
42+
The second command adds the routing rule to the application gateway.
4143

4244
## PARAMETERS
4345

@@ -221,3 +223,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
221223
## NOTES
222224
223225
## RELATED LINKS
226+
227+
[Get-AzApplicationGatewayRoutingRule](./Get-AzApplicationGatewayRoutingRule.md)
228+
229+
[New-AzApplicationGatewayRoutingRule](./New-AzApplicationGatewayRoutingRule.md)
230+
231+
[Remove-AzApplicationGatewayRoutingRule](./Remove-AzApplicationGatewayRoutingRule.md)
232+
233+
[Set-AzApplicationGatewayRoutingRule](./Set-AzApplicationGatewayRoutingRule.md)

src/Network/Network/help/Get-AzApplicationGatewayBackendSetting.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/get-azapplicationgatewaybackendsetting
55
schema: 2.0.0
66
---
77

88
# Get-AzApplicationGatewayBackendSetting
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Gets the back-end TCP\TLS settings of an application gateway.
1212

1313
## SYNTAX
1414

@@ -18,16 +18,17 @@ Get-AzApplicationGatewayBackendSetting [-Name <String>] -ApplicationGateway <PSA
1818
```
1919

2020
## DESCRIPTION
21-
{{ Fill in the Description }}
21+
The Get-AzApplicationGatewayBackendSetting cmdlet gets the back-end TCP\TLS settings of an application gateway.
2222

2323
## EXAMPLES
2424

25-
### Example 1
25+
### Example 1: Get back-end TCP\TLS settings by name
2626
```powershell
27-
PS C:\> {{ Add example code here }}
27+
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
28+
$Settings = Get-AzApplicationGatewayBackendSetting -Name "Settings01" -ApplicationGateway $AppGw
2829
```
2930

30-
{{ Add example description here }}
31+
The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the backend settings named Settings01 for $AppGw and stores the settings in the $Settings variable.
3132

3233
## PARAMETERS
3334

@@ -90,3 +91,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9091
## NOTES
9192
9293
## RELATED LINKS
94+
95+
[Add-AzApplicationGatewayBackendSetting](./Add-AzApplicationGatewayBackendSetting.md)
96+
97+
[New-AzApplicationGatewayBackendSetting](./New-AzApplicationGatewayBackendSetting.md)
98+
99+
[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md)
100+
101+
[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md)

src/Network/Network/help/Get-AzApplicationGatewayListener.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/get-azapplicationgatewaylistener
55
schema: 2.0.0
66
---
77

88
# Get-AzApplicationGatewayListener
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Gets the TCP\TLS listener of an application gateway.
1212

1313
## SYNTAX
1414

@@ -18,16 +18,25 @@ Get-AzApplicationGatewayListener [-Name <String>] -ApplicationGateway <PSApplica
1818
```
1919

2020
## DESCRIPTION
21-
{{ Fill in the Description }}
21+
The **Get-AzApplicationGatewayListener** cmdlet gets the TCP\TLS listener of an application gateway.
2222

2323
## EXAMPLES
2424

25-
### Example 1
25+
### Example 1: Get a specific TCP\TLS listener
2626
```powershell
27-
PS C:\> {{ Add example code here }}
27+
$Appgw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
28+
$Listener = Get-AzApplicationGatewayListener -Name "Listener01" -ApplicationGateway $Appgw
2829
```
2930

30-
{{ Add example description here }}
31+
This command gets a TCP\TLS listener named Listener01.
32+
33+
### Example 2: Get a list of TCP\TLS listeners
34+
```powershell
35+
$Appgw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
36+
$Listeners = Get-AzApplicationGatewayListener -ApplicationGateway $Appgw
37+
```
38+
39+
This command gets a list of TCP\TLS listeners.
3140

3241
## PARAMETERS
3342

@@ -90,3 +99,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9099
## NOTES
91100
92101
## RELATED LINKS
102+
103+
[Add-AzApplicationGatewayListener](./Add-AzApplicationGatewayListener.md)
104+
105+
[New-AzApplicationGatewayListener](./New-AzApplicationGatewayListener.md)
106+
107+
[Remove-AzApplicationGatewayListener](./Remove-AzApplicationGatewayListener.md)
108+
109+
[Set-AzApplicationGatewayListener](./Set-AzApplicationGatewayListener.md)

src/Network/Network/help/Get-AzApplicationGatewayRoutingRule.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/get-azapplicationgatewayroutingrule
55
schema: 2.0.0
66
---
77

88
# Get-AzApplicationGatewayRoutingRule
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Gets the routing rule of an application gateway.
1212

1313
## SYNTAX
1414

@@ -18,16 +18,27 @@ Get-AzApplicationGatewayRoutingRule [-Name <String>] -ApplicationGateway <PSAppl
1818
```
1919

2020
## DESCRIPTION
21-
{{ Fill in the Description }}
21+
The **Get-AzApplicationGatewayRoutingRule** cmdlet gets the routing rule of an application gateway.
2222

2323
## EXAMPLES
2424

25-
### Example 1
25+
### Example 1: Get a specific routing rule
2626
```powershell
27-
PS C:\> {{ Add example code here }}
27+
$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
28+
$Rule = Get-AzApplicationGatewayRoutingRule -Name "Rule01" -ApplicationGateway $AppGW
2829
```
2930

30-
{{ Add example description here }}
31+
The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW.
32+
The second command gets the routing rule named Rule01 from the Application Gateway stored in the variable named $AppGW.
33+
34+
### Example 2: Get a list of routing rules
35+
```powershell
36+
$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
37+
$Rules = Get-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGW
38+
```
39+
40+
The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW.
41+
The second command gets a list of routing rules from the Application Gateway stored in the variable named $AppGW.
3142

3243
## PARAMETERS
3344

@@ -90,3 +101,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
90101
## NOTES
91102
92103
## RELATED LINKS
104+
105+
[Add-AzApplicationGatewayRoutingRule](./Add-AzApplicationGatewayRoutingRule.md)
106+
107+
[New-AzApplicationGatewayRoutingRule](./New-AzApplicationGatewayRoutingRule.md)
108+
109+
[Remove-AzApplicationGatewayRoutingRule](./Remove-AzApplicationGatewayRoutingRule.md)
110+
111+
[Set-AzApplicationGatewayRoutingRule](./Set-AzApplicationGatewayRoutingRule.md)

src/Network/Network/help/New-AzApplicationGatewayBackendSetting.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
4-
online version:
4+
online version: https://docs.microsoft.com/powershell/module/az.network/new-azapplicationgatewaybackendsetting
55
schema: 2.0.0
66
---
77

88
# New-AzApplicationGatewayBackendSetting
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates back-end TCP\TLS setting for an application gateway.
1212

1313
## SYNTAX
1414

@@ -20,16 +20,18 @@ New-AzApplicationGatewayBackendSetting -Name <String> -Port <Int32> -Protocol <S
2020
```
2121

2222
## DESCRIPTION
23-
{{ Fill in the Description }}
23+
The New-AzApplicationGatewayBackendSetting cmdlet creates back-end TCP\TLS settings for an application gateway.
24+
Back-end settings are applied to all back-end servers in a pool.
2425

2526
## EXAMPLES
2627

27-
### Example 1
28+
### Example 1: Create back-end TCP\TLS settings
2829
```powershell
29-
PS C:\> {{ Add example code here }}
30+
$Setting = New-AzApplicationGatewayBackendSetting -Name "Setting01" -Port 80 -Protocol Tcp
3031
```
3132

32-
{{ Add example description here }}
33+
This command creates back-end settings named Setting01 on port 80, using the Tcp protocol
34+
The settings are stored in the $Setting variable.
3335

3436
## PARAMETERS
3537

@@ -199,3 +201,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
199201
## NOTES
200202
201203
## RELATED LINKS
204+
205+
[Add-AzApplicationGatewayBackendSetting](./Add-AzApplicationGatewayBackendSetting.md)
206+
207+
[Get-AzApplicationGatewayBackendSetting](./Get-AzApplicationGatewayBackendSetting.md)
208+
209+
[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md)
210+
211+
[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md)

0 commit comments

Comments
 (0)