packet_captures_status

Creates, updates, deletes, gets or lists a packet_captures_status resource.

Overview

Name	packet_captures_status
Type	Resource
Id	azure.network.packet_captures_status

Fields

The following fields are returned by SELECT queries:

get

Successful query of packet capture status.

Name	Datatype	Description
id	string	The ID of the packet capture resource.
name	string	The name of the packet capture resource.
captureStartTime	string (date-time)	The start time of the packet capture session.
packetCaptureError	array	List of errors of packet capture session.
packetCaptureStatus	string	The status of the packet capture session.
stopReason	string	The reason the current packet capture session was stopped.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkWatcherName, packetCaptureName, subscriptionId		Query the status of a running packet capture session.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
networkWatcherName	string	The name of the Network Watcher resource.
packetCaptureName	string	The name given to the packet capture session.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Query the status of a running packet capture session.

SELECT
id,
name,
captureStartTime,
packetCaptureError,
packetCaptureStatus,
stopReason
FROM azure.network.packet_captures_status
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkWatcherName = '{{ networkWatcherName }}' -- required
AND packetCaptureName = '{{ packetCaptureName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;