triggers

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

Overview

Name	triggers
Type	Resource
Id	azure.data_factory.triggers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotations	array	List of tags that can be used for describing the trigger.
description	string	Trigger description.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
runtimeState	string	Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Known values are: "Started", "Stopped", and "Disabled". (Started, Stopped, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_factory

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotations	array	List of tags that can be used for describing the trigger.
description	string	Trigger description.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
runtimeState	string	Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Known values are: "Started", "Stopped", and "Disabled". (Started, Stopped, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, factory_name, trigger_name, subscription_id		Gets a trigger.
list_by_factory	select	resource_group_name, factory_name, subscription_id		Lists triggers.
create_or_update	insert	resource_group_name, factory_name, trigger_name, subscription_id, properties		Creates or updates a trigger.
create_or_update	replace	resource_group_name, factory_name, trigger_name, subscription_id, properties		Creates or updates a trigger.
delete	delete	resource_group_name, factory_name, trigger_name, subscription_id		Deletes a trigger.
get_event_subscription_status	exec	resource_group_name, factory_name, trigger_name, subscription_id		Get a trigger's event subscription status.
query_by_factory	exec	resource_group_name, factory_name, subscription_id		Query triggers.
subscribe_to_events	exec	resource_group_name, factory_name, trigger_name, subscription_id		Subscribe event trigger to events.
unsubscribe_from_events	exec	resource_group_name, factory_name, trigger_name, subscription_id		Unsubscribe event trigger from events.
start	exec	resource_group_name, factory_name, trigger_name, subscription_id		Starts a trigger.
stop	exec	resource_group_name, factory_name, trigger_name, subscription_id		Stops a trigger.

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
factory_name	string	The factory name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
trigger_name	string	The trigger name. Required.

SELECT examples

get

Gets a trigger.

SELECT
id,
name,
annotations,
description,
etag,
runtimeState,
systemData,
type
FROM azure.data_factory.triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists triggers.

SELECT
id,
name,
annotations,
description,
etag,
runtimeState,
systemData,
type
FROM azure.data_factory.triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a trigger.

INSERT INTO azure.data_factory.triggers (
properties,
resource_group_name,
factory_name,
trigger_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ trigger_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: triggers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the triggers resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the triggers resource.
  - name: trigger_name
    value: "{{ trigger_name }}"
    description: Required parameter for the triggers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the triggers resource.
  - name: properties
    description: |
      Properties of the trigger. Required.
    value:
      type: "{{ type }}"
      description: "{{ description }}"
      runtimeState: "{{ runtimeState }}"
      annotations: "{{ annotations }}"

REPLACE examples

create_or_update

Creates or updates a trigger.

REPLACE azure.data_factory.triggers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND trigger_name = '{{ trigger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a trigger.

DELETE FROM azure.data_factory.triggers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND trigger_name = '{{ trigger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_event_subscription_status

Get a trigger's event subscription status.

EXEC azure.data_factory.triggers.get_event_subscription_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

query_by_factory

Query triggers.

EXEC azure.data_factory.triggers.query_by_factory 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"continuationToken": "{{ continuationToken }}", 
"parentTriggerName": "{{ parentTriggerName }}"
}'
;

subscribe_to_events

Subscribe event trigger to events.

EXEC azure.data_factory.triggers.subscribe_to_events 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

unsubscribe_from_events

Unsubscribe event trigger from events.

EXEC azure.data_factory.triggers.unsubscribe_from_events 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Starts a trigger.

EXEC azure.data_factory.triggers.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops a trigger.

EXEC azure.data_factory.triggers.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;