Workflow Triggers - Set State

Reference

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

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DaysOfWeek

The days of the week.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

RecurrenceFrequency

Name	Type	Description
Day	string
Hour	string
Minute	string
Month	string
NotSpecified	string
Second	string
Week	string
Year	string

RecurrenceSchedule

The recurrence schedule.

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

RecurrenceScheduleOccurrence

The recurrence schedule occurrence.

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

ResourceReference

The resource reference.

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

SetTriggerStateActionDefinition

Name	Type	Description
source	WorkflowTrigger	The workflow trigger.

WorkflowState

Name	Type	Description
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string

WorkflowStatus

Name	Type	Description
Aborted	string
Cancelled	string
Failed	string
Faulted	string
Ignored	string
NotSpecified	string
Paused	string
Running	string
Skipped	string
Succeeded	string
Suspended	string
TimedOut	string
Waiting	string

WorkflowTrigger

The workflow trigger.

Name	Type	Description
id	string	The resource id.
name	string	Gets the workflow trigger name.
properties.changedTime	string	Gets the changed time.
properties.createdTime	string	Gets the created time.
properties.lastExecutionTime	string	Gets the last execution time.
properties.nextExecutionTime	string	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

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

WorkflowTriggerRecurrence

The workflow trigger recurrence.

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

Share via