Vpn Connections - Start Packet Capture

Service:

Virtual WAN

API Version:

2024-05-01

Starts packet capture on Vpn connection in the specified resource group.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/startpacketcapture?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
gatewayName	path	True	string	The name of the gateway.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vpnConnectionName	path	True	string	The name of the vpn connection.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
filterData	string	Start Packet capture parameters on vpn connection.
linkConnectionNames	string[]	List of site link connection names.

Responses

Name	Type	Description
200 OK	string	Request successful. The operation packet capture started on vpn connection.
202 Accepted		Accepted and the operation will complete asynchronously.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Start packet capture on vpn connection with filter

Start packet capture on vpn connection without filter

Start packet capture on vpn connection with filter

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/startpacketcapture?api-version=2024-05-01

{
  "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}",
  "linkConnectionNames": [
    "siteLink1",
    "siteLink2"
  ]
}

Sample response

Status code:

202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

Status code:

200

"\"{\"Status\":\"Successful\",\"Data\":null}\""

Start packet capture on vpn connection without filter

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/startpacketcapture?api-version=2024-05-01

{
  "linkConnectionNames": [
    "siteLink1",
    "siteLink2"
  ]
}

Sample response

Status code:

202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

Status code:

200

"\"{\"Status\":\"Successful\",\"Data\":null}\""

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
VpnConnectionPacketCaptureStartParameters	Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

VpnConnectionPacketCaptureStartParameters

Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.

Name	Type	Description
filterData	string	Start Packet capture parameters on vpn connection.
linkConnectionNames	string[]	List of site link connection names.