Triggers interface

Package:

@azure/arm-datafactory

Interface representing a Triggers.

Methods

beginStart(string, string, string, TriggersStartOptionalParams)	Starts a trigger.
beginStartAndWait(string, string, string, TriggersStartOptionalParams)	Starts a trigger.
beginStop(string, string, string, TriggersStopOptionalParams)	Stops a trigger.
beginStopAndWait(string, string, string, TriggersStopOptionalParams)	Stops a trigger.
beginSubscribeToEvents(string, string, string, TriggersSubscribeToEventsOptionalParams)	Subscribe event trigger to events.
beginSubscribeToEventsAndWait(string, string, string, TriggersSubscribeToEventsOptionalParams)	Subscribe event trigger to events.
beginUnsubscribeFromEvents(string, string, string, TriggersUnsubscribeFromEventsOptionalParams)	Unsubscribe event trigger from events.
beginUnsubscribeFromEventsAndWait(string, string, string, TriggersUnsubscribeFromEventsOptionalParams)	Unsubscribe event trigger from events.
createOrUpdate(string, string, string, TriggerResource, TriggersCreateOrUpdateOptionalParams)	Creates or updates a trigger.
delete(string, string, string, TriggersDeleteOptionalParams)	Deletes a trigger.
get(string, string, string, TriggersGetOptionalParams)	Gets a trigger.
getEventSubscriptionStatus(string, string, string, TriggersGetEventSubscriptionStatusOptionalParams)	Get a trigger's event subscription status.
listByFactory(string, string, TriggersListByFactoryOptionalParams)	Lists triggers.
queryByFactory(string, string, TriggerFilterParameters, TriggersQueryByFactoryOptionalParams)	Query triggers.

Method Details

beginStart(string, string, string, TriggersStartOptionalParams)

Starts a trigger.

function beginStart(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, string, TriggersStartOptionalParams)

Starts a trigger.

function beginStartAndWait(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, string, TriggersStopOptionalParams)

Stops a trigger.

function beginStop(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersStopOptionalParams

The options parameters.

Returns

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

beginStopAndWait(string, string, string, TriggersStopOptionalParams)

Stops a trigger.

function beginStopAndWait(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersStopOptionalParams

The options parameters.

Returns

Promise<void>

beginSubscribeToEvents(string, string, string, TriggersSubscribeToEventsOptionalParams)

Subscribe event trigger to events.

function beginSubscribeToEvents(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersSubscribeToEventsOptionalParams): Promise<SimplePollerLike<OperationState<TriggerSubscriptionOperationStatus>, TriggerSubscriptionOperationStatus>>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersSubscribeToEventsOptionalParams

The options parameters.

Returns

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

beginSubscribeToEventsAndWait(string, string, string, TriggersSubscribeToEventsOptionalParams)

Subscribe event trigger to events.

function beginSubscribeToEventsAndWait(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersSubscribeToEventsOptionalParams): Promise<TriggerSubscriptionOperationStatus>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersSubscribeToEventsOptionalParams

The options parameters.

Returns

Promise<TriggerSubscriptionOperationStatus>

beginUnsubscribeFromEvents(string, string, string, TriggersUnsubscribeFromEventsOptionalParams)

Unsubscribe event trigger from events.

function beginUnsubscribeFromEvents(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersUnsubscribeFromEventsOptionalParams): Promise<SimplePollerLike<OperationState<TriggerSubscriptionOperationStatus>, TriggerSubscriptionOperationStatus>>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersUnsubscribeFromEventsOptionalParams

The options parameters.

Returns

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

beginUnsubscribeFromEventsAndWait(string, string, string, TriggersUnsubscribeFromEventsOptionalParams)

Unsubscribe event trigger from events.

function beginUnsubscribeFromEventsAndWait(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersUnsubscribeFromEventsOptionalParams): Promise<TriggerSubscriptionOperationStatus>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersUnsubscribeFromEventsOptionalParams

The options parameters.

Returns

Promise<TriggerSubscriptionOperationStatus>

createOrUpdate(string, string, string, TriggerResource, TriggersCreateOrUpdateOptionalParams)

Creates or updates a trigger.

function createOrUpdate(resourceGroupName: string, factoryName: string, triggerName: string, trigger: TriggerResource, options?: TriggersCreateOrUpdateOptionalParams): Promise<TriggerResource>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

trigger

TriggerResource

Trigger resource definition.

options

TriggersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TriggerResource>

delete(string, string, string, TriggersDeleteOptionalParams)

Deletes a trigger.

function delete(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, TriggersGetOptionalParams)

Gets a trigger.

function get(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersGetOptionalParams): Promise<TriggerResource>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersGetOptionalParams

The options parameters.

Returns

Promise<TriggerResource>

getEventSubscriptionStatus(string, string, string, TriggersGetEventSubscriptionStatusOptionalParams)

Get a trigger's event subscription status.

function getEventSubscriptionStatus(resourceGroupName: string, factoryName: string, triggerName: string, options?: TriggersGetEventSubscriptionStatusOptionalParams): Promise<TriggerSubscriptionOperationStatus>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

triggerName

string

The trigger name.

options

TriggersGetEventSubscriptionStatusOptionalParams

The options parameters.

Returns

Promise<TriggerSubscriptionOperationStatus>

listByFactory(string, string, TriggersListByFactoryOptionalParams)

Lists triggers.

function listByFactory(resourceGroupName: string, factoryName: string, options?: TriggersListByFactoryOptionalParams): PagedAsyncIterableIterator<TriggerResource, TriggerResource[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

options

TriggersListByFactoryOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TriggerResource, TriggerResource[], PageSettings>

queryByFactory(string, string, TriggerFilterParameters, TriggersQueryByFactoryOptionalParams)

Query triggers.

function queryByFactory(resourceGroupName: string, factoryName: string, filterParameters: TriggerFilterParameters, options?: TriggersQueryByFactoryOptionalParams): Promise<TriggerQueryResponse>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

filterParameters

TriggerFilterParameters

Parameters to filter the triggers.

options

TriggersQueryByFactoryOptionalParams

The options parameters.

Returns

Promise<TriggerQueryResponse>