trigger

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

Overview

Name	trigger
Type	Resource
Id	azure.synapse_artifacts.trigger

Fields

The following fields are returned by SELECT queries:

get_trigger

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
	object	Unmatched properties from the message are deserialized to this collection.
annotations	array	List of tags that can be used for describing the trigger.
description	string	Trigger description.
etag	string	Resource Etag.
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".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_triggers_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
	object	Unmatched properties from the message are deserialized to this collection.
annotations	array	List of tags that can be used for describing the trigger.
description	string	Trigger description.
etag	string	Resource Etag.
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".
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_trigger	select	trigger_name, endpoint	If-None-Match	Gets a trigger.
get_triggers_by_workspace	select	endpoint		Lists triggers.
create_or_update_trigger	insert	trigger_name, endpoint, type	If-Match	Creates or updates a trigger.
create_or_update_trigger	replace	trigger_name, endpoint, type	If-Match	Creates or updates a trigger.
delete_trigger	delete	trigger_name, endpoint		Deletes a trigger.
get_event_subscription_status	exec	trigger_name, endpoint		Get a trigger's event subscription status.
subscribe_trigger_to_events	exec	trigger_name, endpoint		Subscribe event trigger to events.
unsubscribe_trigger_from_events	exec	trigger_name, endpoint		Unsubscribe event trigger from events.
start_trigger	exec	trigger_name, endpoint		Starts a trigger.
stop_trigger	exec	trigger_name, endpoint		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
endpoint	string	The service endpoint host (no scheme). (default: )
trigger_name	string	The trigger name. Required.
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. Default value is None.
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. Default value is None.

SELECT examples

get_trigger

Gets a trigger.

SELECT
id,
name,
,
annotations,
description,
etag,
runtimeState,
type
FROM azure.synapse_artifacts.trigger
WHERE trigger_name = '{{ trigger_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

get_triggers_by_workspace

Lists triggers.

SELECT
id,
name,
,
annotations,
description,
etag,
runtimeState,
type
FROM azure.synapse_artifacts.trigger
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_trigger

Creates or updates a trigger.

INSERT INTO azure.synapse_artifacts.trigger (
,
type,
description,
annotations,
trigger_name,
endpoint,
If-Match
)
SELECT 
'{{  }}',
'{{ type }}' /* required */,
'{{ description }}',
'{{ annotations }}',
'{{ trigger_name }}',
'{{ endpoint }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: trigger
props:
  - name: trigger_name
    value: "{{ trigger_name }}"
    description: Required parameter for the trigger resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the trigger resource.
  - name: 
    value: "{{  }}"
    description: |
      Unmatched properties from the message are deserialized to this collection.
  - name: type
    value: "{{ type }}"
    description: |
      Trigger type. Required.
  - name: description
    value: "{{ description }}"
    description: |
      Trigger description.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      List of tags that can be used for describing the trigger.
  - name: If-Match
    value: "{{ If-Match }}"
    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. Default value is None.
    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. Default value is None.

REPLACE examples

create_or_update_trigger

Creates or updates a trigger.

REPLACE azure.synapse_artifacts.trigger
SET 
 = '{{  }}',
type = '{{ type }}',
description = '{{ description }}',
annotations = '{{ annotations }}'
WHERE 
trigger_name = '{{ trigger_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND type = '{{ type }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete_trigger

Deletes a trigger.

DELETE FROM azure.synapse_artifacts.trigger
WHERE trigger_name = '{{ trigger_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_event_subscription_status

Get a trigger's event subscription status.

EXEC azure.synapse_artifacts.trigger.get_event_subscription_status 
@trigger_name='{{ trigger_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

subscribe_trigger_to_events

Subscribe event trigger to events.

EXEC azure.synapse_artifacts.trigger.subscribe_trigger_to_events 
@trigger_name='{{ trigger_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

unsubscribe_trigger_from_events

Unsubscribe event trigger from events.

EXEC azure.synapse_artifacts.trigger.unsubscribe_trigger_from_events 
@trigger_name='{{ trigger_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

start_trigger

Starts a trigger.

EXEC azure.synapse_artifacts.trigger.start_trigger 
@trigger_name='{{ trigger_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

stop_trigger

Stops a trigger.

EXEC azure.synapse_artifacts.trigger.stop_trigger 
@trigger_name='{{ trigger_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;