< Back

Undo-AzureRmKeyVaultRemoval

Tue Jan 29, 2019 9:51 pm

NAME Undo-AzureRmKeyVaultRemoval



SYNOPSIS

Recovers a deleted key vault into an active state.





SYNTAX

Undo-AzureRmKeyVaultRemoval [-InputObject] <PSDeletedKeyVault> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-Tag

<Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]



Undo-AzureRmKeyVaultRemoval [-VaultName] <String> [-ResourceGroupName] <String> [-Location] <String> [-DefaultProfile <IAzureContextContainer>]

[-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Undo-AzureRmKeyVaultRemoval cmdlet will recover a previously deleted key vault. The recovered vault will be active after recovery





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <PSDeletedKeyVault>

Deleted vault object



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Location <String>

Specifies the deleted vault original Azure region.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of an existing resource group in which to create the key vault.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <Hashtable>

Key-value pairs in the form of a hash table. For example:



@{key0="value0";key1=$null;key2="value2"}



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VaultName <String>

Vault name. Cmdlet constructs the FQDN of a vault based on the name and currently selected environment.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

System.Collections.Hashtable





OUTPUTS

Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault







NOTES









Example 1



PS C:\\> Undo-AzureRmKeyVaultRemoval -VaultName 'MyKeyVault' -ResourceGroupName 'MyResourceGroup' -Location 'eastus2' -Tag @{"x"= "y"}



This command will recover the key vault 'MyKeyVault' that was previously deleted from eastus2 region and 'MyResourceGroup' resource group, into an

active and usable state. It also replaces the tags with new tag.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ultremoval

Remove-AzureRmKeyVault

New-AzureRmKeyVault

Get-AzureRmKeyVault