Share via


Triggers - Get Event Subscription Status

Get a trigger's event subscription status.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/getEventSubscriptionStatus?api-version=2018-06-01

URI Parameters

Name In Required Type Description
factoryName
path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

The factory name.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

The resource group name.

subscriptionId
path True

string

The subscription identifier.

triggerName
path True

string

minLength: 1
maxLength: 260
pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$

The trigger name.

api-version
query True

string

The API version.

Responses

Name Type Description
200 OK

TriggerSubscriptionOperationStatus

Trigger event subscription state.

Other Status Codes

CloudError

An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Triggers_GetEventSubscriptionStatus

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2018-06-01

Sample response

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

Definitions

Name Description
CloudError

The object that defines the structure of an Azure Data Factory 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 Data Factory 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.

Value Description
Enabled
Provisioning
Deprovisioning
Disabled
Unknown

TriggerSubscriptionOperationStatus

Defines the response of a trigger subscription operation.

Name Type Description
status

EventSubscriptionStatus

Event Subscription Status.

triggerName

string

Trigger name.