TriggerOperations interface

Package:

@azure/synapse-artifacts

Interface representing a TriggerOperations.

Methods

beginCreateOrUpdateTrigger(string, TriggerResource, TriggerCreateOrUpdateTriggerOptionalParams)	Creates or updates a trigger.
beginCreateOrUpdateTriggerAndWait(string, TriggerResource, TriggerCreateOrUpdateTriggerOptionalParams)	Creates or updates a trigger.
beginDeleteTrigger(string, TriggerDeleteTriggerOptionalParams)	Deletes a trigger.
beginDeleteTriggerAndWait(string, TriggerDeleteTriggerOptionalParams)	Deletes a trigger.
beginStartTrigger(string, TriggerStartTriggerOptionalParams)	Starts a trigger.
beginStartTriggerAndWait(string, TriggerStartTriggerOptionalParams)	Starts a trigger.
beginStopTrigger(string, TriggerStopTriggerOptionalParams)	Stops a trigger.
beginStopTriggerAndWait(string, TriggerStopTriggerOptionalParams)	Stops a trigger.
beginSubscribeTriggerToEvents(string, TriggerSubscribeTriggerToEventsOptionalParams)	Subscribe event trigger to events.
beginSubscribeTriggerToEventsAndWait(string, TriggerSubscribeTriggerToEventsOptionalParams)	Subscribe event trigger to events.
beginUnsubscribeTriggerFromEvents(string, TriggerUnsubscribeTriggerFromEventsOptionalParams)	Unsubscribe event trigger from events.
beginUnsubscribeTriggerFromEventsAndWait(string, TriggerUnsubscribeTriggerFromEventsOptionalParams)	Unsubscribe event trigger from events.
getEventSubscriptionStatus(string, TriggerGetEventSubscriptionStatusOptionalParams)	Get a trigger's event subscription status.
getTrigger(string, TriggerGetTriggerOptionalParams)	Gets a trigger.
listTriggersByWorkspace(TriggerGetTriggersByWorkspaceOptionalParams)	Lists triggers.

Method Details

beginCreateOrUpdateTrigger(string, TriggerResource, TriggerCreateOrUpdateTriggerOptionalParams)

Creates or updates a trigger.

function beginCreateOrUpdateTrigger(triggerName: string, trigger: TriggerResource, options?: TriggerCreateOrUpdateTriggerOptionalParams): Promise<SimplePollerLike<OperationState<TriggerResource>, TriggerResource>>

Parameters

triggerName

string

The trigger name.

trigger

TriggerResource

Trigger resource definition.

options

TriggerCreateOrUpdateTriggerOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TriggerResource>, TriggerResource>>

beginCreateOrUpdateTriggerAndWait(string, TriggerResource, TriggerCreateOrUpdateTriggerOptionalParams)

Creates or updates a trigger.

function beginCreateOrUpdateTriggerAndWait(triggerName: string, trigger: TriggerResource, options?: TriggerCreateOrUpdateTriggerOptionalParams): Promise<TriggerResource>

Parameters

triggerName

string

The trigger name.

trigger

TriggerResource

Trigger resource definition.

options

TriggerCreateOrUpdateTriggerOptionalParams

The options parameters.

Returns

Promise<TriggerResource>

beginDeleteTrigger(string, TriggerDeleteTriggerOptionalParams)

Deletes a trigger.

function beginDeleteTrigger(triggerName: string, options?: TriggerDeleteTriggerOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

triggerName

string

The trigger name.

options

TriggerDeleteTriggerOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteTriggerAndWait(string, TriggerDeleteTriggerOptionalParams)

Deletes a trigger.

function beginDeleteTriggerAndWait(triggerName: string, options?: TriggerDeleteTriggerOptionalParams): Promise<void>

Parameters

triggerName

string

The trigger name.

options

TriggerDeleteTriggerOptionalParams

The options parameters.

Returns

Promise<void>

beginStartTrigger(string, TriggerStartTriggerOptionalParams)

Starts a trigger.

function beginStartTrigger(triggerName: string, options?: TriggerStartTriggerOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

triggerName

string

The trigger name.

options

TriggerStartTriggerOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartTriggerAndWait(string, TriggerStartTriggerOptionalParams)

Starts a trigger.

function beginStartTriggerAndWait(triggerName: string, options?: TriggerStartTriggerOptionalParams): Promise<void>

Parameters

triggerName

string

The trigger name.

options

TriggerStartTriggerOptionalParams

The options parameters.

Returns

Promise<void>

beginStopTrigger(string, TriggerStopTriggerOptionalParams)

Stops a trigger.

function beginStopTrigger(triggerName: string, options?: TriggerStopTriggerOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

triggerName

string

The trigger name.

options

TriggerStopTriggerOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopTriggerAndWait(string, TriggerStopTriggerOptionalParams)

Stops a trigger.

function beginStopTriggerAndWait(triggerName: string, options?: TriggerStopTriggerOptionalParams): Promise<void>

Parameters

triggerName

string

The trigger name.

options

TriggerStopTriggerOptionalParams

The options parameters.

Returns

Promise<void>

beginSubscribeTriggerToEvents(string, TriggerSubscribeTriggerToEventsOptionalParams)

Subscribe event trigger to events.

function beginSubscribeTriggerToEvents(triggerName: string, options?: TriggerSubscribeTriggerToEventsOptionalParams): Promise<SimplePollerLike<OperationState<TriggerSubscriptionOperationStatus>, TriggerSubscriptionOperationStatus>>

Parameters

triggerName

string

The trigger name.

options

TriggerSubscribeTriggerToEventsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TriggerSubscriptionOperationStatus>, TriggerSubscriptionOperationStatus>>

beginSubscribeTriggerToEventsAndWait(string, TriggerSubscribeTriggerToEventsOptionalParams)

Subscribe event trigger to events.

function beginSubscribeTriggerToEventsAndWait(triggerName: string, options?: TriggerSubscribeTriggerToEventsOptionalParams): Promise<TriggerSubscriptionOperationStatus>

Parameters

triggerName

string

The trigger name.

options

TriggerSubscribeTriggerToEventsOptionalParams

The options parameters.

Returns

Promise<TriggerSubscriptionOperationStatus>

beginUnsubscribeTriggerFromEvents(string, TriggerUnsubscribeTriggerFromEventsOptionalParams)

Unsubscribe event trigger from events.

function beginUnsubscribeTriggerFromEvents(triggerName: string, options?: TriggerUnsubscribeTriggerFromEventsOptionalParams): Promise<SimplePollerLike<OperationState<TriggerSubscriptionOperationStatus>, TriggerSubscriptionOperationStatus>>

Parameters

triggerName

string

The trigger name.

options

TriggerUnsubscribeTriggerFromEventsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TriggerSubscriptionOperationStatus>, TriggerSubscriptionOperationStatus>>

beginUnsubscribeTriggerFromEventsAndWait(string, TriggerUnsubscribeTriggerFromEventsOptionalParams)

Unsubscribe event trigger from events.

function beginUnsubscribeTriggerFromEventsAndWait(triggerName: string, options?: TriggerUnsubscribeTriggerFromEventsOptionalParams): Promise<TriggerSubscriptionOperationStatus>

Parameters

triggerName

string

The trigger name.

options

TriggerUnsubscribeTriggerFromEventsOptionalParams

The options parameters.

Returns

Promise<TriggerSubscriptionOperationStatus>

getEventSubscriptionStatus(string, TriggerGetEventSubscriptionStatusOptionalParams)

Get a trigger's event subscription status.

function getEventSubscriptionStatus(triggerName: string, options?: TriggerGetEventSubscriptionStatusOptionalParams): Promise<TriggerSubscriptionOperationStatus>

Parameters

triggerName

string

The trigger name.

options

TriggerGetEventSubscriptionStatusOptionalParams

The options parameters.

Returns

Promise<TriggerSubscriptionOperationStatus>

getTrigger(string, TriggerGetTriggerOptionalParams)

Gets a trigger.

function getTrigger(triggerName: string, options?: TriggerGetTriggerOptionalParams): Promise<TriggerResource>

Parameters

triggerName

string

The trigger name.

options

TriggerGetTriggerOptionalParams

The options parameters.

Returns

Promise<TriggerResource>

listTriggersByWorkspace(TriggerGetTriggersByWorkspaceOptionalParams)

Lists triggers.

function listTriggersByWorkspace(options?: TriggerGetTriggersByWorkspaceOptionalParams): PagedAsyncIterableIterator<TriggerResource, TriggerResource[], PageSettings>

Parameters

options

TriggerGetTriggersByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TriggerResource, TriggerResource[], PageSettings>