Stop-AzSynapseTrigger

モジュール:

Az.Synapse

ワークスペース内のトリガーを停止します。

構文

Stop-AzSynapseTrigger
    -WorkspaceName <String>
    -Name <String>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzSynapseTrigger
    -WorkspaceObject <PSSynapseWorkspace>
    -Name <String>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzSynapseTrigger
    -InputObject <PSTriggerResource>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Stop-AzSynapseTrigger コマンドレットは、ワークスペース内のトリガーを停止します。 トリガーが "開始" 状態の場合、コマンドレットはトリガーを停止し、パイプラインを呼び出さなくなります。 トリガーが既に 'Stopped' 状態の場合、このコマンドレットは無効です。

例

例 1

Stop-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger

ワークスペース ContosoWorkspace で ContosoTrigger というトリガーを停止します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Stop-AzSynapseTrigger -Name ContosoTrigger

パイプラインを介して、ワークスペース ContosoWorkspace 内の ContosoTrigger というトリガーを停止します。

例 3

$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger
$trigger | Stop-AzSynapseTrigger

パイプラインを使用して、ワークスペース ContosoWorkspace で ContosoTrigger というトリガーを停止します。

パラメーター

-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

-InputObject

トリガー オブジェクト。

型:	PSTriggerResource
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

トリガー名。

型:	String
Aliases:	TriggerName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PassThru

このコマンドレットは、既定ではオブジェクトを返しません。 このスイッチを指定すると、成功した場合は true が返されます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	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

入力

PSSynapseWorkspace

PSTriggerResource

出力

Boolean