Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzSynapseWorkspaceKey

Gets a workspace key.

Syntax

GetByNameParameterSet (Default) 

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>]

Description

The Get-AzSynapseWorkspaceKey cmdlet gets a workspace key.

Examples

Example 1

Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace

This command gets information about all workspace keys in the workspace named ContosoWorkspace.

Example 2

Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoWorkspaceKey

This command gets information about the workspace key named ContosoWorkspaceKey in the workspace named ContosoWorkspace.

Example 3

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

This command gets information about the workspace key named ContosoWorkspaceKey in the workspace named ContosoWorkspace through pipeline.

Example 4

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

This command gets the workspace key with the specified resource ID.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

The workspace encryption key name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:KeyName

Parameter sets

-ResourceGroupName

Resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceId

The resource identifier of Synapse SQL Pool.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

Type:PSSynapseWorkspace
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSSynapseWorkspace

Outputs

PSWorkspaceKey

Feedback

Was this page helpful?