PacketCaptureResult interface

Package:

@azure/arm-network

Information about packet capture session.

Properties

bytesToCapturePerPacket	Number of bytes captured per packet, the remaining bytes are truncated.
captureSettings	The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
continuousCapture	This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
filters	A list of packet capture filters.
id	ID of the packet capture operation. NOTE: This property will not be serialized. It can only be populated by the server.
name	Name of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The provisioning state of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.
scope	A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
storageLocation	The storage location for a packet capture session.
target	The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
targetType	Target type of the resource provided.
timeLimitInSeconds	Maximum duration of the capture session in seconds.
totalBytesPerSession	Maximum size of the capture output.

Property Details

bytesToCapturePerPacket

Number of bytes captured per packet, the remaining bytes are truncated.

bytesToCapturePerPacket?: number

Property Value

number

captureSettings

The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.

captureSettings?: PacketCaptureSettings

Property Value

PacketCaptureSettings

continuousCapture

This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.

continuousCapture?: boolean

Property Value

boolean

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

filters

A list of packet capture filters.

filters?: PacketCaptureFilter[]

Property Value

PacketCaptureFilter[]

id

ID of the packet capture operation. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

name

Name of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

provisioningState

The provisioning state of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

scope

A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.

scope?: PacketCaptureMachineScope

Property Value

PacketCaptureMachineScope

storageLocation

The storage location for a packet capture session.

storageLocation?: PacketCaptureStorageLocation

Property Value

PacketCaptureStorageLocation

target

The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.

target?: string

Property Value

string

targetType

Target type of the resource provided.

targetType?: PacketCaptureTargetType

Property Value

PacketCaptureTargetType

timeLimitInSeconds

Maximum duration of the capture session in seconds.

timeLimitInSeconds?: number

Property Value

number

totalBytesPerSession

Maximum size of the capture output.

totalBytesPerSession?: number

Property Value

number