Trigger - Unsubscribe Trigger From Events

Service:

Synapse

API Version:

2020-12-01

Unsubscribe event trigger from events.

POST {endpoint}/triggers/{triggerName}/unsubscribeFromEvents?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 minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$	The trigger name.
api-version	query	True	string	The Synapse client API Version.

Responses

Name	Type	Description
200 OK	TriggerSubscriptionOperationStatus	Trigger is unsubscribed from events.
202 Accepted		Accepted.
Other Status Codes	CloudError	An error response received from the Azure Synapse service.

Examples

Triggers_UnsubscribeFromEvents

Sample request

HTTP

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

Sample response

Status code:

202

Location: https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview

Status code:

200

{
  "triggerName": "exampleTrigger",
  "status": "Disabled"
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Synapse error response.
EventSubscriptionStatus	Event Subscription Status.
TriggerSubscriptionOperationStatus	Defines the response of a trigger subscription operation.

CloudError

Object

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.

EventSubscriptionStatus

Enumeration

Event Subscription Status.

Value	Description
Enabled
Provisioning
Deprovisioning
Disabled
Unknown

TriggerSubscriptionOperationStatus

Object

Defines the response of a trigger subscription operation.

Name	Type	Description
status	EventSubscriptionStatus	Event Subscription Status.
triggerName	string	Trigger name.