Stop-AzSynapseLinkConnection
リンク接続を停止します。
構文
Stop-AzSynapseLinkConnection
-WorkspaceName <String>
-Name <String>
[-PassThru]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzSynapseLinkConnection
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
[-PassThru]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzSynapseLinkConnection
-InputObject <PSLinkConnectionResource>
[-PassThru]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Stop-AzSynapseLinkConnection コマンドレットは、ワークスペース内のリンク接続を停止します。 このコマンドレットを呼び出した後は、 Get-AzSynapseLinkConnectionDetailedStatus を呼び出すことで詳細な状態を確認できます。
例
例 1
Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnectionこのコマンドは、ワークスペース内の ContosoLinkConnection という名前のリンク接続を停止します。
例 2
$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace
$ws | Stop-AzSynapseLinkConnection -Name ContosoLinkConnectionこのコマンドは、パイプライン経由でワークスペース内の ContosoLinkConnection という名前のリンク接続を停止します。
例 3
$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection
$linkConnection | Stop-AzSynapseLinkConnectionこのコマンドは、パイプライン経由でワークスペース内の ContosoLinkConnection という名前のリンク接続を停止します。
例 4
Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
WorkspaceName : ContosoWorkspace
Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Name : ContosoLinkConnection
IsApplyingChanges :
IsPartiallyFailed : False
StartTime : 2022-03-10T06:59:34.5820499Z
StopTime : 2022-03-10T07:21:42.4895248Z
Status : Stopping
ContinuousRunId :
Error :このコマンドは、ワークスペースで ContosoLinkConnection という名前のリンク接続を停止し、 Get-AzSynapseLinkConnectionDetailedStatus を呼び出してリンク接続の状態を取得できます。
パラメーター
-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
Azure Sql Database の Synapse リンク接続オブジェクト。
| 型: | PSLinkConnectionResource |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
Azure Sql Database の Synapse リンク接続名。
| 型: | String |
| Aliases: | LinkConnectionName |
| 配置: | 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 |