< Back
Stop-AzureRmNetworkWatcherPacketCapture
Post
NAME Stop-AzureRmNetworkWatcherPacketCapture
SYNOPSIS
Stops a running packet capture session
SYNTAX
Stop-AzureRmNetworkWatcherPacketCapture [-AsJob] [-DefaultProfile <IAzureContextContainer>] -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName
<String> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureRmNetworkWatcherPacketCapture [-AsJob] [-DefaultProfile <IAzureContextContainer>] -NetworkWatcherName <String> -PacketCaptureName
<String> [-PassThru] -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmNetworkWatcherPacketCapture stops a running packet capture session. After the session is stopped, the packet capture file is
uploaded to storage and/or saved locally on the VM depending on its configuration.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NetworkWatcher <PSNetworkWatcher>
The network watcher resource.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-NetworkWatcherName <String>
The name of network watcher.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PacketCaptureName <String>
The packet capture name.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
{{Fill PassThru Description}}
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
The name of the network watcher resource group.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher
System.String
OUTPUTS
System.Boolean
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic
--- Example 1: Stop a packet capture session ---
Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest"
In this example we stop a running packet capture session named "PacketCaptureTest". After the session is stopped, the packet capture file is
uploaded to storage and/or saved locally on the VM depending on its configuration.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ketcapture
New-AzureRmNetworkWatcherPacketCapture
New-AzureRmPacketCaptureFilterConfig
Get-AzureRmNetworkWatcherPacketCapture
Remove-AzureRmNetworkWatcherPacketCapture
New-AzureRmNetworkWatcher
Get-AzureRmNetworkWatcher
Remove-AzureRmNetworkWatcher
Test-AzureRmNetworkWatcherIPFlow
Get-AzureRmNetworkWatcherNextHop
Get-AzureRmNetworkWatcherSecurityGroupView
Get-AzureRmNetworkWatcherTopology
Start-AzureRmNetworkWatcherResourceTroubleshooting
SYNOPSIS
Stops a running packet capture session
SYNTAX
Stop-AzureRmNetworkWatcherPacketCapture [-AsJob] [-DefaultProfile <IAzureContextContainer>] -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName
<String> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureRmNetworkWatcherPacketCapture [-AsJob] [-DefaultProfile <IAzureContextContainer>] -NetworkWatcherName <String> -PacketCaptureName
<String> [-PassThru] -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmNetworkWatcherPacketCapture stops a running packet capture session. After the session is stopped, the packet capture file is
uploaded to storage and/or saved locally on the VM depending on its configuration.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NetworkWatcher <PSNetworkWatcher>
The network watcher resource.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-NetworkWatcherName <String>
The name of network watcher.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PacketCaptureName <String>
The packet capture name.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
{{Fill PassThru Description}}
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
The name of the network watcher resource group.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher
System.String
OUTPUTS
System.Boolean
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic
--- Example 1: Stop a packet capture session ---
Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest"
In this example we stop a running packet capture session named "PacketCaptureTest". After the session is stopped, the packet capture file is
uploaded to storage and/or saved locally on the VM depending on its configuration.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ketcapture
New-AzureRmNetworkWatcherPacketCapture
New-AzureRmPacketCaptureFilterConfig
Get-AzureRmNetworkWatcherPacketCapture
Remove-AzureRmNetworkWatcherPacketCapture
New-AzureRmNetworkWatcher
Get-AzureRmNetworkWatcher
Remove-AzureRmNetworkWatcher
Test-AzureRmNetworkWatcherIPFlow
Get-AzureRmNetworkWatcherNextHop
Get-AzureRmNetworkWatcherSecurityGroupView
Get-AzureRmNetworkWatcherTopology
Start-AzureRmNetworkWatcherResourceTroubleshooting