Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Restore-AzureKeyVaultKey

Restore-AzureKeyVaultKey

microsoft.azure.commands.keyvault.dll

Synopsis

Creates a key in in a vault from a backed-up key.

Syntax

Restore-AzureKeyVaultKey [-VaultName] [-InputFile] [-Profile] [<CommonParameters>]

Detailed Description

The Restore-AzureKeyVaultKey cmdlets creates a key in the specified key vault. This key is a replica of the backed-up key in the input file and has the same name as the original key. If the key vault already has a key by the same name, this cmdlet fails instead of overwriting the original key. If the backup contains multiple versions of a key, all versions are restored.

The key vault that you restore the key into can be different from the key vault that you backed up the key from. However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies.

Parameters

-InputFile <String>

Specifies the input file that contains the backup of the key to restore.

Aliases

none

Required?

true

Position

2

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-VaultName <String>

Specifies the name of the key vault into which to restore the key.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Restore a backed-up key

This command restores a key, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault.

PS C:\>Restore-AzureKeyVaultKey -VaultName "MyKeyVault" -InputFile "C:\Backup.blob"  

Online Version
Add-AzureKeyVaultKey
Backup-AzureKeyVaultKey
Get-AzureKeyVaultKey
Remove-AzureKeyVaultKey