Trigger - Get Event Subscription Status

Service:

Synapse

API Version:

2020-12-01

Get a trigger's event subscription status.

POST {endpoint}/triggers/{triggerName}/getEventSubscriptionStatus?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	TriggerSubscriptionOperationStatus	Trigger event subscription state.
Other Status Codes	CloudError	An error response received from the Azure Synapse service.

Examples

Triggers_GetEventSubscriptionStatus

Sample Request

HTTP

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

Sample Response

Status code:

200

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

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

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

Event Subscription Status.

Name	Type	Description
Deprovisioning	string
Disabled	string
Enabled	string
Provisioning	string
Unknown	string

TriggerSubscriptionOperationStatus

Defines the response of a trigger subscription operation.

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