Start-AzSynapseLinkConnection

リファレンス

モジュール:: Az.Synapse

リンク接続を開始します。

構文

Start-AzSynapseLinkConnection
     -WorkspaceName <String>
     -Name <String>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

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

Start-AzSynapseLinkConnection
     -InputObject <PSLinkConnectionResource>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

Start-AzSynapseLinkConnection コマンドレットは、ワークスペースでリンク接続を開始します。このコマンドレットを呼び出した後、Get-AzSynapseLinkConnectionDetailedStatus呼び出すことで詳細な状態を確認できます。

例

例 1

Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

このコマンドは、ワークスペースで ContosoLinkConnection という名前のリンク接続を開始します。

例 2

$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace
$ws | Start-AzSynapseLinkConnection -Name ContosoLinkConnection

このコマンドは、パイプラインを介してワークスペースで ContosoLinkConnection という名前のリンク接続を開始します。

例 3

$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection
$linkConnection | Start-AzSynapseLinkConnection

このコマンドは、パイプラインを介してワークスペースで ContosoLinkConnection という名前のリンク接続を開始します。

例 4

Start-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-10T07:57:37.8730044Z
StopTime          :
Status            : Starting
ContinuousRunId   : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Error             :

Start-AzSynapseLinkConnection コマンドは、ワークスペースで 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

入力

PSSynapseWorkspace

PSLinkConnectionResource

出力

Boolean

次の方法で共有