Trigger | @azure/synapse-artifacts

Azure Synapse nested object which contains information about creating pipeline run Interface representing a Trigger.

Hierarchy

Trigger

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Methods

Properties

Optional annotations

annotations: any[]

List of tags that can be used for describing the trigger.

Optional description

description: undefined | string

Trigger description.

Optional runtimeState

runtimeState: TriggerRuntimeState

Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. NOTE: This property will not be serialized. It can only be populated by the server.

type

Polymorphic discriminator, which specifies the different types this object can be

Methods

createOrUpdateTrigger

createOrUpdateTrigger(triggerName: string, trigger: TriggerResource, options?: TriggerCreateOrUpdateTriggerOptionalParams): Promise<LROPoller<TriggerCreateOrUpdateTriggerResponse>>

- Defined in operationsInterfaces/trigger.ts:40
Creates or updates a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- trigger: TriggerResource
  
  Trigger resource definition.
- Optional options: TriggerCreateOrUpdateTriggerOptionalParams
  
  The options parameters.
Returns Promise<LROPoller<TriggerCreateOrUpdateTriggerResponse>>

deleteTrigger

deleteTrigger(triggerName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

- Defined in operationsInterfaces/trigger.ts:59
Deletes a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<coreHttp.RestResponse>>

getEventSubscriptionStatus

getEventSubscriptionStatus(triggerName: string, options?: coreHttp.OperationOptions): Promise<TriggerGetEventSubscriptionStatusResponse>

- Defined in operationsInterfaces/trigger.ts:77
Get a trigger's event subscription status.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<TriggerGetEventSubscriptionStatusResponse>

getTrigger

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

- Defined in operationsInterfaces/trigger.ts:50
Gets a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: TriggerGetTriggerOptionalParams
  
  The options parameters.
Returns Promise<TriggerGetTriggerResponse>

listTriggersByWorkspace

listTriggersByWorkspace(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<TriggerResource>

- Defined in operationsInterfaces/trigger.ts:31
Lists triggers.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<TriggerResource>

startTrigger

startTrigger(triggerName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

- Defined in operationsInterfaces/trigger.ts:95
Starts a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<coreHttp.RestResponse>>

stopTrigger

stopTrigger(triggerName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

- Defined in operationsInterfaces/trigger.ts:104
Stops a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<coreHttp.RestResponse>>

subscribeTriggerToEvents

subscribeTriggerToEvents(triggerName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<TriggerSubscribeTriggerToEventsResponse>>

- Defined in operationsInterfaces/trigger.ts:68
Subscribe event trigger to events.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<TriggerSubscribeTriggerToEventsResponse>>

unsubscribeTriggerFromEvents

unsubscribeTriggerFromEvents(triggerName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<TriggerUnsubscribeTriggerFromEventsResponse>>

- Defined in operationsInterfaces/trigger.ts:86
Unsubscribe event trigger from events.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<LROPoller<TriggerUnsubscribeTriggerFromEventsResponse>>

Hierarchy

Indexable

Index

Properties

Methods

Properties

Optional annotations

Optional description

Optional runtimeState

type

Methods

createOrUpdateTrigger

Parameters

triggerName: string

trigger: TriggerResource

Optional options: TriggerCreateOrUpdateTriggerOptionalParams

Returns Promise<LROPoller<TriggerCreateOrUpdateTriggerResponse>>

deleteTrigger

Parameters

triggerName: string

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<coreHttp.RestResponse>>

getEventSubscriptionStatus

Parameters

triggerName: string

Optional options: coreHttp.OperationOptions

Returns Promise<TriggerGetEventSubscriptionStatusResponse>

getTrigger

Parameters

triggerName: string

Optional options: TriggerGetTriggerOptionalParams

Returns Promise<TriggerGetTriggerResponse>

listTriggersByWorkspace

Parameters

Optional options: coreHttp.OperationOptions

Returns PagedAsyncIterableIterator<TriggerResource>

startTrigger

Parameters

triggerName: string

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<coreHttp.RestResponse>>

stopTrigger

Parameters

triggerName: string

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<coreHttp.RestResponse>>

subscribeTriggerToEvents

Parameters

triggerName: string

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<TriggerSubscribeTriggerToEventsResponse>>

unsubscribeTriggerFromEvents

Parameters

triggerName: string

Optional options: coreHttp.OperationOptions

Returns Promise<LROPoller<TriggerUnsubscribeTriggerFromEventsResponse>>