< Back
Undo-AzureKeyVaultKeyRemoval
Post
NAME Undo-AzureKeyVaultKeyRemoval
SYNOPSIS
Recovers a deleted key in a key vault into an active state.
SYNTAX
Undo-AzureKeyVaultKeyRemoval [-InputObject] <PSDeletedKeyVaultKeyIdentityItem> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Undo-AzureKeyVaultKeyRemoval [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Undo-AzureKeyVaultKeyRemoval cmdlet will recover a previously deleted key. The recovered key will be active and can be used for all normal key
operations. Caller needs to have 'recover' permission in order to perform this operation.
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 <PSDeletedKeyVaultKeyIdentityItem>
Deleted key object
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
Key name. Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name.
Required? true
Position? 1
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
OUTPUTS
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey
NOTES
Example 1
PS C:\\>Undo-AzureKeyVaultKeyRemoval -VaultName 'MyKeyVault' -Name 'MyKey'
This command will recover the key 'MyKey' that was previously deleted, into an active and usable state.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... keyremoval
Remove-AzureKeyVaultKey
Add-AzureKeyVaultKey
Get-AzureKeyVaultKey
SYNOPSIS
Recovers a deleted key in a key vault into an active state.
SYNTAX
Undo-AzureKeyVaultKeyRemoval [-InputObject] <PSDeletedKeyVaultKeyIdentityItem> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Undo-AzureKeyVaultKeyRemoval [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Undo-AzureKeyVaultKeyRemoval cmdlet will recover a previously deleted key. The recovered key will be active and can be used for all normal key
operations. Caller needs to have 'recover' permission in order to perform this operation.
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 <PSDeletedKeyVaultKeyIdentityItem>
Deleted key object
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
Key name. Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name.
Required? true
Position? 1
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
OUTPUTS
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey
NOTES
Example 1
PS C:\\>Undo-AzureKeyVaultKeyRemoval -VaultName 'MyKeyVault' -Name 'MyKey'
This command will recover the key 'MyKey' that was previously deleted, into an active and usable state.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... keyremoval
Remove-AzureKeyVaultKey
Add-AzureKeyVaultKey
Get-AzureKeyVaultKey