PacketCaptures interface

Package:

@azure/arm-network

Interface representing a PacketCaptures.

Methods

beginCreate(string, string, string, PacketCapture, PacketCapturesCreateOptionalParams)	Create and start a packet capture on the specified VM.
beginCreateAndWait(string, string, string, PacketCapture, PacketCapturesCreateOptionalParams)	Create and start a packet capture on the specified VM.
beginDelete(string, string, string, PacketCapturesDeleteOptionalParams)	Deletes the specified packet capture session.
beginDeleteAndWait(string, string, string, PacketCapturesDeleteOptionalParams)	Deletes the specified packet capture session.
beginGetStatus(string, string, string, PacketCapturesGetStatusOptionalParams)	Query the status of a running packet capture session.
beginGetStatusAndWait(string, string, string, PacketCapturesGetStatusOptionalParams)	Query the status of a running packet capture session.
beginStop(string, string, string, PacketCapturesStopOptionalParams)	Stops a specified packet capture session.
beginStopAndWait(string, string, string, PacketCapturesStopOptionalParams)	Stops a specified packet capture session.
get(string, string, string, PacketCapturesGetOptionalParams)	Gets a packet capture session by name.
list(string, string, PacketCapturesListOptionalParams)	Lists all packet capture sessions within the specified resource group.

Method Details

beginCreate(string, string, string, PacketCapture, PacketCapturesCreateOptionalParams)

Create and start a packet capture on the specified VM.

function beginCreate(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, parameters: PacketCapture, options?: PacketCapturesCreateOptionalParams): Promise<SimplePollerLike<OperationState<PacketCaptureResult>, PacketCaptureResult>>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

parameters

PacketCapture

Parameters that define the create packet capture operation.

options

PacketCapturesCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PacketCaptureResult>, PacketCaptureResult>>

beginCreateAndWait(string, string, string, PacketCapture, PacketCapturesCreateOptionalParams)

Create and start a packet capture on the specified VM.

function beginCreateAndWait(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, parameters: PacketCapture, options?: PacketCapturesCreateOptionalParams): Promise<PacketCaptureResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

parameters

PacketCapture

Parameters that define the create packet capture operation.

options

PacketCapturesCreateOptionalParams

The options parameters.

Returns

Promise<PacketCaptureResult>

beginDelete(string, string, string, PacketCapturesDeleteOptionalParams)

Deletes the specified packet capture session.

function beginDelete(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

options

PacketCapturesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, PacketCapturesDeleteOptionalParams)

Deletes the specified packet capture session.

function beginDeleteAndWait(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

options

PacketCapturesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGetStatus(string, string, string, PacketCapturesGetStatusOptionalParams)

Query the status of a running packet capture session.

function beginGetStatus(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesGetStatusOptionalParams): Promise<SimplePollerLike<OperationState<PacketCaptureQueryStatusResult>, PacketCaptureQueryStatusResult>>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the Network Watcher resource.

packetCaptureName

string

The name given to the packet capture session.

options

PacketCapturesGetStatusOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PacketCaptureQueryStatusResult>, PacketCaptureQueryStatusResult>>

beginGetStatusAndWait(string, string, string, PacketCapturesGetStatusOptionalParams)

Query the status of a running packet capture session.

function beginGetStatusAndWait(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesGetStatusOptionalParams): Promise<PacketCaptureQueryStatusResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the Network Watcher resource.

packetCaptureName

string

The name given to the packet capture session.

options

PacketCapturesGetStatusOptionalParams

The options parameters.

Returns

Promise<PacketCaptureQueryStatusResult>

beginStop(string, string, string, PacketCapturesStopOptionalParams)

Stops a specified packet capture session.

function beginStop(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

options

PacketCapturesStopOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, string, PacketCapturesStopOptionalParams)

Stops a specified packet capture session.

function beginStopAndWait(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

options

PacketCapturesStopOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PacketCapturesGetOptionalParams)

Gets a packet capture session by name.

function get(resourceGroupName: string, networkWatcherName: string, packetCaptureName: string, options?: PacketCapturesGetOptionalParams): Promise<PacketCaptureResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

packetCaptureName

string

The name of the packet capture session.

options

PacketCapturesGetOptionalParams

The options parameters.

Returns

Promise<PacketCaptureResult>

list(string, string, PacketCapturesListOptionalParams)

Lists all packet capture sessions within the specified resource group.

function list(resourceGroupName: string, networkWatcherName: string, options?: PacketCapturesListOptionalParams): PagedAsyncIterableIterator<PacketCaptureResult, PacketCaptureResult[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the Network Watcher resource.

options

PacketCapturesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PacketCaptureResult, PacketCaptureResult[], PageSettings>