Share via


Workflow Triggers - Get

Gets a workflow trigger.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}?api-version=2019-05-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.

Responses

Name Type Description
200 OK

WorkflowTrigger

OK

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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

Get a workflow trigger

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/triggers/manual?api-version=2019-05-01

Sample response

{
  "properties": {
    "provisioningState": "Succeeded",
    "createdTime": "2018-08-10T17:32:30.2496336Z",
    "changedTime": "2018-08-10T18:47:49.5288666Z",
    "state": "Enabled",
    "workflow": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/versions/08586676800160476478",
      "name": "08586676800160476478",
      "type": "Microsoft.Logic/workflows/versions"
    }
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/triggers/manual",
  "name": "manual",
  "type": "Microsoft.Logic/workflows/triggers"
}

Definitions

Name Description
DayOfWeek

The day of the week.

DaysOfWeek

The days of the week.

ErrorProperties

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

ErrorResponse

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

RecurrenceFrequency

The recurrence frequency.

RecurrenceSchedule

The recurrence schedule.

RecurrenceScheduleOccurrence

The recurrence schedule occurrence.

ResourceReference

The resource reference.

WorkflowState

The workflow state.

WorkflowStatus

The workflow status.

WorkflowTrigger

The workflow trigger.

WorkflowTriggerProvisioningState

The workflow trigger provisioning state.

WorkflowTriggerRecurrence

The workflow trigger recurrence.

DayOfWeek

The day of the week.

Value Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DaysOfWeek

The days of the week.

Value Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

ErrorProperties

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code

string

Error code.

message

string

Error message indicating why the operation failed.

ErrorResponse

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Name Type Description
error

ErrorProperties

The error properties.

RecurrenceFrequency

The recurrence frequency.

Value Description
NotSpecified
Second
Minute
Hour
Day
Week
Month
Year

RecurrenceSchedule

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

The recurrence schedule occurrence.

Name Type Description
day

DayOfWeek

The day of the week.

occurrence

integer (int32)

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.

WorkflowState

The workflow state.

Value Description
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended

WorkflowStatus

The workflow status.

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

WorkflowTrigger

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

The workflow trigger provisioning state.

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

WorkflowTriggerRecurrence

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.