packet_captures

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

Overview

Name	packet_captures
Type	Resource
Id	azure.network.packet_captures

Fields

vw_packet_captures

Name	Datatype	Description
id	text	ID of the packet capture operation.
name	text	Name of the packet capture session.
bytes_to_capture_per_packet	text	field from the properties object
capture_settings	text	field from the properties object
continuous_capture	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
filters	text	field from the properties object
networkWatcherName	text	field from the properties object
packetCaptureName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
scope	text	field from the properties object
storage_location	text	field from the properties object
subscriptionId	text	field from the properties object
target	text	field from the properties object
target_type	text	field from the properties object
time_limit_in_seconds	text	field from the properties object
total_bytes_per_session	text	field from the properties object

packet_captures

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	The properties of a packet capture session.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	networkWatcherName, packetCaptureName, resourceGroupName, subscriptionId	Gets a packet capture session by name.
list	SELECT	networkWatcherName, resourceGroupName, subscriptionId	Lists all packet capture sessions within the specified resource group.
create	INSERT	networkWatcherName, packetCaptureName, resourceGroupName, subscriptionId, data__properties	Create and start a packet capture on the specified VM.
delete	DELETE	networkWatcherName, packetCaptureName, resourceGroupName, subscriptionId	Deletes the specified packet capture session.
stop	EXEC	networkWatcherName, packetCaptureName, resourceGroupName, subscriptionId	Stops a specified packet capture session.

SELECT examples

Lists all packet capture sessions within the specified resource group.

vw_packet_captures

SELECT
id,
name,
bytes_to_capture_per_packet,
capture_settings,
continuous_capture,
etag,
filters,
networkWatcherName,
packetCaptureName,
provisioning_state,
resourceGroupName,
scope,
storage_location,
subscriptionId,
target,
target_type,
time_limit_in_seconds,
total_bytes_per_session
FROM azure.network.vw_packet_captures
WHERE networkWatcherName = '{{ networkWatcherName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

packet_captures

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

INSERT example

Use the following StackQL query and manifest file to create a new packet_captures resource.

All Properties

/*+ create */
INSERT INTO azure.network.packet_captures (
networkWatcherName,
packetCaptureName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ networkWatcherName }}',
'{{ packetCaptureName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: target
          value: string
        - name: scope
          value:
            - name: include
              value:
                - string
            - name: exclude
              value:
                - string
        - name: targetType
          value: string
        - name: bytesToCapturePerPacket
          value: integer
        - name: totalBytesPerSession
          value: integer
        - name: timeLimitInSeconds
          value: integer
        - name: storageLocation
          value:
            - name: storageId
              value: string
            - name: storagePath
              value: string
            - name: filePath
              value: string
            - name: localPath
              value: string
        - name: filters
          value:
            - - name: protocol
                value: string
              - name: localIPAddress
                value: string
              - name: remoteIPAddress
                value: string
              - name: localPort
                value: string
              - name: remotePort
                value: string
        - name: continuousCapture
          value: boolean
        - name: captureSettings
          value:
            - name: fileCount
              value: integer
            - name: fileSizeInBytes
              value: integer
            - name: sessionTimeLimitInSeconds
              value: integer

DELETE example

Deletes the specified packet_captures resource.

/*+ delete */
DELETE FROM azure.network.packet_captures
WHERE networkWatcherName = '{{ networkWatcherName }}'
AND packetCaptureName = '{{ packetCaptureName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';