Enable-AzSynapseWorkspace

リファレンス

モジュール:: Az.Synapse

Azure Synapse Analytics ワークスペースを作成する場合は、ワークスペースに二重暗号化を提供するカスタマーマネージドキーを使用して、ワークスペース内のすべての保存データを暗号化することを選択できます。消去保護を有効にしてキーコンテナーを作成し、キーコンテナーへのアクセスポリシーを指定するなど、暗号化環境を最初に設定する必要がある場合があります。次に、このコマンドレットを使用して、カスタマーマネージドキーを使用して二重暗号化が有効になっている新しい Azure Synapse Analytics ワークスペースをアクティブ化します。

構文

Enable-AzSynapseWorkspace
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      [-Name <String>]
      [-EncryptionKeyIdentifier <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Enable-AzSynapseWorkspace
      [-Name <String>]
      -WorkspaceObject <PSSynapseWorkspace>
      [-EncryptionKeyIdentifier <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Enable-AzSynapseWorkspace
      -InputObject <PSWorkspaceKey>
      [-EncryptionKeyIdentifier <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Enable-AzSynapseWorkspace
      -ResourceId <String>
      [-EncryptionKeyIdentifier <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Enable-AzSynapseWorkspace コマンドレットは、カスタマーマネージドキーを使用して二重暗号化が有効になっている新しい Azure Synapse Analytics ワークスペースをアクティブにします。

例

例 1

Enable-AzSynapseWorkspace -WorkspaceName ContosoWorkspace

このコマンドを実行すると、ContosoWorkspace という名前の新しい Azure Synapse Analytics ワークスペースがアクティブになります。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Enable-AzSynapseWorkspace

このコマンドは、パイプラインを介して ContosoWorkspace という名前の新しい Azure Synapse Analytics ワークスペースをアクティブにします。

例 3

Enable-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/default

このコマンドは、指定されたリソース ID を持つパイプラインを介して新しい Azure Synapse Analytics ワークスペースをアクティブ化します。

パラメーター

-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

-EncryptionKeyIdentifier

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

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

-InputObject

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

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

-Name

ワークスペース暗号化キーの名前。

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

-ResourceGroupName

リソースグループ名。

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

-ResourceId

Synapse SQL プールのリソース識別子。

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

入力

PSSynapseWorkspace

PSWorkspaceKey

出力