次の方法で共有

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

バックグラウンドでコマンドレットを実行する

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Azure Sql Database の Synapse リンク接続オブジェクト。

Type:PSLinkConnectionResource
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Azure Sql Database の Synapse リンク接続名。

Type:String
Aliases:LinkConnectionName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Synapse ワークスペースの名前。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

PSSynapseWorkspace

PSLinkConnectionResource

出力

Boolean