packet_captures

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

Overview

Name	packet_captures
Type	Resource
Id	azure.network.packet_captures

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns a packet capture session.

Name	Datatype	Description
id	string	ID of the packet capture operation.
name	string	Name of the packet capture session.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the packet capture result.

list

Successful packet capture enumeration request.

Name	Datatype	Description
id	string	ID of the packet capture operation.
name	string	Name of the packet capture session.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the packet capture result.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkWatcherName, packetCaptureName, subscriptionId		Gets a packet capture session by name.
list	select	resourceGroupName, networkWatcherName, subscriptionId		Lists all packet capture sessions within the specified resource group.
create	insert	resourceGroupName, networkWatcherName, packetCaptureName, subscriptionId, data__properties		Create and start a packet capture on the specified VM.
delete	delete	resourceGroupName, networkWatcherName, packetCaptureName, subscriptionId		Deletes the specified packet capture session.
stop	exec	resourceGroupName, networkWatcherName, packetCaptureName, subscriptionId		Stops a specified 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.
packetCaptureName	string	The name of 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

Gets a packet capture session by name.

SELECT
id,
name,
etag,
properties
FROM azure.network.packet_captures
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkWatcherName = '{{ networkWatcherName }}' -- required
AND packetCaptureName = '{{ packetCaptureName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all packet capture sessions within the specified resource group.

SELECT
id,
name,
etag,
properties
FROM azure.network.packet_captures
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkWatcherName = '{{ networkWatcherName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create and start a packet capture on the specified VM.

INSERT INTO azure.network.packet_captures (
data__properties,
resourceGroupName,
networkWatcherName,
packetCaptureName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ networkWatcherName }}',
'{{ packetCaptureName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: packet_captures
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the packet_captures resource.
    - name: networkWatcherName
      value: string
      description: Required parameter for the packet_captures resource.
    - name: packetCaptureName
      value: string
      description: Required parameter for the packet_captures resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the packet_captures resource.
    - name: properties
      value: object
      description: |
        Properties of the packet capture.

DELETE examples

delete

Deletes the specified packet capture session.

DELETE FROM azure.network.packet_captures
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkWatcherName = '{{ networkWatcherName }}' --required
AND packetCaptureName = '{{ packetCaptureName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

stop

Stops a specified packet capture session.

EXEC azure.network.packet_captures.stop 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkWatcherName='{{ networkWatcherName }}' --required, 
@packetCaptureName='{{ packetCaptureName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;