Stop-AzVirtualNetworkGatewayPacketCapture
Stops Packet Capture Operation on a Virtual Network Gateway.
Syntax
Stop-AzVirtualNetworkGatewayPacketCapture
-ResourceGroupName <String>
-Name <String>
-SasUrl <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzVirtualNetworkGatewayPacketCapture
-InputObject <PSVirtualNetworkGateway>
-SasUrl <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzVirtualNetworkGatewayPacketCapture
-ResourceId <String>
-SasUrl <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Stops Packet Capture Operation on a Virtual Network Gateway and will upload the result on given SasUrl of storage container.
Examples
Example 1
$rgname = "testRg"
$storeName = "teststorage"
$containerName = "packetcaptureresults"
$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName
$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value
New-AzStorageContainer -Name $containerName -Context $context
$container = Get-AzStorageContainer -Name $containerName -Context $context
$now = Get-Date
$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri
Stop-AzVirtualNetworkGatewayPacketCapture -ResourceGroupName $rgname -Name "testgw" -SasUrl $sasurl
Code : Succeeded
EndTime : 10/1/2019 12:59:37 AM
StartTime : 10/1/2019 12:58:26 AM
ResultsText :
ResourceGroupName : testRg
Location : centraluseuap
ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975
Type :
Tag :
TagsTable :
Name : testgw
Etag :
Id :Example 2
$rgname = "testRg"
$storeName = "teststorage"
$containerName = "packetcaptureresults"
$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName
$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value
$container = Get-AzStorageContainer -Name $containerName -Context $context
$now = Get-Date
$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri
$gw = Get-AzVirtualNetworkGateway -ResourceGroupName $rgname -name "testGw"
Stop-AzVirtualNetworkGatewayPacketCapture -InputObject $gw -SasUrl $sasurl
Code : Succeeded
EndTime : 10/1/2019 12:59:37 AM
StartTime : 10/1/2019 12:58:26 AM
ResultsText :
ResourceGroupName : testRg
Location : centraluseuap
ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975
Type :
Tag :
TagsTable :
Name : testgw
Etag :
Id :Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
The virtual network gateway object where packet capture to be started.
| Type: | PSVirtualNetworkGateway |
| Aliases: | VirtualNetworkGateway |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The virtual network gateway name where packet capture to be started.
| Type: | String |
| Aliases: | ResourceName, VirtualNetworkGatewayName, GatewayName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
The Azure resource ID of the VirtualNetworkGateway where packet capture to be started.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SasUrl
SAS URL packet capture on virtual network gateway.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
PSVirtualNetworkGatewayPacketCaptureResult