WorkflowTriggers interface

Package:

@azure/arm-appservice

Interface representing a WorkflowTriggers.

Methods

beginRun(string, string, string, string, WorkflowTriggersRunOptionalParams)	Runs a workflow trigger.
beginRunAndWait(string, string, string, string, WorkflowTriggersRunOptionalParams)	Runs a workflow trigger.
get(string, string, string, string, WorkflowTriggersGetOptionalParams)	Gets a workflow trigger.
getSchemaJson(string, string, string, string, WorkflowTriggersGetSchemaJsonOptionalParams)	Get the trigger schema as JSON.
list(string, string, string, WorkflowTriggersListOptionalParams)	Gets a list of workflow triggers.
listCallbackUrl(string, string, string, string, WorkflowTriggersListCallbackUrlOptionalParams)	Get the callback URL for a workflow trigger.

Method Details

beginRun(string, string, string, string, WorkflowTriggersRunOptionalParams)

Runs a workflow trigger.

function beginRun(resourceGroupName: string, name: string, workflowName: string, triggerName: string, options?: WorkflowTriggersRunOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Site name.

workflowName

string

The workflow name.

triggerName

string

The workflow trigger name.

options

WorkflowTriggersRunOptionalParams

The options parameters.

Returns

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

beginRunAndWait(string, string, string, string, WorkflowTriggersRunOptionalParams)

Runs a workflow trigger.

function beginRunAndWait(resourceGroupName: string, name: string, workflowName: string, triggerName: string, options?: WorkflowTriggersRunOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Site name.

workflowName

string

The workflow name.

triggerName

string

The workflow trigger name.

options

WorkflowTriggersRunOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, WorkflowTriggersGetOptionalParams)

Gets a workflow trigger.

function get(resourceGroupName: string, name: string, workflowName: string, triggerName: string, options?: WorkflowTriggersGetOptionalParams): Promise<WorkflowTrigger>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Site name.

workflowName

string

The workflow name.

triggerName

string

The workflow trigger name.

options

WorkflowTriggersGetOptionalParams

The options parameters.

Returns

Promise<WorkflowTrigger>

getSchemaJson(string, string, string, string, WorkflowTriggersGetSchemaJsonOptionalParams)

Get the trigger schema as JSON.

function getSchemaJson(resourceGroupName: string, name: string, workflowName: string, triggerName: string, options?: WorkflowTriggersGetSchemaJsonOptionalParams): Promise<JsonSchema>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Site name.

workflowName

string

The workflow name.

triggerName

string

The workflow trigger name.

options

WorkflowTriggersGetSchemaJsonOptionalParams

The options parameters.

Returns

Promise<JsonSchema>

list(string, string, string, WorkflowTriggersListOptionalParams)

Gets a list of workflow triggers.

function list(resourceGroupName: string, name: string, workflowName: string, options?: WorkflowTriggersListOptionalParams): PagedAsyncIterableIterator<WorkflowTrigger, WorkflowTrigger[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Site name.

workflowName

string

The workflow name.

options

WorkflowTriggersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkflowTrigger, WorkflowTrigger[], PageSettings>

listCallbackUrl(string, string, string, string, WorkflowTriggersListCallbackUrlOptionalParams)

Get the callback URL for a workflow trigger.

function listCallbackUrl(resourceGroupName: string, name: string, workflowName: string, triggerName: string, options?: WorkflowTriggersListCallbackUrlOptionalParams): Promise<WorkflowTriggerCallbackUrl>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Site name.

workflowName

string

The workflow name.

triggerName

string

The workflow trigger name.

options

WorkflowTriggersListCallbackUrlOptionalParams

The options parameters.

Returns

Promise<WorkflowTriggerCallbackUrl>