WorkflowTriggers interface
Interface representing a WorkflowTriggers.
Methods
get(string, string, string, Workflow |
Gets a workflow trigger. |
get |
Get the trigger schema as JSON. |
list(string, string, Workflow |
Gets a list of workflow triggers. |
list |
Get the callback URL for a workflow trigger. |
reset(string, string, string, Workflow |
Resets a workflow trigger. |
run(string, string, string, Workflow |
Runs a workflow trigger. |
set |
Sets the state of a workflow trigger. |
Method Details
get(string, string, string, WorkflowTriggersGetOptionalParams)
Gets a workflow trigger.
function get(resourceGroupName: string, workflowName: string, triggerName: string, options?: WorkflowTriggersGetOptionalParams): Promise<WorkflowTrigger>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- triggerName
-
string
The workflow trigger name.
The options parameters.
Returns
Promise<WorkflowTrigger>
getSchemaJson(string, string, string, WorkflowTriggersGetSchemaJsonOptionalParams)
Get the trigger schema as JSON.
function getSchemaJson(resourceGroupName: string, workflowName: string, triggerName: string, options?: WorkflowTriggersGetSchemaJsonOptionalParams): Promise<JsonSchema>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- triggerName
-
string
The workflow trigger name.
The options parameters.
Returns
Promise<JsonSchema>
list(string, string, WorkflowTriggersListOptionalParams)
Gets a list of workflow triggers.
function list(resourceGroupName: string, workflowName: string, options?: WorkflowTriggersListOptionalParams): PagedAsyncIterableIterator<WorkflowTrigger, WorkflowTrigger[], PageSettings>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
The options parameters.
Returns
listCallbackUrl(string, string, string, WorkflowTriggersListCallbackUrlOptionalParams)
Get the callback URL for a workflow trigger.
function listCallbackUrl(resourceGroupName: string, workflowName: string, triggerName: string, options?: WorkflowTriggersListCallbackUrlOptionalParams): Promise<WorkflowTriggerCallbackUrl>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- triggerName
-
string
The workflow trigger name.
The options parameters.
Returns
Promise<WorkflowTriggerCallbackUrl>
reset(string, string, string, WorkflowTriggersResetOptionalParams)
Resets a workflow trigger.
function reset(resourceGroupName: string, workflowName: string, triggerName: string, options?: WorkflowTriggersResetOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- triggerName
-
string
The workflow trigger name.
The options parameters.
Returns
Promise<void>
run(string, string, string, WorkflowTriggersRunOptionalParams)
Runs a workflow trigger.
function run(resourceGroupName: string, workflowName: string, triggerName: string, options?: WorkflowTriggersRunOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- triggerName
-
string
The workflow trigger name.
The options parameters.
Returns
Promise<void>
setState(string, string, string, SetTriggerStateActionDefinition, WorkflowTriggersSetStateOptionalParams)
Sets the state of a workflow trigger.
function setState(resourceGroupName: string, workflowName: string, triggerName: string, setState: SetTriggerStateActionDefinition, options?: WorkflowTriggersSetStateOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- triggerName
-
string
The workflow trigger name.
- setState
- SetTriggerStateActionDefinition
The workflow trigger state.
The options parameters.
Returns
Promise<void>