triggers

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

Overview

Name	triggers
Type	Resource
Id	azure.data_box_edge.triggers

Fields

The following fields are returned by SELECT queries:

get

The trigger.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	Trigger Kind.
systemData	object	Metadata pertaining to creation and last modification of Trigger
type	string	The hierarchical type of the object.

list_by_data_box_edge_device

List all the triggers configured in the device

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	Trigger Kind.
systemData	object	Metadata pertaining to creation and last modification of Trigger
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, name, subscriptionId, resourceGroupName		Get a specific trigger by name.
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName	$filter	Lists all the triggers configured in the device.
create_or_update	insert	deviceName, name, subscriptionId, resourceGroupName, data__kind		Creates or updates a trigger.
delete	delete	deviceName, name, subscriptionId, resourceGroupName		Deletes the trigger on the gateway device.

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
deviceName	string	The device name.
name	string	The trigger name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.
$filter	string	Specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property

SELECT examples

get

Get a specific trigger by name.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_box_edge.triggers
WHERE deviceName = '{{ deviceName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_data_box_edge_device

Lists all the triggers configured in the device.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_box_edge.triggers
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates a trigger.

INSERT INTO azure.data_box_edge.triggers (
data__kind,
deviceName,
name,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ kind }}' /* required */,
'{{ deviceName }}',
'{{ name }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: triggers
  props:
    - name: deviceName
      value: string
      description: Required parameter for the triggers resource.
    - name: name
      value: string
      description: Required parameter for the triggers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the triggers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the triggers resource.
    - name: kind
      value: string
      description: |
        Trigger Kind.
      valid_values: ['FileEvent', 'PeriodicTimerEvent']

DELETE examples

delete

Deletes the trigger on the gateway device.

DELETE FROM azure.data_box_edge.triggers
WHERE deviceName = '{{ deviceName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;