packet_captures

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

Overview

Name	packet_captures
Type	Resource
Id	azure.mobile_network.packet_captures

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns information about the packet capture session.

Name	Datatype	Description
properties	object	Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties

list_by_packet_core_control_plane

Request successful. The operation returns a list of packet capture sessions.

Name	Datatype	Description
properties	object	Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCaptureName		Gets information about the specified packet capture session.
list_by_packet_core_control_plane	select	subscriptionId, resourceGroupName, packetCoreControlPlaneName		Lists all the packet capture sessions under a packet core control plane.
create_or_update	insert	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCaptureName, data__properties		Creates or updates a packet capture.
delete	delete	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCaptureName		Deletes the specified packet capture.
stop	exec	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCaptureName		Stop a 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
packetCaptureName	string	The name of the packet capture session.
packetCoreControlPlaneName	string	The name of the packet core control plane.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about the specified packet capture session.

SELECT
properties
FROM azure.mobile_network.packet_captures
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND packetCoreControlPlaneName = '{{ packetCoreControlPlaneName }}' -- required
AND packetCaptureName = '{{ packetCaptureName }}' -- required
;

list_by_packet_core_control_plane

Lists all the packet capture sessions under a packet core control plane.

SELECT
properties
FROM azure.mobile_network.packet_captures
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND packetCoreControlPlaneName = '{{ packetCoreControlPlaneName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a packet capture.

INSERT INTO azure.mobile_network.packet_captures (
data__properties,
subscriptionId,
resourceGroupName,
packetCoreControlPlaneName,
packetCaptureName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ packetCoreControlPlaneName }}',
'{{ packetCaptureName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: packet_captures
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the packet_captures resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the packet_captures resource.
    - name: packetCoreControlPlaneName
      value: string
      description: Required parameter for the packet_captures resource.
    - name: packetCaptureName
      value: string
      description: Required parameter for the packet_captures resource.
    - name: properties
      value: object
      description: |
        Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties

DELETE examples

delete

Deletes the specified packet capture.

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

Lifecycle Methods

stop

Stop a packet capture session.

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