New-AzSynapseLinkedServiceEncryptedCredential

モジュール:

Az.Synapse

指定された統合ランタイムを使用して、リンクされたサービスの資格情報を暗号化します。

構文

New-AzSynapseLinkedServiceEncryptedCredential
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -IntegrationRuntimeName <String>
   -DefinitionFile <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzSynapseLinkedServiceEncryptedCredential
   -WorkspaceObject <PSSynapseWorkspace>
   -IntegrationRuntimeName <String>
   -DefinitionFile <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

New-AzSynapseLinkedServiceEncryptedCredential コマンドレットは、指定された統合ランタイムを使用して、リンクされたサービスの資格情報を暗号化します。

次の前提条件が満たされていることを確認してください。

• セルフホステッド統合ランタイムでリモート アクセス オプションが有効になっています。
• コマンドレットの実行には、PowerShell 7.0 以降が使用されます。

例

例 1

New-AzSynapseLinkedServiceEncryptedCredential -WorkspaceName ContosoWorkspace -ResourceGroupName ContosoRG -IntegrationRuntimeName "IR-LSEncryptedCredential" -DefinitionFile "D:\sqlLinkService.json" > "D:\SynapseEncryptedSQLServerLinkedService.json"

このコマンドは、IR-LSEncryptedCredential という名前の統合ランタイムで D:\SynapseEncryptedSQLServerLinkedService.jsファイル内の資格情報を暗号化します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseLinkedServiceEncryptedCredential -IntegrationRuntimeName "IR-LSEncryptedCredential" -DefinitionFile "D:\sqlLinkService.json" > "D:\SynapseEncryptedSQLServerLinkedService.json"

このコマンドは、パイプライン経由で IR-LSEncryptedCredential という名前の統合ランタイムで D:\SynapseEncryptedSQLServerLinkedService.jsファイル内の資格情報を暗号化します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-DefinitionFile

JSON ファイルのパス。

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

-Force

確認を求めないでください。

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

-IntegrationRuntimeName

統合ランタイム名。

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

-ResourceGroupName

リソース グループ名。

型:	String
配置:	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

出力

String