Skip to content

Commit 02139d2

Browse files
authored
Fix help documentation for Reset-AzVirtualNetworkGatewayConnection and Reset-AzVpnSiteLinkConnection Cmdlets (#14526)
* Update Reset help page * Update Reset help-2 * Update-3 * Update-4 * Fix typo
1 parent e6fb94c commit 02139d2

File tree

2 files changed

+41
-23
lines changed

2 files changed

+41
-23
lines changed

src/Network/Network/help/Reset-AzVirtualNetworkGatewayConnection.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
44
online version: https://docs.microsoft.com/powershell/module/az.network/reset-azvirtualnetworkgatewayconnection
@@ -14,7 +14,7 @@ Reset a Virtual Network Gateway Connection
1414

1515
### ByName
1616
```
17-
Reset-AzVirtualNetworkGatewayConnection [-Name <String>] -ResourceGroupName <String> [-AsJob]
17+
Reset-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> [-AsJob]
1818
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
2020

@@ -26,7 +26,7 @@ Reset-AzVirtualNetworkGatewayConnection -InputObject <PSVirtualNetworkGatewayCon
2626

2727
### ByResourceId
2828
```
29-
Reset-AzVirtualNetworkGatewayConnection [-ResourceId <String>] [-AsJob]
29+
Reset-AzVirtualNetworkGatewayConnection -ResourceId <String> [-AsJob]
3030
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3131
```
3232

@@ -51,6 +51,7 @@ Run cmdlet in the background.
5151
Type: SwitchParameter
5252
Parameter Sets: (All)
5353
Aliases:
54+
5455
Required: False
5556
Position: Named
5657
Default value: None
@@ -65,6 +66,7 @@ The credentials, account, tenant, and subscription used for communication with A
6566
Type: IAzureContextContainer
6667
Parameter Sets: (All)
6768
Aliases: AzContext, AzureRmContext, AzureCredential
69+
6870
Required: False
6971
Position: Named
7072
Default value: None
@@ -79,21 +81,23 @@ The virtual network gateway connection object which has to be reset.
7981
Type: PSVirtualNetworkGatewayConnection
8082
Parameter Sets: ByInputObject
8183
Aliases:
84+
8285
Required: True
8386
Position: Named
8487
Default value: None
85-
Accept pipeline input: False
88+
Accept pipeline input: True (ByPropertyName)
8689
Accept wildcard characters: False
8790
```
8891
8992
### -Name
90-
The virtual network gateway connection name for which has to be reset.
93+
The virtual network gateway connection name which has to be reset.
9194
9295
```yaml
9396
Type: String
9497
Parameter Sets: ByName
9598
Aliases: ResourceName, ConnectionName
96-
Required: False
99+
100+
Required: True
97101
Position: Named
98102
Default value: None
99103
Accept pipeline input: False
@@ -107,6 +111,7 @@ The resource group name.
107111
Type: String
108112
Parameter Sets: ByName
109113
Aliases:
114+
110115
Required: True
111116
Position: Named
112117
Default value: None
@@ -121,10 +126,11 @@ The Azure resource ID of the Virtual Network Gateway Connection which has to be
121126
Type: String
122127
Parameter Sets: ByResourceId
123128
Aliases:
124-
Required: False
129+
130+
Required: True
125131
Position: Named
126132
Default value: None
127-
Accept pipeline input: False
133+
Accept pipeline input: True (ByPropertyName)
128134
Accept wildcard characters: False
129135
```
130136
@@ -135,6 +141,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
135141
136142
### System.String
137143
144+
## OUTPUTS
145+
138146
## NOTES
139147
140148
## RELATED LINKS

src/Network/Network/help/Reset-AzVpnSiteLinkConnection.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
33
Module Name: Az.Network
44
online version: https://docs.microsoft.com/powershell/module/az.network/reset-azvpnsitelinkconnection
@@ -12,11 +12,10 @@ Reset a VPN Site Link Connection
1212

1313
## SYNTAX
1414

15-
### ByName (Default)
15+
### ByName
1616
```
17-
Reset-AzVpnSiteLinkConnection -ResourceGroupName <String> -VpnGatewayName <String>
18-
-VpnConnectionName <String> -Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>]
19-
[<CommonParameters>]
17+
Reset-AzVpnSiteLinkConnection -ResourceGroupName <String> -VpnGatewayName <String> -VpnConnectionName <String>
18+
-Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2019
```
2120

2221
### ByInputObject
@@ -27,9 +26,9 @@ Reset-AzVpnSiteLinkConnection -InputObject <PSVpnSiteLinkConnection> [-AsJob]
2726

2827
### ByResourceId
2928
```
30-
Reset-AzVpnSiteLinkConnection -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>]
31-
[<CommonParameters>]
29+
Reset-AzVpnSiteLinkConnection -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3230
```
31+
3332
## DESCRIPTION
3433
The **Reset-AzVpnSiteLinkConnection** cmdlet resets your VPN Link Connection based on the VPN Site Link Connection Name, VPN Connection Name, VPN Gateway Name and Resource Group Name.
3534

@@ -48,9 +47,10 @@ Resets the VPN Site Link Connection with the name "test-linkConnection" within t
4847
Run cmdlet in the background.
4948

5049
```yaml
51-
Type: System.Management.Automation.SwitchParameter
50+
Type: SwitchParameter
5251
Parameter Sets: (All)
5352
Aliases:
53+
5454
Required: False
5555
Position: Named
5656
Default value: None
@@ -62,9 +62,10 @@ Accept wildcard characters: False
6262
The credentials, account, tenant, and subscription used for communication with Azure.
6363
6464
```yaml
65-
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
65+
Type: IAzureContextContainer
6666
Parameter Sets: (All)
6767
Aliases: AzContext, AzureRmContext, AzureCredential
68+
6869
Required: False
6970
Position: Named
7071
Default value: None
@@ -76,9 +77,10 @@ Accept wildcard characters: False
7677
The Vpn site link connection object.
7778
7879
```yaml
79-
Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection
80+
Type: PSVpnSiteLinkConnection
8081
Parameter Sets: ByInputObject
8182
Aliases: VpnSiteLinkConnection
83+
8284
Required: True
8385
Position: Named
8486
Default value: None
@@ -90,9 +92,10 @@ Accept wildcard characters: False
9092
The Vpn site link connection name.
9193
9294
```yaml
93-
Type: System.String
95+
Type: String
9496
Parameter Sets: ByName
9597
Aliases: ResourceName, VpnSiteLinkConnectionName
98+
9699
Required: True
97100
Position: Named
98101
Default value: None
@@ -104,9 +107,10 @@ Accept wildcard characters: False
104107
The resource group name.
105108
106109
```yaml
107-
Type: System.String
110+
Type: String
108111
Parameter Sets: ByName
109112
Aliases:
113+
110114
Required: True
111115
Position: Named
112116
Default value: None
@@ -118,9 +122,10 @@ Accept wildcard characters: False
118122
The Azure resource ID of the Vpn site link connection which has to be reset.
119123
120124
```yaml
121-
Type: System.String
125+
Type: String
122126
Parameter Sets: ByResourceId
123127
Aliases:
128+
124129
Required: True
125130
Position: Named
126131
Default value: None
@@ -132,9 +137,10 @@ Accept wildcard characters: False
132137
The Vpn connection name.
133138
134139
```yaml
135-
Type: System.String
140+
Type: String
136141
Parameter Sets: ByName
137142
Aliases: ParentName
143+
138144
Required: True
139145
Position: Named
140146
Default value: None
@@ -146,9 +152,10 @@ Accept wildcard characters: False
146152
The Vpn gateway name.
147153
148154
```yaml
149-
Type: System.String
155+
Type: String
150156
Parameter Sets: ByName
151157
Aliases: GrandParentName
158+
152159
Required: True
153160
Position: Named
154161
Default value: None
@@ -165,5 +172,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
165172
166173
### System.String
167174
175+
## OUTPUTS
176+
168177
## NOTES
178+
169179
## RELATED LINKS

0 commit comments

Comments
 (0)