Get-AzSynapseWorkspaceKey

Reference

Module:: Az.Synapse

Gets a workspace key.

Syntax

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

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

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/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/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.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The workspace encryption key name.

Type:	String
Aliases:	KeyName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource group name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

The resource identifier of Synapse SQL Pool.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

Name of Synapse workspace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:	PSSynapseWorkspace
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PSSynapseWorkspace

Outputs

PSWorkspaceKey

Freigeben über