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

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Properties of the trigger.
type	string	The resource type.

list_by_factory

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Properties of the trigger.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, triggerName	api-version, If-None-Match	Gets a trigger.
list_by_factory	select	subscriptionId, resourceGroupName, factoryName	api-version	Lists triggers.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, triggerName, data__properties	api-version, If-Match	Creates or updates a trigger.
delete	delete	subscriptionId, resourceGroupName, factoryName, triggerName	api-version	Deletes a trigger.
query_by_factory	exec	subscriptionId, resourceGroupName, factoryName	api-version	Query triggers.
subscribe_to_events	exec	subscriptionId, resourceGroupName, factoryName, triggerName	api-version	Subscribe event trigger to events.
unsubscribe_from_events	exec	subscriptionId, resourceGroupName, factoryName, triggerName	api-version	Unsubscribe event trigger from events.
start	exec	subscriptionId, resourceGroupName, factoryName, triggerName	api-version	Starts a trigger.
stop	exec	subscriptionId, resourceGroupName, factoryName, triggerName	api-version	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
factoryName	string	The factory name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
triggerName	string	The trigger name.
If-Match	string	ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
If-None-Match	string	ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
api-version	string	The API version.

SELECT examples

get

Gets a trigger.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.triggers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND triggerName = '{{ triggerName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_factory

Lists triggers.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.triggers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a trigger.

INSERT INTO azure.data_factory.triggers (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
triggerName,
api-version,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ triggerName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: triggers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the triggers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the triggers resource.
    - name: factoryName
      value: string
      description: Required parameter for the triggers resource.
    - name: triggerName
      value: string
      description: Required parameter for the triggers resource.
    - name: properties
      value: object
      description: |
        Properties of the trigger.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      description: ETag of the trigger entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

DELETE examples

delete

Deletes a trigger.

DELETE FROM azure.data_factory.triggers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND triggerName = '{{ triggerName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

query_by_factory

Query triggers.

EXEC azure.data_factory.triggers.query_by_factory 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"continuationToken": "{{ continuationToken }}", 
"parentTriggerName": "{{ parentTriggerName }}"
}'
;

subscribe_to_events

Subscribe event trigger to events.

EXEC azure.data_factory.triggers.subscribe_to_events 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@triggerName='{{ triggerName }}' --required, 
@api-version='{{ api-version }}'
;

unsubscribe_from_events

Unsubscribe event trigger from events.

EXEC azure.data_factory.triggers.unsubscribe_from_events 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@triggerName='{{ triggerName }}' --required, 
@api-version='{{ api-version }}'
;

start

Starts a trigger.

EXEC azure.data_factory.triggers.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@triggerName='{{ triggerName }}' --required, 
@api-version='{{ api-version }}'
;

stop

Stops a trigger.

EXEC azure.data_factory.triggers.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@triggerName='{{ triggerName }}' --required, 
@api-version='{{ api-version }}'
;