Skip to content

Commit 680e490

Browse files
author
Khushboo Baheti
committed
Adding help files
1 parent 6675241 commit 680e490

6 files changed

+982
-45
lines changed

‎src/Network/Network.Test/ScenarioTests/VirtualNetworkGatewayConnectionTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public void TestVirtualNetworkGatewayVpnDeviceConfigurationScripts()
8686
[Trait(Category.Owner, NrpTeamAlias.brooklynft_subset1)]
8787
public void TestVirtualNetworkGatewayConnectionPacketCapture()
8888
{
89-
TestRunner.RunTestScript("Test- VirtualNetworkGatewayConnectionPacketCapture");
89+
TestRunner.RunTestScript("Test-VirtualNetworkGatewayConnectionPacketCapture");
9090
}
9191

9292
}

‎src/Network/Network.Test/ScenarioTests/VirtualNetworkGatewayConnectionTests.ps1

Lines changed: 55 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -577,16 +577,21 @@ function Test-VirtualNetworkGatewayConnectionPacketCapture
577577
{
578578
# Setup
579579
$rgname = Get-ResourceGroupName
580-
$rname = Get-ResourceName
581-
$domainNameLabel = Get-ResourceName
582-
$vnetName = Get-ResourceName
583-
$localnetName = Get-ResourceName
584-
$vnetConnectionName = Get-ResourceName
585-
$publicIpName = Get-ResourceName
586-
$vnetGatewayConfigName = Get-ResourceName
587-
$rglocation = Get-ProviderLocation ResourceManagement "centraluseuap"
580+
$rname1 = Get-ResourceName
581+
$rname2 = Get-ResourceName
582+
$domainNameLabel1 = Get-ResourceName
583+
$domainNameLabel2 = Get-ResourceName
584+
$vnetName1 = Get-ResourceName
585+
$vnetName2 = Get-ResourceName
586+
$vnetConnectionName1 = Get-ResourceName
587+
$vnetConnectionName2 = Get-ResourceName
588+
$publicIpName1 = Get-ResourceName
589+
$publicIpName2 = Get-ResourceName
590+
$vnetGatewayConfigName1 = Get-ResourceName
591+
$vnetGatewayConfigName2 = Get-ResourceName
592+
$rglocation = Get-ProviderLocation ResourceManagement "WestCentralUS"
588593
$resourceTypeParent = "Microsoft.Network/connections"
589-
$location = Get-ProviderLocation $resourceTypeParent "centraluseuap"
594+
$location = Get-ProviderLocation $resourceTypeParent "WestCentralUS"
590595

591596
try
592597
{
@@ -605,71 +610,77 @@ function Test-VirtualNetworkGatewayConnectionPacketCapture
605610
$now=get-date
606611
$sasurl = New-AzureStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri
607612

608-
# Create the Virtual Network
609-
$subnet = New-AzVirtualNetworkSubnetConfig -Name "GatewaySubnet" -AddressPrefix 10.0.0.0/24
610-
$vnet = New-AzVirtualNetwork -Name $vnetName -ResourceGroupName $rgname -Location $location -AddressPrefix 10.0.0.0/16 -Subnet $subnet
611-
$vnet = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $rgname
612-
$subnet = Get-AzVirtualNetworkSubnetConfig -Name "GatewaySubnet" -VirtualNetwork $vnet
613+
# Create the Virtual Network1
614+
$subnet1 = New-AzVirtualNetworkSubnetConfig -Name "GatewaySubnet" -AddressPrefix 10.0.0.0/24
615+
$vnet1 = New-AzVirtualNetwork -Name $vnetName1 -ResourceGroupName $rgname -Location $location -AddressPrefix 10.0.0.0/16 -Subnet $subnet1
616+
$vnet1 = Get-AzVirtualNetwork -Name $vnetName1 -ResourceGroupName $rgname
617+
$subnet1 = Get-AzVirtualNetworkSubnetConfig -Name "GatewaySubnet" -VirtualNetwork $vnet1
618+
619+
# Create virtualnetworkgateway1 & Get virtualnetworkgateway1
620+
$publicip1 = New-AzPublicIpAddress -ResourceGroupName $rgname -name $publicIpName1 -location $location -AllocationMethod Dynamic -DomainNameLabel $domainNameLabel1
621+
$vnetIpConfig1 = New-AzVirtualNetworkGatewayIpConfig -Name $vnetGatewayConfigName1 -PublicIpAddress $publicip1 -Subnet $subnet1
613622

614-
# Create the publicip
615-
$publicip = New-AzPublicIpAddress -ResourceGroupName $rgname -name $publicIpName -location $location -AllocationMethod Dynamic -DomainNameLabel $domainNameLabel
623+
$actual = New-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname1 -Location $location -IpConfigurations $vnetIpConfig1 -GatewayType Vpn -VpnType RouteBased -GatewaySku Standard
624+
$vnetGateway1 = Get-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname1
616625

617-
# Create VirtualNetworkGateway
618-
$vnetIpConfig = New-AzVirtualNetworkGatewayIpConfig -Name $vnetGatewayConfigName -PublicIpAddress $publicip -Subnet $subnet
626+
# Create the Virtual Network2
627+
$subnet2 = New-AzVirtualNetworkSubnetConfig -Name "GatewaySubnet" -AddressPrefix 192.168.200.0/26
628+
$vnet2 = New-AzVirtualNetwork -Name $vnetName2 -ResourceGroupName $rgname -Location $location -AddressPrefix 192.168.0.0/16 -Subnet $subnet2
629+
$vnet2 = Get-AzVirtualNetwork -Name $vnetName2 -ResourceGroupName $rgname
630+
$subnet2 = Get-AzVirtualNetworkSubnetConfig -Name "GatewaySubnet" -VirtualNetwork $vnet2
619631

620-
$actual = New-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname -location $location -IpConfigurations $vnetIpConfig -GatewayType Vpn -VpnType RouteBased -EnableBgp $false
621-
$vnetGateway = Get-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname
622-
Assert-AreEqual $vnetGateway.ResourceGroupName $actual.ResourceGroupName
623-
Assert-AreEqual $vnetGateway.Name $actual.Name
624-
#Assert-AreEqual "Vpn" $expected.GatewayType
625-
#Assert-AreEqual "RouteBased" $expected.VpnType
626-
627-
# Create LocalNetworkGateway
628-
$actual = New-AzLocalNetworkGateway -ResourceGroupName $rgname -name $localnetName -location $location -AddressPrefix 192.168.0.0/16 -GatewayIpAddress 192.168.3.10
629-
$localnetGateway = Get-AzLocalNetworkGateway -ResourceGroupName $rgname -name $localnetName
630-
Assert-AreEqual $localnetGateway.ResourceGroupName $actual.ResourceGroupName
631-
Assert-AreEqual $localnetGateway.Name $actual.Name
632-
Assert-AreEqual "192.168.3.10" $localnetGateway.GatewayIpAddress
633-
Assert-AreEqual "192.168.0.0/16" $localnetGateway.LocalNetworkAddressSpace.AddressPrefixes[0]
634-
$localnetGateway.Location = $location
632+
# Create the publicip2
633+
$publicip2 = New-AzPublicIpAddress -ResourceGroupName $rgname -name $publicIpName2 -location $location -AllocationMethod Dynamic -DomainNameLabel $domainNameLabel2
635634

636-
# Create & Get VirtualNetworkGatewayConnection
637-
$connection = New-AzVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName -location $location -VirtualNetworkGateway1 $vnetGateway -LocalNetworkGateway2 $localnetGateway -ConnectionType IPsec -RoutingWeight 3 -SharedKey abc -ConnectionProtocol IKEv1
635+
# Create VirtualNetworkGateway2
636+
$vnetIpConfig2 = New-AzVirtualNetworkGatewayIpConfig -Name $vnetGatewayConfigName2 -PublicIpAddress $publicip2 -Subnet $subnet2
637+
638+
$actual = New-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname2 -location $location -IpConfigurations $vnetIpConfig2 -GatewayType Vpn -VpnType RouteBased -GatewaySku Standard
639+
$vnetGateway2 = Get-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname2
640+
641+
# Create & Get VirtualNetworkGatewayConnection1, VirtualNetworkGatewayConnection2
642+
$actual1 = New-AzVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName1 -location $location -VirtualNetworkGateway1 $vnetGateway1 -VirtualNetworkGateway2 $vnetGateway2 -ConnectionType Vnet2Vnet -RoutingWeight 3 -SharedKey abc
643+
$actual2 = New-AzVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName2 -location $location -VirtualNetworkGateway1 $vnetGateway2 -VirtualNetworkGateway2 $vnetGateway1 -ConnectionType Vnet2Vnet -RoutingWeight 3 -SharedKey abc
644+
645+
$connection = Get-AzVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName1
638646

639647
#StartPacketCapture on gateway with Name parameter
640-
$output = Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName $rgname -Name $vnetConnectionName
648+
$output = Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName $rgname -Name $vnetConnectionName1
641649
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
642650
Assert-AreEqual $connection.Name $output.Name
643651
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
644652
Assert-AreEqual $connection.Location $output.Location
645653
Assert-AreEqual $output.Code "Succeeded"
646654

647-
#StopPacketCapture on gateway with Name parameter
648-
$output = Stop-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName $rgname -Name $vnetConnectionName -SasUrl $sasurl
655+
#StopPacketCapture on gateway connection with Name parameter
656+
$output = Stop-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName $rgname -Name $vnetConnectionName1 -SasUrl $sasurl
649657
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
650658
Assert-AreEqual $connection.Name $output.Name
651659
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
652660
Assert-AreEqual $connection.Location $output.Location
653-
Assert-AreEqual $connection.Code "Succeeded"
661+
Assert-AreEqual $output.Code "Succeeded"
654662

655-
#StartPacketCapture on gateway object
663+
#StartPacketCapture on gateway Connection object
656664
$output = Start-AzVirtualNetworkGatewayConnectionPacketCapture -InputObject $connection
657665
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
658666
Assert-AreEqual $connection.Name $output.Name
659667
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
660668
Assert-AreEqual $connection.Location $output.Location
661-
Assert-AreEqual $connection.Code "Succeeded"
669+
Assert-AreEqual $output.Code "Succeeded"
662670

663-
#StopPacketCapture on gateway object
671+
#StopPacketCapture on gateway Connection object
664672
$output = Stop-AzVirtualNetworkGatewayConnectionPacketCapture -InputObject $connection -SasUrl $sasurl
665673
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
666674
Assert-AreEqual $connection.Name $output.Name
667675
Assert-AreEqual $connection.ResourceGroupName $output.ResourceGroupName
668676
Assert-AreEqual $connection.Location $output.Location
669-
Assert-AreEqual $connection.Code "Succeeded"
677+
Assert-AreEqual $output.Code "Succeeded"
670678

671679
# Delete VirtualNetworkGatewayConnection
672-
$delete = Remove-AzVirtualNetworkGatewayConnection -ResourceGroupName $connection.ResourceGroupName -name $vnetConnectionName -PassThru -Force
680+
$delete = Remove-AzVirtualNetworkGatewayConnection -ResourceGroupName $connection.ResourceGroupName -name $vnetConnectionName1 -PassThru -Force
681+
Assert-AreEqual true $delete
682+
683+
$delete = Remove-AzVirtualNetworkGatewayConnection -ResourceGroupName $actual2.ResourceGroupName -name $vnetConnectionName2 -PassThru -Force
673684
Assert-AreEqual true $delete
674685

675686
$list = Get-AzVirtualNetworkGatewayConnection -ResourceGroupName $connection.ResourceGroupName

‎src/Network/Network/help/Start-AzVirtualNetworkGatewayConnectionPacketCapture.md

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
3+
Module Name: Az.Network
4+
online version: https://docs.microsoft.com/en-us/powershell/module/az.network/start-azvirtualnetworkgatewayconnectionpacketcapture
5+
schema: 2.0.0
6+
---
7+
8+
# Start-AzVirtualNetworkGatewayConnectionPacketCapture
9+
10+
## SYNOPSIS
11+
Starts Packet Capture Operation on a Virtual Network Gateway Connection.
12+
13+
## SYNTAX
14+
15+
### ByName (Default)
16+
```
17+
Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName <String> -Name <String>
18+
[-FilterData <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
19+
[<CommonParameters>]
20+
```
21+
22+
### ByInputObject
23+
```
24+
Start-AzVirtualNetworkGatewayConnectionPacketCapture -InputObject <PSVirtualNetworkGatewayConnection>
25+
[-FilterData <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
27+
```
28+
29+
### ByResourceId
30+
```
31+
Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceId <String> [-FilterData <String>] [-AsJob]
32+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
33+
```
34+
35+
## DESCRIPTION
36+
Starts Packet Capture Operation on a Virtual Network Gateway Connection.
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
```powershell
42+
Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn"
43+
```
44+
```
45+
Code : Succeeded
46+
EndTime : 10/1/2019 12:52:37 AM
47+
StartTime : 10/1/2019 12:52:25 AM
48+
ResultsText :
49+
ResourceGroupName : PktCaptureTestSite2RG
50+
Location : centraluseuap
51+
ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382
52+
Type :
53+
Tag :
54+
TagsTable :
55+
Name : PktCaptureTestSite2Site1Cn
56+
Etag :
57+
Id :
58+
```
59+
60+
## PARAMETERS
61+
62+
### -AsJob
63+
Run cmdlet in the background
64+
65+
```yaml
66+
Type: SwitchParameter
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -Confirm
78+
Prompts you for confirmation before running the cmdlet.
79+
80+
```yaml
81+
Type: SwitchParameter
82+
Parameter Sets: (All)
83+
Aliases: cf
84+
85+
Required: False
86+
Position: Named
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -DefaultProfile
93+
The credentials, account, tenant, and subscription used for communication with Azure.
94+
95+
```yaml
96+
Type: IAzureContextContainer
97+
Parameter Sets: (All)
98+
Aliases: AzContext, AzureRmContext, AzureCredential
99+
100+
Required: False
101+
Position: Named
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### -FilterData
108+
Filter options for start packet capture on virtual network gateway connection.
109+
110+
```yaml
111+
Type: String
112+
Parameter Sets: (All)
113+
Aliases:
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
122+
### -InputObject
123+
The virtual network gateway connection object where packet capture to be started.
124+
125+
```yaml
126+
Type: PSVirtualNetworkGatewayConnection
127+
Parameter Sets: ByInputObject
128+
Aliases: VirtualNetworkGatewayConnection
129+
130+
Required: True
131+
Position: Named
132+
Default value: None
133+
Accept pipeline input: True (ByValue)
134+
Accept wildcard characters: False
135+
```
136+
137+
### -Name
138+
The virtual network gateway connection name where packet capture to be started.
139+
140+
```yaml
141+
Type: String
142+
Parameter Sets: ByName
143+
Aliases: ResourceName, VirtualNetworkGatewayConnectionName, ConnectionName
144+
145+
Required: True
146+
Position: Named
147+
Default value: None
148+
Accept pipeline input: False
149+
Accept wildcard characters: False
150+
```
151+
152+
### -ResourceGroupName
153+
The resource group name.
154+
155+
```yaml
156+
Type: String
157+
Parameter Sets: ByName
158+
Aliases:
159+
160+
Required: True
161+
Position: Named
162+
Default value: None
163+
Accept pipeline input: False
164+
Accept wildcard characters: False
165+
```
166+
167+
### -ResourceId
168+
The Azure resource ID of the VirtualNetworkGatewayConnection where packet capture to be started.
169+
170+
```yaml
171+
Type: String
172+
Parameter Sets: ByResourceId
173+
Aliases:
174+
175+
Required: True
176+
Position: Named
177+
Default value: None
178+
Accept pipeline input: True (ByPropertyName)
179+
Accept wildcard characters: False
180+
```
181+
182+
### -WhatIf
183+
Shows what would happen if the cmdlet runs.
184+
The cmdlet is not run.
185+
186+
```yaml
187+
Type: SwitchParameter
188+
Parameter Sets: (All)
189+
Aliases: wi
190+
191+
Required: False
192+
Position: Named
193+
Default value: None
194+
Accept pipeline input: False
195+
Accept wildcard characters: False
196+
```
197+
198+
### CommonParameters
199+
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).
200+
201+
## INPUTS
202+
203+
### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection
204+
205+
### System.String
206+
207+
## OUTPUTS
208+
209+
### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPacketCaptureResult
210+
211+
## NOTES
212+
213+
## RELATED LINKS
214+
[Stop-AzVirtualNetworkGatewayConnectionPacketCapture](./Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md)

0 commit comments

Comments
 (0)