Set-AzSynapseLinkConnection
ワークスペース内のリンク接続を作成または更新します。
構文
Set-AzSynapseLinkConnection
-WorkspaceName <String>
-Name <String>
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzSynapseLinkConnection
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-AzSynapseLinkConnection コマンドレットは、ワークスペース内のリンク接続を作成または更新します。
例
例 1
<#
linkconnection.json
{
"name":"sampleLinkConnection", // please change to your link connection name
"properties":{
"sourceDatabase":{
"typeProperties":{ // please change to your source database resourceId and principalId
"resourceId":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/sampleResourceGroup/providers/Microsoft.Sql/servers/sampleServer",
"principalId":"xxxxxxxxxx"
},
"linkedService":{
"referenceName":"sampleLinkServiceReference", // please change to your source database link service name
"type":"LinkedServiceReference"
}
},
"targetDatabase":{
"linkedService":{
"referenceName":"sampleLinkServiceReference", // please change to your target database link service name
"type":"LinkedServiceReference",
"parameters":{
"DBName":"v2"
}
}
},
"compute":{
"coreCount":16,
"computeType":"General"
}
}
}
#>
Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\linkconnection.json"このコマンドは、ContosoWorkspace という名前のワークスペース内の定義ファイルlinkconnection.jsonからリンク接続を作成または更新します。
例 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\samples\linkconnection.json"このコマンドは、パイプラインを介して ContosoWorkspace という名前のワークスペース内linkconnection.json定義ファイルからリンク接続を作成または更新します。
パラメーター
-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
Azure Sql Database の Synapse リンク接続名。
| 型: | String |
| Aliases: | LinkConnectionName |
| 配置: | 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 |