workflow_triggers
Creates, updates, deletes, gets or lists a workflow_triggers resource.
Overview
| Name | workflow_triggers |
| Type | Resource |
| Id | azure.logic.workflow_triggers |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | The resource id. |
name | string | Gets the workflow trigger name. |
changedTime | string (date-time) | Gets the changed time. |
createdTime | string (date-time) | Gets the created time. |
lastExecutionTime | string (date-time) | Gets the last execution time. |
nextExecutionTime | string (date-time) | Gets the next execution time. |
provisioningState | string | Gets the provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", and "Completed". |
recurrence | object | Gets the workflow trigger recurrence. |
state | string | Gets the state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended". |
status | string | Gets the status. Known values are: "NotSpecified", "Paused", "Running", "Waiting", "Succeeded", "Skipped", "Suspended", "Cancelled", "Failed", "Faulted", "TimedOut", "Aborted", and "Ignored". |
type | string | Gets the workflow trigger type. |
workflow | object | The resource reference. Variables are only populated by the server, and will be ignored when sending a request. |
| Name | Datatype | Description |
|---|---|---|
id | string | The resource id. |
name | string | Gets the workflow trigger name. |
changedTime | string (date-time) | Gets the changed time. |
createdTime | string (date-time) | Gets the created time. |
lastExecutionTime | string (date-time) | Gets the last execution time. |
nextExecutionTime | string (date-time) | Gets the next execution time. |
provisioningState | string | Gets the provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", and "Completed". |
recurrence | object | Gets the workflow trigger recurrence. |
state | string | Gets the state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended". |
status | string | Gets the status. Known values are: "NotSpecified", "Paused", "Running", "Waiting", "Succeeded", "Skipped", "Suspended", "Cancelled", "Failed", "Faulted", "TimedOut", "Aborted", and "Ignored". |
type | string | Gets the workflow trigger type. |
workflow | object | The resource reference. Variables are only populated by the server, and will be ignored when sending a request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resource_group_name, workflow_name, trigger_name, subscription_id | Gets a workflow trigger. | |
list | select | resource_group_name, workflow_name, subscription_id | $top, $filter | Gets a list of workflow triggers. |
list_callback_url | exec | resource_group_name, workflow_name, trigger_name, subscription_id | Get the callback URL for a workflow trigger. | |
get_schema_json | exec | resource_group_name, workflow_name, trigger_name, subscription_id | Get the trigger schema as JSON. | |
reset | exec | resource_group_name, workflow_name, trigger_name, subscription_id | Resets a workflow trigger. | |
run | exec | resource_group_name, workflow_name, trigger_name, subscription_id | Runs a workflow trigger. | |
set_state | exec | resource_group_name, workflow_name, trigger_name, subscription_id, source | Sets the state of a workflow trigger. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resource_group_name | string | The resource group name. Required. |
subscription_id | string | |
trigger_name | string | The workflow trigger name. Required. |
workflow_name | string | The workflow name. Required. |
$filter | string | The filter to apply on the operation. Default value is None. |
$top | integer | The number of items to be included in the result. Default value is None. |
SELECT examples
- get
- list
Gets a workflow trigger.
SELECT
id,
name,
changedTime,
createdTime,
lastExecutionTime,
nextExecutionTime,
provisioningState,
recurrence,
state,
status,
type,
workflow
FROM azure.logic.workflow_triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets a list of workflow triggers.
SELECT
id,
name,
changedTime,
createdTime,
lastExecutionTime,
nextExecutionTime,
provisioningState,
recurrence,
state,
status,
type,
workflow
FROM azure.logic.workflow_triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;
Lifecycle Methods
- list_callback_url
- get_schema_json
- reset
- run
- set_state
Get the callback URL for a workflow trigger.
EXEC azure.logic.workflow_triggers.list_callback_url
@resource_group_name='{{ resource_group_name }}' --required,
@workflow_name='{{ workflow_name }}' --required,
@trigger_name='{{ trigger_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;
Get the trigger schema as JSON.
EXEC azure.logic.workflow_triggers.get_schema_json
@resource_group_name='{{ resource_group_name }}' --required,
@workflow_name='{{ workflow_name }}' --required,
@trigger_name='{{ trigger_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;
Resets a workflow trigger.
EXEC azure.logic.workflow_triggers.reset
@resource_group_name='{{ resource_group_name }}' --required,
@workflow_name='{{ workflow_name }}' --required,
@trigger_name='{{ trigger_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;
Runs a workflow trigger.
EXEC azure.logic.workflow_triggers.run
@resource_group_name='{{ resource_group_name }}' --required,
@workflow_name='{{ workflow_name }}' --required,
@trigger_name='{{ trigger_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;
Sets the state of a workflow trigger.
EXEC azure.logic.workflow_triggers.set_state
@resource_group_name='{{ resource_group_name }}' --required,
@workflow_name='{{ workflow_name }}' --required,
@trigger_name='{{ trigger_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"source": "{{ source }}"
}'
;