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.
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.
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	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, triggerName	api-version	Get a Trigger in a shareSubscription
list_by_share_subscription	select	subscriptionId, resourceGroupName, accountName, shareSubscriptionName	api-version, $skipToken	List Triggers in a share subscription
create	insert	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, triggerName, data__kind	api-version	Create a Trigger
delete	delete	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, triggerName	api-version	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
accountName	string	The name of the share account.
resourceGroupName	string	The resource group name.
shareSubscriptionName	string	The name of the shareSubscription.
subscriptionId	string	The subscription identifier
triggerName	string	The name of the trigger.
$skipToken	string	Continuation token
api-version	string	The api version to use.

SELECT examples

get

Get a Trigger in a shareSubscription

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.triggers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareSubscriptionName = '{{ shareSubscriptionName }}' -- required
AND triggerName = '{{ triggerName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_share_subscription

List Triggers in a share subscription

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.triggers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareSubscriptionName = '{{ shareSubscriptionName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Create a Trigger

INSERT INTO azure.data_share.triggers (
data__kind,
subscriptionId,
resourceGroupName,
accountName,
shareSubscriptionName,
triggerName,
api-version
)
SELECT 
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareSubscriptionName }}',
'{{ triggerName }}',
'{{ api-version }}'
RETURNING
id,
name,
kind,
systemData,
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: accountName
      value: string
      description: Required parameter for the triggers resource.
    - name: shareSubscriptionName
      value: string
      description: Required parameter for the triggers resource.
    - name: triggerName
      value: string
      description: Required parameter for the triggers resource.
    - name: kind
      value: string
      description: |
        Kind of synchronization on trigger.
      valid_values: ['ScheduleBased']
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete a Trigger in a shareSubscription

DELETE FROM azure.data_share.triggers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareSubscriptionName = '{{ shareSubscriptionName }}' --required
AND triggerName = '{{ triggerName }}' --required
AND api-version = '{{ api-version }}'
;