Set-AzSynapseTrigger
ワークスペースにトリガーを作成します。
構文
Set-AzSynapseTrigger
-WorkspaceName <String>
-Name <String>
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseTrigger
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzSynapseTrigger コマンドレットは、ワークスペースにトリガーを作成します。 トリガーは "停止" 状態で作成されます。つまり、トリガーが参照するパイプラインの呼び出しをすぐに開始することはありません。
例
例 1
Set-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger -DefinitionFile ".\scheduledTrigger.json"
ワークスペース ContosoWorkspace に ContosoTrigger という新しいトリガーを作成します。 トリガーは "停止済み" 状態で作成されます。つまり、すぐには開始されません。 トリガーは、 Start-AzDataFactoryV2Trigger
コマンドレットを使用して開始できます。
例 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Set-AzSynapseTrigger -Name ContosoTrigger -DefinitionFile ".\scheduledTrigger.json"
パイプラインを使用して、ワークスペース ContosoWorkspace に ContosoTrigger という新しいトリガーを作成します。 トリガーは "停止済み" 状態で作成されます。つまり、すぐには開始されません。 トリガーは、 Start-AzDataFactoryV2Trigger
コマンドレットを使用して開始できます。
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefinitionFile
JSON ファイルのパス。
型: | String |
Aliases: | File |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
トリガー名
型: | String |
Aliases: | TriggerName |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WorkspaceName
Synapse ワークスペースの名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WorkspaceObject
ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。
型: | PSSynapseWorkspace |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |