Enable-AzSynapseWorkspace
创建 Azure Synapse Analytics 工作区时,可以选择使用客户管理的密钥加密工作区中静态所有数据,该密钥将为工作区提供双重加密。可能需要首先设置加密环境,例如创建启用了清除保护的密钥保管库,并指定密钥保管库的访问策略。 然后,使用此 cmdlet 激活使用客户管理的密钥启用双重加密的新 Azure Synapse Analytics 工作区。
语法
EnableByNameParameterSet (默认值)
Enable-AzSynapseWorkspace
-WorkspaceName <String>
[-ResourceGroupName <String>]
[-Name <String>]
[-EncryptionKeyIdentifier <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
EnableByParentObjectParameterSet
Enable-AzSynapseWorkspace
-WorkspaceObject <PSSynapseWorkspace>
[-Name <String>]
[-EncryptionKeyIdentifier <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Enable-AzSynapseWorkspace
-InputObject <PSWorkspaceKey>
[-EncryptionKeyIdentifier <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
EnableByResourceIdParameterSet
Enable-AzSynapseWorkspace
-ResourceId <String>
[-EncryptionKeyIdentifier <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Enable-AzSynapseWorkspace cmdlet 激活新的 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
在后台运行 cmdlet
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前,提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-EncryptionKeyIdentifier
密钥标识符的格式应为:https://{keyvaultname}.vault.azure.net/keys/{keyname}。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
工作区密钥输入对象,通常通过管道传递。
EnableByInputObjectParameterSet
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Name
工作区加密密钥名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 键名 |
参数集
EnableByNameParameterSet
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
EnableByParentObjectParameterSet
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ResourceGroupName
资源组名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
EnableByNameParameterSet
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ResourceId
Synapse SQL 池的资源标识符。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
EnableByResourceIdParameterSet
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。
命令脚本未运行。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WorkspaceName
Synapse 工作区的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
EnableByNameParameterSet
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WorkspaceObject
工作区输入对象,通常通过管道传递。
参数属性
参数集
EnableByParentObjectParameterSet
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输出