Trigger - Start Trigger

Service:

Synapse

API Version:

2020-12-01

Starts a trigger.

POST {endpoint}/triggers/{triggerName}/start?api-version=2020-12-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
triggerName	path	True	string	The trigger name. Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
api-version	query	True	string	The Synapse client API Version.

Responses

Name	Type	Description
200 OK		Trigger has been started successfully.
Other Status Codes	CloudError	An error response received from the Azure Synapse service.

Examples

Triggers_Start

Sample Request

HTTP

POST exampleWorkspace.dev.azuresynapse.net/triggers/exampleTrigger/start?api-version=2020-12-01

Sample Response

Status code:

200

Definitions

CloudError

The object that defines the structure of an Azure Synapse error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.