PacketCaptureResult Class

Information about packet capture session.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.network._serialization.Model

PacketCaptureResult

Constructor

PacketCaptureResult(*, target: str | None = None, 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, storage_location: _models.PacketCaptureStorageLocation | None = None, 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.
scope	PacketCaptureMachineScope 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	str or PacketCaptureTargetType 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	PacketCaptureStorageLocation The storage location for a packet capture session.
filters	list[PacketCaptureFilter] A list of packet capture filters.
continuous_capture	bool 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	PacketCaptureSettings The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.

Variables

Name	Description
name	str Name of the packet capture session.
id	str ID of the packet capture operation.
etag	str A unique read-only string that changes whenever the resource is updated.
target	str The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
scope	PacketCaptureMachineScope 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	str or PacketCaptureTargetType 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	PacketCaptureStorageLocation The storage location for a packet capture session.
filters	list[PacketCaptureFilter] A list of packet capture filters.
continuous_capture	bool 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	PacketCaptureSettings The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
provisioning_state	str or ProvisioningState The provisioning state of the packet capture session. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".