PacketCapturesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:packet_captures> attribute.

Inheritance

builtins.object

PacketCapturesOperations

Constructor

PacketCapturesOperations(*args, **kwargs)

Methods

begin_create	Create and start a packet capture on the specified VM.
begin_delete	Deletes the specified packet capture session.
begin_get_status	Query the status of a running packet capture session.
begin_stop	Stops a specified packet capture session.
get	Gets a packet capture session by name.
list	Lists all packet capture sessions within the specified resource group.

begin_create

Create and start a packet capture on the specified VM.

begin_create(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, parameters: _models.PacketCapture, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PacketCaptureResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the network watcher. Required.
packet_capture_name Required	str The name of the packet capture session. Required.
parameters Required	PacketCapture or IO[bytes] Parameters that define the create packet capture operation. Is either a PacketCapture type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PacketCaptureResult]	An instance of LROPoller that returns either PacketCaptureResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified packet capture session.

begin_delete(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the network watcher. Required.
packet_capture_name Required	str The name of the packet capture session. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_get_status

Query the status of a running packet capture session.

begin_get_status(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) -> LROPoller[PacketCaptureQueryStatusResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
packet_capture_name Required	str The name given to the packet capture session. Required.

Returns

Type	Description
LROPoller[PacketCaptureQueryStatusResult]	An instance of LROPoller that returns either PacketCaptureQueryStatusResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops a specified packet capture session.

begin_stop(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the network watcher. Required.
packet_capture_name Required	str The name of the packet capture session. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a packet capture session by name.

get(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) -> PacketCaptureResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the network watcher. Required.
packet_capture_name Required	str The name of the packet capture session. Required.

Returns

Type	Description
PacketCaptureResult	PacketCaptureResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all packet capture sessions within the specified resource group.

list(resource_group_name: str, network_watcher_name: str, **kwargs: Any) -> Iterable[PacketCaptureResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.

Returns

Type	Description
ItemPaged[PacketCaptureResult]	An iterator like instance of either PacketCaptureResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>