Stop and start Synapse pipeline triggers using pipeline

Kumar, Arun 336

Hello,

Is there a way to stop and start triggers using a Synapse Pipeline. I have tried with API mechanism like below

https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/{wfrd-syn-dev-rg}/providers/Microsoft.Synapse/triggers?api-version={api_version}

But its returning NULL values. The scope i used is https://management.azure.com/.default.

Wondering anyone tried and successful.

Thanks,
Arun

Vinodh247 23,346 Reputation points MVP

2024-09-12T14:15:15.4933333+00:00

You are getting NULL values because it seems like the API call might not be correctly configured or you might need additional permissions.

The scope https://management.azure.com/.default is correct for obtaining a token. However, ensure that the service principal or user has Contributor or Synapse Administrator permissions on the Synapse workspace, as managing triggers requires these permissions.

Make sure you're using the correct API version for Synapse triggers. The latest supported version at this time is 2021-06-01-preview
Kumar, Arun 336 Reputation points

2024-09-12T15:20:56.2333333+00:00

@Vinodh247 user have contrubuter access to execute the API. Is this the correct API url? - https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/{wfrd-syn-dev-rg}/providers/Microsoft.Synapse/triggers?api-version={api_version}
Vinodh247 23,346 Reputation points MVP

2024-09-13T05:52:59.2433333+00:00

Okay.. for managing individual triggers in Synapse, you need to include the workspace and trigger name in the URL.

Example:

Stop trigger:

POST https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Synapse/workspaces/{workspace_name}/triggers/{trigger_name}/stop?api-version=2020-12-01

Start Trigger:

POST https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Synapse/workspaces/{workspace_name}/triggers/{trigger_name}/start?api-version=2020-12-01
Smaran Thoomu 16,890 Reputation points Microsoft Vendor

2024-09-13T17:41:45.0966667+00:00

@Kumar, Arun Following up to see if the below answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

1 answer

Smaran Thoomu 16,890 Reputation points Microsoft Vendor

2024-09-12T19:38:33.85+00:00
Hi @Kumar, Arun

Thank you for using Microsoft Q&A platform and thanks for posting your question here.

Yes, you can stop and start Synapse pipeline triggers using a Synapse Pipeline. You can use the REST API to stop and start triggers. The API endpoint you are using is correct, but you need to provide the trigger name in the URL.

Here is an example of how to stop a trigger using the REST API:

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

To start a trigger, you can use the following API:

Make sure to replace the placeholders with the appropriate values for your Synapse workspace. Also, make sure that you have the appropriate permissions to stop and start triggers.

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

Make sure to replace the placeholders with the appropriate values for your Synapse workspace. Also, make sure that you have the appropriate permissions to stop and start triggers.

For more information, refer this article: Start Trigger & Stop Trigger

Similar thread: To stop all the triggers Via API

Hope this helps. Do let us know if you any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
Please sign in to rate this answer.
Smaran Thoomu 16,890 Reputation points Microsoft Vendor

2024-09-16T12:45:58.58+00:00

@Kumar, Arun Following up to see if the above answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Kumar, Arun 336 Reputation points

2024-09-16T19:13:59.17+00:00

@Smaran Thoomu - Still trying..did not got the output. I am checking the other link you posted. Will update

Smaran Thoomu 16,890 Reputation points Microsoft Vendor

2024-09-18T18:00:25.6433333+00:00

Kumar, Arun Following up to see if the above suggestion was helpful. And, if you have any further query do let us know.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Stop and start Synapse pipeline triggers using pipeline

1 answer

Your answer