Compartilhar via


PacketCapture Class

Parameters that define the create packet capture operation.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.network._serialization.Model
PacketCapture

Constructor

PacketCapture(*, target: str, storage_location: _models.PacketCaptureStorageLocation, scope: _models.PacketCaptureMachineScope | None = None, target_type: str | _models.PacketCaptureTargetType | None = None, bytes_to_capture_per_packet: int = 0, total_bytes_per_session: int = 1073741824, time_limit_in_seconds: int = 18000, filters: List[_models.PacketCaptureFilter] | None = None, continuous_capture: bool | None = None, capture_settings: _models.PacketCaptureSettings | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
target
str

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

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.

target_type

Target type of the resource provided. Known values are: "AzureVM" and "AzureVMSS".

bytes_to_capture_per_packet
int

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

total_bytes_per_session
int

Maximum size of the capture output.

Default value: 1073741824
time_limit_in_seconds
int

Maximum duration of the capture session in seconds.

Default value: 18000
storage_location

The storage location for a packet capture session. Required.

filters

A list of packet capture filters.

continuous_capture

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'.

capture_settings

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

Variables

Name Description
target
str

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

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.

target_type

Target type of the resource provided. Known values are: "AzureVM" and "AzureVMSS".

bytes_to_capture_per_packet
int

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

total_bytes_per_session
int

Maximum size of the capture output.

time_limit_in_seconds
int

Maximum duration of the capture session in seconds.

storage_location

The storage location for a packet capture session. Required.

filters

A list of packet capture filters.

continuous_capture

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'.

capture_settings

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