你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

New-AzSynapseWorkspaceKey

创建工作区密钥。

语法

CreateByNameParameterSet (默认值)

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

CreateByParentObjectParameterSet

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

说明

New-AzSynapseWorkspaceKey cmdlet 创建工作区密钥。

示例

示例 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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EncryptionKeyIdentifier

密钥标识符的格式应为:https://{keyvaultname}.vault.azure.net/keys/{keyname}。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

工作区密钥的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:KeyName

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceGroupName

资源组名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

CreateByNameParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WorkspaceName

Synapse 工作区的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

CreateByNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WorkspaceObject

工作区输入对象,通常通过管道传递。

参数属性

类型:PSSynapseWorkspace
默认值:None
支持通配符:False
不显示:False

参数集

CreateByParentObjectParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PSSynapseWorkspace

输出

PSWorkspaceKey