Trigger - Get Triggers By Workspace
Lists triggers.
GET {endpoint}/triggers?api-version=2020-12-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
The workspace development endpoint, for example |
api-version
|
query | True |
string |
The Synapse client API Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Synapse service. |
Examples
Triggers_ListByWorkspace
Sample Request
GET exampleWorkspace.dev.azuresynapse.net/triggers?api-version=2020-12-01
Sample Response
Date: Sat, 16 Jun 2018 00:40:20 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14986
x-ms-request-id: e474f8f8-b34f-4536-b059-ca740e6b44c3
x-ms-correlation-request-id: e474f8f8-b34f-4536-b059-ca740e6b44c3
{
"value": [
{
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger",
"name": "exampleTrigger",
"type": "Microsoft.Synapse/workspaces/triggers",
"properties": {
"type": "ScheduleTrigger",
"typeProperties": {
"recurrence": {
"frequency": "Minute",
"interval": 4,
"startTime": "2018-06-16T00:39:14.905167Z",
"endTime": "2018-06-16T00:55:14.905167Z",
"timeZone": "UTC"
}
},
"pipelines": [
{
"pipelineReference": {
"referenceName": "examplePipeline",
"type": "PipelineReference"
},
"parameters": {
"OutputBlobNameList": [
"exampleoutput.csv"
]
}
}
],
"description": "Example description",
"runtimeState": "Started"
},
"etag": "0a008ed4-0000-0000-0000-5b245c740000"
}
]
}
Definitions
Name | Description |
---|---|
Cloud |
The object that defines the structure of an Azure Synapse error response. |
Multiple |
Base class for all triggers that support one to many model for trigger to pipeline. |
Pipeline |
Pipeline reference type. |
Pipeline |
Pipeline reference type. |
Trigger |
A list of trigger resources. |
Trigger |
Pipeline that needs to be triggered with the given parameters. |
Trigger |
Trigger resource type. |
Trigger |
Enumerates possible state of Triggers. |
CloudError
The object that defines the structure of an Azure Synapse error response.
Name | Type | Description |
---|---|---|
error.code |
string |
Error code. |
error.details |
Array with additional error details. |
|
error.message |
string |
Error message. |
error.target |
string |
Property name/path in request associated with error. |
MultiplePipelineTrigger
Base class for all triggers that support one to many model for trigger to pipeline.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the trigger. |
description |
string |
Trigger description. |
pipelines |
Pipelines that need to be started. |
|
runtimeState |
Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. |
|
type | string: |
Trigger type. |
PipelineReference
Pipeline reference type.
Name | Type | Description |
---|---|---|
name |
string |
Reference name. |
referenceName |
string |
Reference pipeline name. |
type |
Pipeline reference type. |
PipelineReferenceType
Pipeline reference type.
Name | Type | Description |
---|---|---|
PipelineReference |
string |
TriggerListResponse
A list of trigger resources.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link to the next page of results, if any remaining results exist. |
value |
List of triggers. |
TriggerPipelineReference
Pipeline that needs to be triggered with the given parameters.
Name | Type | Description |
---|---|---|
parameters |
object |
Pipeline parameters. |
pipelineReference |
Pipeline reference. |
TriggerResource
Trigger resource type.
Name | Type | Description |
---|---|---|
etag |
string |
Resource Etag. |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties | Trigger: |
Properties of the trigger. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
TriggerRuntimeState
Enumerates possible state of Triggers.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Started |
string |
|
Stopped |
string |