triggers

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

Overview

Name	triggers
Type	Resource
Id	azure.data_share.triggers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
kind	string	Kind of synchronization on trigger. Required. "ScheduleBased"
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.

list_by_share_subscription

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
kind	string	Kind of synchronization on trigger. Required. "ScheduleBased"
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, share_subscription_name, trigger_name, subscription_id		Get Trigger in a shareSubscription. Get a Trigger in a shareSubscription.
list_by_share_subscription	select	resource_group_name, account_name, share_subscription_name, subscription_id	$skipToken	List Triggers in a share subscription. List Triggers in a share subscription.
create	insert	resource_group_name, account_name, share_subscription_name, trigger_name, subscription_id, kind		This method creates a trigger for a share subscription. Create a Trigger.
delete	delete	resource_group_name, account_name, share_subscription_name, trigger_name, subscription_id		Delete Trigger in a shareSubscription. Delete a Trigger in a shareSubscription.

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
account_name	string	The name of the share account. Required.
resource_group_name	string	The resource group name. Required.
share_subscription_name	string	The name of the shareSubscription. Required.
subscription_id	string
trigger_name	string	The name of the trigger. Required.
$skipToken	string	Continuation token. Default value is None.

SELECT examples

get

Get Trigger in a shareSubscription. Get a Trigger in a shareSubscription.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_subscription_name = '{{ share_subscription_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_share_subscription

List Triggers in a share subscription. List Triggers in a share subscription.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_subscription_name = '{{ share_subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

This method creates a trigger for a share subscription. Create a Trigger.

INSERT INTO azure.data_share.triggers (
kind,
resource_group_name,
account_name,
share_subscription_name,
trigger_name,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ share_subscription_name }}',
'{{ trigger_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
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: account_name
    value: "{{ account_name }}"
    description: Required parameter for the triggers resource.
  - name: share_subscription_name
    value: "{{ share_subscription_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: kind
    value: "{{ kind }}"
    description: |
      Kind of synchronization on trigger. Required. "ScheduleBased"

DELETE examples

delete

Delete Trigger in a shareSubscription. Delete a Trigger in a shareSubscription.

DELETE FROM azure.data_share.triggers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND share_subscription_name = '{{ share_subscription_name }}' --required
AND trigger_name = '{{ trigger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;