Workflow Triggers - Set State

Service:

Logic Apps

API Version:

2016-06-01

Sets the state of a workflow trigger.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/setState?api-version=2016-06-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The resource group name.
subscriptionId	path	True	string	The subscription id.
triggerName	path	True	string	The workflow trigger name.
workflowName	path	True	string	The workflow name.
api-version	query	True	string	The API version.

Request Body

Name	Required	Type	Description
source	True	WorkflowTrigger	The workflow trigger.

Responses

Name	Type	Description
200 OK		OK

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Set trigger state

Sample request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflow/triggers/testTrigger/setState?api-version=2016-06-01

{
  "source": {}
}

Sample response

Status code:

200

Definitions

Name	Description
DayOfWeek
DaysOfWeek	The days of the week.
RecurrenceFrequency
RecurrenceSchedule	The recurrence schedule.
RecurrenceScheduleOccurrence	The recurrence schedule occurrence.
ResourceReference	The resource reference.
SetTriggerStateActionDefinition
WorkflowState
WorkflowStatus
WorkflowTrigger	The workflow trigger.
WorkflowTriggerProvisioningState
WorkflowTriggerRecurrence	The workflow trigger recurrence.

DayOfWeek

Enumeration

Value	Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DaysOfWeek

Enumeration

The days of the week.

Value	Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

RecurrenceFrequency

Enumeration

Value	Description
NotSpecified
Second
Minute
Hour
Day
Week
Month
Year

RecurrenceSchedule

Object

The recurrence schedule.

Name	Type	Description
hours	integer[] (int32)	The hours.
minutes	integer[] (int32)	The minutes.
monthDays	integer[] (int32)	The month days.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	The monthly occurrences.
weekDays	DaysOfWeek[]	The days of the week.

RecurrenceScheduleOccurrence

Object

The recurrence schedule occurrence.

Name	Type	Description
day	DayOfWeek	The day of the week.
occurrence	integer (int32)	The occurrence.

ResourceReference

Object

The resource reference.

Name	Type	Description
id	string	The resource id.
name	string	Gets the resource name.
type	string	Gets the resource type.

SetTriggerStateActionDefinition

Object

Name	Type	Description
source	WorkflowTrigger	The workflow trigger.

WorkflowState

Enumeration

Value	Description
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended

WorkflowStatus

Enumeration

Value	Description
NotSpecified
Paused
Running
Waiting
Succeeded
Skipped
Suspended
Cancelled
Failed
Faulted
TimedOut
Aborted
Ignored

WorkflowTrigger

Object

The workflow trigger.

Name	Type	Description
id	string	The resource id.
name	string	Gets the workflow trigger name.
properties.changedTime	string (date-time)	Gets the changed time.
properties.createdTime	string (date-time)	Gets the created time.
properties.lastExecutionTime	string (date-time)	Gets the last execution time.
properties.nextExecutionTime	string (date-time)	Gets the next execution time.
properties.provisioningState	WorkflowTriggerProvisioningState	Gets the provisioning state.
properties.recurrence	WorkflowTriggerRecurrence	Gets the workflow trigger recurrence.
properties.state	WorkflowState	Gets the state.
properties.status	WorkflowStatus	Gets the status.
properties.workflow	ResourceReference	Gets the reference to workflow.
type	string	Gets the workflow trigger type.

WorkflowTriggerProvisioningState

Enumeration

Value	Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Moving
Updating
Registering
Registered
Unregistering
Unregistered
Completed

WorkflowTriggerRecurrence

Object

The workflow trigger recurrence.

Name	Type	Description
endTime	string	The end time.
frequency	RecurrenceFrequency	The frequency.
interval	integer (int32)	The interval.
schedule	RecurrenceSchedule	The recurrence schedule.
startTime	string	The start time.
timeZone	string	The time zone.