Trigger - Get Event Subscription Status

トリガーのイベント サブスクリプションの状態を取得します。

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

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

uri

ワークスペース開発エンドポイント (例: https://myworkspace.dev.azuresynapse.net )。

triggerName
path True

string

トリガー名。

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

api-version
query True

string

Synapse クライアント API バージョン。

応答

名前 説明
200 OK

TriggerSubscriptionOperationStatus

イベント サブスクリプションの状態をトリガーします。

Other Status Codes

CloudError

Azure Synapse サービスから受信したエラー応答。

Triggers_GetEventSubscriptionStatus

Sample Request

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

Sample Response

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

定義

名前 説明
CloudError

Azure Synapseエラー応答の構造を定義する オブジェクト。

EventSubscriptionStatus

イベント サブスクリプションの状態。

TriggerSubscriptionOperationStatus

トリガー サブスクリプション操作の応答を定義します。

CloudError

Azure Synapseエラー応答の構造を定義する オブジェクト。

名前 説明
error.code

string

エラー コード。

error.details

CloudError[]

追加のエラーの詳細を含む配列。

error.message

string

エラー メッセージ。

error.target

string

エラーに関連付けられている要求のプロパティ名/パス。

EventSubscriptionStatus

イベント サブスクリプションの状態。

名前 説明
Deprovisioning

string

Disabled

string

Enabled

string

Provisioning

string

Unknown

string

TriggerSubscriptionOperationStatus

トリガー サブスクリプション操作の応答を定義します。

名前 説明
status

EventSubscriptionStatus

イベント サブスクリプションの状態。

triggerName

string

トリガー名。