Remove-AzKeyVaultManagedHsm
Exclui/limpa um HSM gerenciado.
Sintaxe
RemoveManagedHsmByName (Predefinição)
Remove-AzKeyVaultManagedHsm
[-Name] <String>
[[-ResourceGroupName] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
RemoveDeletedManagedHsmByName
Remove-AzKeyVaultManagedHsm
[-Name] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVaultManagedHsm
[-InputObject] <PSManagedHsm>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVaultManagedHsm
[-InputObject] <PSManagedHsm>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
RemoveManagedHsmByResourceId
Remove-AzKeyVaultManagedHsm
[-ResourceId] <String>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
RemoveDeletedManagedHsmByResourceId
Remove-AzKeyVaultManagedHsm
[-ResourceId] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Description
O cmdlet Remove-AzKeyVaultManagedHsm exclui o HSM gerenciado especificado.
Ele também exclui todas as chaves contidas nessa instância.
Observe que, embora a especificação do grupo de recursos seja opcional para esse cmdlet, você deve fazê-lo para obter um melhor desempenho.
Exemplos
Exemplo 1: Remover um HSM gerenciado
Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -Force
True
Este comando remove o HSM gerenciado chamado myhsm da sua assinatura atual.
Exemplo 2: Remover um hsm gerenciado de um grupo de recursos especificado
Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -ResourceGroupName "myrg1" -PassThru
True
Este comando remove o HSM gerenciado chamado myhsm do grupo de recursos chamado myrg1.
Se você não especificar o nome do grupo de recursos, o cmdlet procurará o HSM gerenciado nomeado para excluir em sua assinatura atual.
Exemplo 3: Limpar um hsm gerenciado excluído
Remove-AzKeyVaultManagedHsm -Name 'myhsm' -Location "eastus" -Force -PassThru
True
Este comando limpa o HSM gerenciado chamado myhsm localizado no eastus.
Parâmetros
-AsJob
Executar cmdlet em segundo plano
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: Cf.
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-DefaultProfile
As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.
Propriedades dos parâmetros
Tipo: IAzureContextContainer
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Force
Indica que o cmdlet não solicita confirmação.
Por padrão, esse cmdlet solicita que você confirme que deseja excluir o HSM gerenciado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
Objeto HSM gerenciado a ser excluído.
Tipo: PSManagedHsm
Default value: None
Suporta carateres universais: False
NãoMostrar: False
RemoveManagedHsmByInputObject
Position: 0
Obrigatório: True
Valor do pipeline: True
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
RemoveDeletedManagedHsmByInputObject
Position: 0
Obrigatório: True
Valor do pipeline: True
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-InRemovedState
Remova o pool de HSM gerenciado excluído anteriormente permanentemente.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
RemoveDeletedManagedHsmByName
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
RemoveDeletedManagedHsmByInputObject
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
RemoveDeletedManagedHsmByResourceId
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Location
O local do pool de HSM gerenciado excluído.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
RemoveDeletedManagedHsmByName
Position: 1
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
RemoveDeletedManagedHsmByResourceId
Position: 1
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Name
Especifica o nome do HSM gerenciado a ser removido.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: HsmName
Conjuntos de parâmetros
RemoveManagedHsmByName
Position: 0
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
RemoveDeletedManagedHsmByName
Position: 0
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-PassThru
Este cmdlet não retorna um objeto por padrão.
Se essa opção for especificada, ela retornará true se for bem-sucedida.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-ResourceGroupName
Especifica o nome do grupo de recursos para o HSM gerido pelo Azure a remover.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
RemoveManagedHsmByName
Position: 1
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-ResourceId
ID do recurso ManagedHsm.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
RemoveManagedHsmByResourceId
Position: 0
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
RemoveDeletedManagedHsmByResourceId
Position: 0
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-SubscriptionId
O ID da assinatura.
Por padrão, os cmdlets são executados na assinatura definida no contexto atual. Se o usuário especificar outra assinatura, o cmdlet atual será executado na assinatura especificada pelo usuário.
A substituição de assinaturas só entra em vigor durante o ciclo de vida do cmdlet atual. Ele não altera a assinatura no contexto e não afeta cmdlets subsequentes.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: Wi
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: 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 .
Saídas