PacketCaptureResultProperties interface

Package:

@azure/arm-network

The properties of a packet capture session.

Extends

PacketCaptureParameters

Properties

provisioningState

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

Inherited 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'.
filters	A list of packet capture filters.
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

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

Inherited Property Details

bytesToCapturePerPacket

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

bytesToCapturePerPacket?: number

Property Value

number

Inherited From PacketCaptureParameters.bytesToCapturePerPacket

captureSettings

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

captureSettings?: PacketCaptureSettings

Property Value

PacketCaptureSettings

Inherited From PacketCaptureParameters.captureSettings

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

Inherited From PacketCaptureParameters.continuousCapture

filters

A list of packet capture filters.

filters?: PacketCaptureFilter[]

Property Value

PacketCaptureFilter[]

Inherited From PacketCaptureParameters.filters

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

Inherited From PacketCaptureParameters.scope

storageLocation

The storage location for a packet capture session.

storageLocation: PacketCaptureStorageLocation

Property Value

PacketCaptureStorageLocation

Inherited From PacketCaptureParameters.storageLocation

target

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

target: string

Property Value

string

Inherited From PacketCaptureParameters.target

targetType

Target type of the resource provided.

targetType?: PacketCaptureTargetType

Property Value

PacketCaptureTargetType

Inherited From PacketCaptureParameters.targetType

timeLimitInSeconds

Maximum duration of the capture session in seconds.

timeLimitInSeconds?: number

Property Value

number

Inherited From PacketCaptureParameters.timeLimitInSeconds

totalBytesPerSession

Maximum size of the capture output.

totalBytesPerSession?: number

Property Value

number

Inherited From PacketCaptureParameters.totalBytesPerSession