Triggers interface

Interface representing a Triggers.

Methods

beginCreateOrUpdate(string, string, string, TriggerUnion, TriggersCreateOrUpdateOptionalParams)

Creates or updates a trigger.

beginCreateOrUpdateAndWait(string, string, string, TriggerUnion, TriggersCreateOrUpdateOptionalParams)

Creates or updates a trigger.

beginDelete(string, string, string, TriggersDeleteOptionalParams)

Deletes the trigger on the gateway device.

beginDeleteAndWait(string, string, string, TriggersDeleteOptionalParams)

Deletes the trigger on the gateway device.

get(string, string, string, TriggersGetOptionalParams)

Get a specific trigger by name.

listByDataBoxEdgeDevice(string, string, TriggersListByDataBoxEdgeDeviceOptionalParams)

Lists all the triggers configured in the device.

Method Details

beginCreateOrUpdate(string, string, string, TriggerUnion, TriggersCreateOrUpdateOptionalParams)

Creates or updates a trigger.

function beginCreateOrUpdate(deviceName: string, name: string, resourceGroupName: string, trigger: TriggerUnion, options?: TriggersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<TriggerUnion>, TriggerUnion>>

Parameters

deviceName

string

Creates or updates a trigger

name

string

The trigger name.

resourceGroupName

string

The resource group name.

trigger
TriggerUnion

The trigger.

options
TriggersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<TriggerUnion>, TriggerUnion>>

beginCreateOrUpdateAndWait(string, string, string, TriggerUnion, TriggersCreateOrUpdateOptionalParams)

Creates or updates a trigger.

function beginCreateOrUpdateAndWait(deviceName: string, name: string, resourceGroupName: string, trigger: TriggerUnion, options?: TriggersCreateOrUpdateOptionalParams): Promise<TriggerUnion>

Parameters

deviceName

string

Creates or updates a trigger

name

string

The trigger name.

resourceGroupName

string

The resource group name.

trigger
TriggerUnion

The trigger.

options
TriggersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TriggerUnion>

beginDelete(string, string, string, TriggersDeleteOptionalParams)

Deletes the trigger on the gateway device.

function beginDelete(deviceName: string, name: string, resourceGroupName: string, options?: TriggersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

name

string

The trigger name.

resourceGroupName

string

The resource group name.

options
TriggersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, TriggersDeleteOptionalParams)

Deletes the trigger on the gateway device.

function beginDeleteAndWait(deviceName: string, name: string, resourceGroupName: string, options?: TriggersDeleteOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

name

string

The trigger name.

resourceGroupName

string

The resource group name.

options
TriggersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, TriggersGetOptionalParams)

Get a specific trigger by name.

function get(deviceName: string, name: string, resourceGroupName: string, options?: TriggersGetOptionalParams): Promise<TriggerUnion>

Parameters

deviceName

string

The device name.

name

string

The trigger name.

resourceGroupName

string

The resource group name.

options
TriggersGetOptionalParams

The options parameters.

Returns

Promise<TriggerUnion>

listByDataBoxEdgeDevice(string, string, TriggersListByDataBoxEdgeDeviceOptionalParams)

Lists all the triggers configured in the device.

function listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: TriggersListByDataBoxEdgeDeviceOptionalParams): PagedAsyncIterableIterator<TriggerUnion, TriggerUnion[], PageSettings>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
TriggersListByDataBoxEdgeDeviceOptionalParams

The options parameters.

Returns