次の方法で共有

New-AzSynapseWorkspaceKey

  • リファレンス
モジュール:
Az.Synapse

ワークスペース キーを作成します。

構文

New-AzSynapseWorkspaceKey
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -Name <String>
   -EncryptionKeyIdentifier <String>
   [-Activate]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseWorkspaceKey
   -WorkspaceObject <PSSynapseWorkspace>
   -Name <String>
   -EncryptionKeyIdentifier <String>
   [-Activate]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

この New-AzSynapseWorkspaceKey コマンドレットは、ワークスペース キーを作成します。

例

例 1

New-AzSynapseWorkspaceKey -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoWorkspaceKey -EncryptionKeyIdentifier https://<key-vault-url>/keys/<key-name>

このコマンドは、ワークスペース ContosoWorkspace の下に ContosoWorkspaceKey という名前のワークスペース キーを作成します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseWorkspaceKey -Name ContosoWorkspaceKey -EncryptionKeyIdentifier https://<key-vault-url>/keys/<key-name>

このコマンドは、パイプラインを介してワークスペース ContosoWorkspace の下に ContosoWorkspaceKey という名前のワークスペース キーを作成します。

パラメーター

-Activate

カスタマー マネージド キーが指定された後にワークスペースをアクティブ化するかどうかを示します。

型: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

-EncryptionKeyIdentifier

キー識別子は、https://{keyvaultname}.vault.azure.net/keys/{keyname} の形式にする必要があります。

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

-Name

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

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

入力

出力