Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Remove-AzSynapseWorkspaceKey
- Module:
- Az.Synapse Module
Deletes a workspace key.
Syntax
DeleteByNameParameterSet (Default)
Remove-AzSynapseWorkspaceKey
-WorkspaceName <String>
-Name <String>
[-ResourceGroupName <String>]
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeleteByParentObjectParameterSet
Remove-AzSynapseWorkspaceKey
-Name <String>
-WorkspaceObject <PSSynapseWorkspace>
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeleteByInputObjectParameterSet
Remove-AzSynapseWorkspaceKey
-InputObject <PSWorkspaceKey>
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeleteByResourceIdParameterSet
Remove-AzSynapseWorkspaceKey
-ResourceId <String>
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzSynapseWorkspaceKey removes a workspace key
Examples
Example 1
Remove-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoKeyName
This command deletes a workspace key under an Azure Synapse Analytics workspace.
Example 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseWorkspaceKey -Name ContosoKeyName
This command deletes a workspace key under an Azure Synapse Analytics workspace through pipeline.
Example 3
Remove-AzSynapseWorkspaceKey -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoKeyName
This command deletes an Azure Synapse Analytics workspace key through pipeline with the specified resource ID.
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-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
-Force
Do not ask for confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Workspace key input object, usually passed through the pipeline.
Parameter properties
| Type: | PSWorkspaceKey |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The workspace encryption key name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | KeyName |
Parameter sets
-PassThru
This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
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
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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
PSWorkspaceKey
String
Outputs
Boolean
Azure PowerShell
Feedback
Was this page helpful?