Compartilhar via


Remove-AzSynapseWorkspaceKey

Exclui uma chave de workspace.

Sintaxe

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

O Remove-AzSynapseWorkspaceKey remove uma chave de workspace

Exemplos

Exemplo 1

Remove-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoKeyName

Esse comando exclui uma chave de workspace em um workspace do Azure Synapse Analytics.

Exemplo 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseWorkspaceKey -Name ContosoKeyName

Esse comando exclui uma chave de workspace em um workspace do Azure Synapse Analytics por meio do pipeline.

Exemplo 3

Remove-AzSynapseWorkspaceKey -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoKeyName

Esse comando exclui uma chave do workspace do Azure Synapse Analytics por meio do pipeline com a ID de recurso especificada.

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Não peça confirmação.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

Objeto de entrada de chave de workspace, geralmente passado pelo pipeline.

Propriedades do parâmetro

Tipo:PSWorkspaceKey
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteByInputObjectParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

O nome da chave de criptografia do workspace.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Nome da chave

Conjuntos de parâmetros

DeleteByNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
DeleteByParentObjectParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

Esse cmdlet não retorna um objeto por padrão. Se essa opção for especificada, ela retornará true se for bem-sucedida.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

Nome do grupo de recursos.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteByNameParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceId

O identificador de recurso do Pool de SQL do Synapse.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteByResourceIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WorkspaceName

Nome do workspace do Synapse.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteByNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WorkspaceObject

objeto de entrada do workspace, geralmente passado pelo pipeline.

Propriedades do parâmetro

Tipo:PSSynapseWorkspace
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

DeleteByParentObjectParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSSynapseWorkspace

PSWorkspaceKey

String

Saídas

Boolean