VirtualNetworkGatewayResource.StartPacketCaptureAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| StartPacketCaptureAsync(WaitUntil, VpnPacketCaptureStartContent, CancellationToken) |
Starts packet capture on virtual network gateway in the specified resource group.
|
| StartPacketCaptureAsync(WaitUntil, VpnPacketCaptureStartParameters, CancellationToken) |
Obsolete.
Invokes the StartPacketCaptureAsync compatibility operation. |
StartPacketCaptureAsync(WaitUntil, VpnPacketCaptureStartContent, CancellationToken)
Starts packet capture on virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture.
- Operation Id. : VirtualNetworkGateways_StartPacketCapture.
- Default Api Version. : 2026-01-01.
- Resource. : VirtualNetworkGatewayResource.
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>> StartPacketCaptureAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.Network.Models.VpnPacketCaptureStartContent content = default, System.Threading.CancellationToken cancellationToken = default);
abstract member StartPacketCaptureAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.VpnPacketCaptureStartContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
override this.StartPacketCaptureAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.VpnPacketCaptureStartContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
Public Overridable Function StartPacketCaptureAsync (waitUntil As WaitUntil, Optional content As VpnPacketCaptureStartContent = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of String))
Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- content
- VpnPacketCaptureStartContent
Virtual network gateway packet capture parameters supplied to start packet capture on gateway.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
StartPacketCaptureAsync(WaitUntil, VpnPacketCaptureStartParameters, CancellationToken)
Caution
This method is obsolete and will be removed in a future release, please use StartPacketCaptureAsync with VpnPacketCaptureStartContent instead.
Invokes the StartPacketCaptureAsync compatibility operation.
[System.Obsolete("This method is obsolete and will be removed in a future release, please use `StartPacketCaptureAsync` with `VpnPacketCaptureStartContent` instead.", false)]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>> StartPacketCaptureAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.Network.Models.VpnPacketCaptureStartParameters content, System.Threading.CancellationToken cancellationToken);
[<System.Obsolete("This method is obsolete and will be removed in a future release, please use `StartPacketCaptureAsync` with `VpnPacketCaptureStartContent` instead.", false)>]
abstract member StartPacketCaptureAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.VpnPacketCaptureStartParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
override this.StartPacketCaptureAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.VpnPacketCaptureStartParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
Public Overridable Function StartPacketCaptureAsync (waitUntil As WaitUntil, content As VpnPacketCaptureStartParameters, cancellationToken As CancellationToken) As Task(Of ArmOperation(Of String))
Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- content
- VpnPacketCaptureStartParameters
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
- Attributes