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

Get-AzSynapseWorkspaceKey

获取工作区密钥。

语法

GetByNameParameterSet (默认值)

Get-AzSynapseWorkspaceKey
    -WorkspaceName <String>
    [-ResourceGroupName <String>]
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByParentObjectParameterSet

Get-AzSynapseWorkspaceKey
    -WorkspaceObject <PSSynapseWorkspace>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByResourceIdParameterSet

Get-AzSynapseWorkspaceKey
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

说明

Get-AzSynapseWorkspaceKey cmdlet 获取工作区密钥。

示例

示例 1

Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace

此命令获取有关名为 ContosoWorkspace 的工作区中的所有工作区密钥的信息。

示例 2

Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoWorkspaceKey

此命令在名为 ContosoWorkspace 的工作区中获取有关名为 ContosoWorkspaceKey 的工作区密钥的信息。

示例 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseWorkspaceKey -Name ContosoWorkspaceKey

此命令通过管道获取名为 ContosoWorkspaceKey 的工作区密钥的相关信息。

示例 4

Get-AzSynapseSqlPool -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoWorkspaceKey"

此命令获取具有指定资源 ID 的工作区密钥。

参数

-DefaultProfile

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

参数属性

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

参数集

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

-Name

工作区加密密钥名称。

参数属性

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

参数集

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

-ResourceGroupName

资源组名称。

参数属性

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

参数集

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

-ResourceId

Synapse SQL 池的资源标识符。

参数属性

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

参数集

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

-WorkspaceName

Synapse 工作区的名称。

参数属性

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

参数集

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

-WorkspaceObject

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

参数属性

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

参数集

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

CommonParameters

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

输入

PSSynapseWorkspace

输出

PSWorkspaceKey