Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Triggers

Package version

Class representing a Triggers.

Hierarchy

  • Triggers

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(deviceName: string, name: string, trigger: Models.TriggerUnion, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates or updates a trigger.

    Parameters

    • deviceName: string

      Creates or updates a trigger

    • name: string

      The trigger name.

    • trigger: Models.TriggerUnion

      The trigger.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes the trigger on the gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The trigger name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(deviceName: string, name: string, trigger: Models.TriggerUnion, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.TriggersCreateOrUpdateResponse>

  • Creates or updates a trigger.

    Parameters

    • deviceName: string

      Creates or updates a trigger

    • name: string

      The trigger name.

    • trigger: Models.TriggerUnion

      The trigger.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TriggersCreateOrUpdateResponse>

    Promise<Models.TriggersCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes the trigger on the gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The trigger name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.TriggersGetResponse>
  • get(deviceName: string, name: string, resourceGroupName: string, callback: msRest.ServiceCallback<Models.TriggerUnion>): void
  • get(deviceName: string, name: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.TriggerUnion>): void

  • Get a specific trigger by name.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The trigger name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TriggersGetResponse>

    Promise<Models.TriggersGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The trigger name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<Models.TriggerUnion>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The trigger name.

    • resourceGroupName: string

      The resource group name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Models.TriggerUnion>

      The callback

    Returns void

listByDataBoxEdgeDevice

  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: Models.TriggersListByDataBoxEdgeDeviceOptionalParams): Promise<Models.TriggersListByDataBoxEdgeDeviceResponse>
  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, callback: msRest.ServiceCallback<TriggerList>): void
  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options: TriggersListByDataBoxEdgeDeviceOptionalParams, callback: msRest.ServiceCallback<TriggerList>): void

  • Lists all the triggers configured in the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: Models.TriggersListByDataBoxEdgeDeviceOptionalParams

    Returns Promise<Models.TriggersListByDataBoxEdgeDeviceResponse>

    Promise<Models.TriggersListByDataBoxEdgeDeviceResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<TriggerList>

      The callback

    Returns void

  • Parameters

    Returns void

listByDataBoxEdgeDeviceNext

  • listByDataBoxEdgeDeviceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.TriggersListByDataBoxEdgeDeviceNextResponse>
  • listByDataBoxEdgeDeviceNext(nextPageLink: string, callback: msRest.ServiceCallback<TriggerList>): void
  • listByDataBoxEdgeDeviceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TriggerList>): void

  • Lists all the triggers configured in the device.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TriggersListByDataBoxEdgeDeviceNextResponse>

    Promise<Models.TriggersListByDataBoxEdgeDeviceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<TriggerList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TriggerList>

      The callback

    Returns void

Generated using TypeDoc