TriggerOperationsImpl | @azure/synapse-artifacts

Class containing TriggerOperations operations.

Hierarchy

TriggerOperationsImpl

Implements

TriggerOperations

Index

Constructors

constructor

Methods

Constructors

constructor

new TriggerOperationsImpl(client: ArtifactsClient): TriggerOperationsImpl

- Defined in operations/triggerOperations.ts:43
Initialize a new instance of the class TriggerOperations class.

Parameters
- client: ArtifactsClient
  
  Reference to the service client
Returns TriggerOperationsImpl

Methods

beginCreateOrUpdateTrigger

beginCreateOrUpdateTrigger(triggerName: string, trigger: TriggerResource, options?: TriggerCreateOrUpdateTriggerOptionalParams): Promise<PollerLike<PollOperationState<TriggerCreateOrUpdateTriggerResponse>, TriggerCreateOrUpdateTriggerResponse>>

Implementation of TriggerOperations.beginCreateOrUpdateTrigger
- Defined in operations/triggerOperations.ts:132
Creates or updates a trigger.

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

beginCreateOrUpdateTriggerAndWait

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

Implementation of TriggerOperations.beginCreateOrUpdateTriggerAndWait
- Defined in operations/triggerOperations.ts:215
Creates or updates a trigger.

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

beginDeleteTrigger

beginDeleteTrigger(triggerName: string, options?: TriggerDeleteTriggerOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of TriggerOperations.beginDeleteTrigger
- Defined in operations/triggerOperations.ts:260
Deletes a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: TriggerDeleteTriggerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteTriggerAndWait

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

Implementation of TriggerOperations.beginDeleteTriggerAndWait
- Defined in operations/triggerOperations.ts:336
Deletes a trigger.

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

beginStartTrigger

beginStartTrigger(triggerName: string, options?: TriggerStartTriggerOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of TriggerOperations.beginStartTrigger
- Defined in operations/triggerOperations.ts:573
Starts a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: TriggerStartTriggerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartTriggerAndWait

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

Implementation of TriggerOperations.beginStartTriggerAndWait
- Defined in operations/triggerOperations.ts:649
Starts a trigger.

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

beginStopTrigger

beginStopTrigger(triggerName: string, options?: TriggerStopTriggerOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of TriggerOperations.beginStopTrigger
- Defined in operations/triggerOperations.ts:662
Stops a trigger.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: TriggerStopTriggerOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopTriggerAndWait

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

Implementation of TriggerOperations.beginStopTriggerAndWait
- Defined in operations/triggerOperations.ts:738
Stops a trigger.

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

beginSubscribeTriggerToEvents

beginSubscribeTriggerToEvents(triggerName: string, options?: TriggerSubscribeTriggerToEventsOptionalParams): Promise<PollerLike<PollOperationState<TriggerSubscribeTriggerToEventsResponse>, TriggerSubscribeTriggerToEventsResponse>>

Implementation of TriggerOperations.beginSubscribeTriggerToEvents
- Defined in operations/triggerOperations.ts:349
Subscribe event trigger to events.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: TriggerSubscribeTriggerToEventsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TriggerSubscribeTriggerToEventsResponse>, TriggerSubscribeTriggerToEventsResponse>>

beginSubscribeTriggerToEventsAndWait

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

Implementation of TriggerOperations.beginSubscribeTriggerToEventsAndWait
- Defined in operations/triggerOperations.ts:430
Subscribe event trigger to events.

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

beginUnsubscribeTriggerFromEvents

beginUnsubscribeTriggerFromEvents(triggerName: string, options?: TriggerUnsubscribeTriggerFromEventsOptionalParams): Promise<PollerLike<PollOperationState<TriggerUnsubscribeTriggerFromEventsResponse>, TriggerUnsubscribeTriggerFromEventsResponse>>

Implementation of TriggerOperations.beginUnsubscribeTriggerFromEvents
- Defined in operations/triggerOperations.ts:476
Unsubscribe event trigger from events.

Parameters
- triggerName: string
  
  The trigger name.
- Optional options: TriggerUnsubscribeTriggerFromEventsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TriggerUnsubscribeTriggerFromEventsResponse>, TriggerUnsubscribeTriggerFromEventsResponse>>

beginUnsubscribeTriggerFromEventsAndWait

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

Implementation of TriggerOperations.beginUnsubscribeTriggerFromEventsAndWait
- Defined in operations/triggerOperations.ts:557
Unsubscribe event trigger from events.

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

getEventSubscriptionStatus

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

Implementation of TriggerOperations.getEventSubscriptionStatus
- Defined in operations/triggerOperations.ts:446
Get a trigger's event subscription status.

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

getTrigger

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

Implementation of TriggerOperations.getTrigger
- Defined in operations/triggerOperations.ts:233
Gets a trigger.

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

listTriggersByWorkspace

listTriggersByWorkspace(options?: TriggerGetTriggersByWorkspaceOptionalParams): PagedAsyncIterableIterator<TriggerResource>

Implementation of TriggerOperations.listTriggersByWorkspace
- Defined in operations/triggerOperations.ts:57
Lists triggers.

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ArtifactsClient

Returns TriggerOperationsImpl

Methods

beginCreateOrUpdateTrigger

Parameters

triggerName: string

trigger: TriggerResource

Optional options: TriggerCreateOrUpdateTriggerOptionalParams

Returns Promise<PollerLike<PollOperationState<TriggerCreateOrUpdateTriggerResponse>, TriggerCreateOrUpdateTriggerResponse>>

beginCreateOrUpdateTriggerAndWait

Parameters

triggerName: string

trigger: TriggerResource

Optional options: TriggerCreateOrUpdateTriggerOptionalParams

Returns Promise<TriggerCreateOrUpdateTriggerResponse>

beginDeleteTrigger

Parameters

triggerName: string

Optional options: TriggerDeleteTriggerOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteTriggerAndWait

Parameters

triggerName: string

Optional options: TriggerDeleteTriggerOptionalParams

Returns Promise<void>

beginStartTrigger

Parameters

triggerName: string

Optional options: TriggerStartTriggerOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartTriggerAndWait

Parameters

triggerName: string

Optional options: TriggerStartTriggerOptionalParams

Returns Promise<void>

beginStopTrigger

Parameters

triggerName: string

Optional options: TriggerStopTriggerOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopTriggerAndWait

Parameters

triggerName: string

Optional options: TriggerStopTriggerOptionalParams

Returns Promise<void>

beginSubscribeTriggerToEvents

Parameters

triggerName: string

Optional options: TriggerSubscribeTriggerToEventsOptionalParams

Returns Promise<PollerLike<PollOperationState<TriggerSubscribeTriggerToEventsResponse>, TriggerSubscribeTriggerToEventsResponse>>

beginSubscribeTriggerToEventsAndWait

Parameters

triggerName: string

Optional options: TriggerSubscribeTriggerToEventsOptionalParams

Returns Promise<TriggerSubscribeTriggerToEventsResponse>

beginUnsubscribeTriggerFromEvents

Parameters

triggerName: string

Optional options: TriggerUnsubscribeTriggerFromEventsOptionalParams

Returns Promise<PollerLike<PollOperationState<TriggerUnsubscribeTriggerFromEventsResponse>, TriggerUnsubscribeTriggerFromEventsResponse>>

beginUnsubscribeTriggerFromEventsAndWait

Parameters

triggerName: string

Optional options: TriggerUnsubscribeTriggerFromEventsOptionalParams

Returns Promise<TriggerUnsubscribeTriggerFromEventsResponse>

getEventSubscriptionStatus

Parameters

triggerName: string

Optional options: TriggerGetEventSubscriptionStatusOptionalParams

Returns Promise<TriggerGetEventSubscriptionStatusResponse>

getTrigger

Parameters