Start-AzVirtualNetworkGatewayConnectionPacketCapture
Starts Packet Capture Operation on a Virtual Network Gateway Connection.
Syntax
ByName (Default)
Start-AzVirtualNetworkGatewayConnectionPacketCapture
-ResourceGroupName <String>
-Name <String>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Start-AzVirtualNetworkGatewayConnectionPacketCapture
-InputObject <PSVirtualNetworkGatewayConnection>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceId
Start-AzVirtualNetworkGatewayConnectionPacketCapture
-ResourceId <String>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Starts Packet Capture Operation on a Virtual Network Gateway Connection.
Examples
Example 1
Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn"
Code : Succeeded
EndTime : 10/1/2019 12:52:37 AM
StartTime : 10/1/2019 12:52:25 AM
ResultsText :
ResourceGroupName : PktCaptureTestSite2RG
Location : centraluseuap
ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382
Type :
Tag :
TagsTable :
Name : PktCaptureTestSite2Site1Cn
Etag :
Id :
Example 2
$a="{`"TracingFlags`":11,`"MaxPacketBufferSize`":120,`"MaxFileSize`":500,`"Filters`":[{`"SourceSubnets`":[`"10.19.0.4/32`",`"10.20.0.4/32`"],`"DestinationSubnets`":[`"10.20.0.4/32`",`"10.19.0.4/32`"],`"TcpFlags`":-1,`"Protocol`":[6],`"CaptureSingleDirectionTrafficOnly`":true}]}"
Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" -FilterData $a
Code : Succeeded
EndTime : 10/1/2019 12:52:37 AM
StartTime : 10/1/2019 12:52:25 AM
ResultsText :
ResourceGroupName : PktCaptureTestSite2RG
Location : centraluseuap
ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382
Type :
Tag :
TagsTable :
Name : PktCaptureTestSite2Site1Cn
Etag :
Id :
Example 3
Packet Capture example for capture all inner and outer packets
$a = "{`"TracingFlags`": 11,`"MaxPacketBufferSize`": 120,`"MaxFileSize`": 500,`"Filters`" :[{`"CaptureSingleDirectionTrafficOnly`": false}]}"
Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" -FilterData $a
Code : Succeeded
EndTime : 10/1/2019 12:52:37 AM
StartTime : 10/1/2019 12:52:25 AM
ResultsText :
ResourceGroupName : PktCaptureTestSite2RG
Location : centraluseuap
ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382
Type :
Tag :
TagsTable :
Name : PktCaptureTestSite2Site1Cn
Etag :
Id :
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterData
Filter options for start packet capture on virtual network gateway connection.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The virtual network gateway connection object where packet capture to be started.
ByInputObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The virtual network gateway connection name where packet capture to be started.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ResourceName, VirtualNetworkGatewayConnectionName, ConnectionName
Parameter sets
ByName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
The Azure resource ID of the VirtualNetworkGatewayConnection where packet capture to be started.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
