< Back
Backup-AzureKeyVaultSecret
Post
NAME Backup-AzureKeyVaultSecret
SYNOPSIS
Backs up a secret in a key vault.
SYNTAX
Backup-AzureKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [[-OutputFile] <String>] [[-Force]] [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Backup-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [[-Force]] [-DefaultProfile <IAzureContextContainer>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Backup-AzureKeyVaultSecret cmdlet backs up a specified secret in a key vault by downloading it and storing it in a file. If there are multiple
versions of the secret, all versions are included in the backup. Because the downloaded content is encrypted, it cannot be used outside of Azure
Key Vault. You can restore a backed-up secret to any key vault in the subscription that it was backed up from.
Typical reasons to use this cmdlet are:
- You want to escrow a copy of your secret, so that you have an offline copy in case you accidentally delete your secret in your key vault.
- You added a secret to a key vault and now want to clone the secret into a different Azure region, so that you can use it from all instances of
your distributed application. Use the Backup-AzureKeyVaultSecret cmdlet to retrieve the secret in encrypted format and then use the
Restore-AzureKeyVaultSecret cmdlet and specify a key vault in the second region. (Note that the regions must belong to the same geography.)
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
-Force [<SwitchParameter>]
Prompts you for confirmation before overwriting the output file, if that exists.
Required? false
Position? 3
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <PSKeyVaultSecretIdentityItem>
Secret to be backed up, pipelined in from the output of a retrieval call.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the secret to back up.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OutputFile <String>
Specifies the output file in which the backup blob is stored. If you do not specify this parameter, this cmdlet generates a file name for you.
If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already
exists.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the name of the key vault that contains the secret to back up.
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
None
This cmdlet does not accept any input.
OUTPUTS
String
The cmdlet returns the path of the output file containing the backup of the key.
NOTES
Example 1: Back up a secret with an automatically generated file name
PS C:\\>Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
This command retrieves the secret named MySecret from the key vault named MyKeyVault and saves a backup of that secret to a file that is
automatically named for you, and displays the file name.
Example 2: Back up a secret to a specified file name, overwriting the existing file without prompting
PS C:\\>Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\\Backup.blob' -Force
This command retrieves the secret named MySecret from the key vaultnamed MyKeyVault and saves a backup of that secret to a file named Backup.blob.
Example 3: Back up a secret previously retrieved to a specified file name
PS C:\\>$secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\\>Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\\Backup.blob'
This command uses the $secret object's vault name and name to retrieves the secret and saves its backup to a file named Backup.blob.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... aultsecret
Set-AzureKeyVaultSecret
Get-AzureKeyVaultSecret
Remove-AzureKeyVaultSecret
Restore-AzureKeyVaultSecret
SYNOPSIS
Backs up a secret in a key vault.
SYNTAX
Backup-AzureKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [[-OutputFile] <String>] [[-Force]] [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Backup-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [[-Force]] [-DefaultProfile <IAzureContextContainer>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Backup-AzureKeyVaultSecret cmdlet backs up a specified secret in a key vault by downloading it and storing it in a file. If there are multiple
versions of the secret, all versions are included in the backup. Because the downloaded content is encrypted, it cannot be used outside of Azure
Key Vault. You can restore a backed-up secret to any key vault in the subscription that it was backed up from.
Typical reasons to use this cmdlet are:
- You want to escrow a copy of your secret, so that you have an offline copy in case you accidentally delete your secret in your key vault.
- You added a secret to a key vault and now want to clone the secret into a different Azure region, so that you can use it from all instances of
your distributed application. Use the Backup-AzureKeyVaultSecret cmdlet to retrieve the secret in encrypted format and then use the
Restore-AzureKeyVaultSecret cmdlet and specify a key vault in the second region. (Note that the regions must belong to the same geography.)
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
-Force [<SwitchParameter>]
Prompts you for confirmation before overwriting the output file, if that exists.
Required? false
Position? 3
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <PSKeyVaultSecretIdentityItem>
Secret to be backed up, pipelined in from the output of a retrieval call.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the secret to back up.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OutputFile <String>
Specifies the output file in which the backup blob is stored. If you do not specify this parameter, this cmdlet generates a file name for you.
If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already
exists.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the name of the key vault that contains the secret to back up.
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
None
This cmdlet does not accept any input.
OUTPUTS
String
The cmdlet returns the path of the output file containing the backup of the key.
NOTES
Example 1: Back up a secret with an automatically generated file name
PS C:\\>Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
This command retrieves the secret named MySecret from the key vault named MyKeyVault and saves a backup of that secret to a file that is
automatically named for you, and displays the file name.
Example 2: Back up a secret to a specified file name, overwriting the existing file without prompting
PS C:\\>Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\\Backup.blob' -Force
This command retrieves the secret named MySecret from the key vaultnamed MyKeyVault and saves a backup of that secret to a file named Backup.blob.
Example 3: Back up a secret previously retrieved to a specified file name
PS C:\\>$secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\\>Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\\Backup.blob'
This command uses the $secret object's vault name and name to retrieves the secret and saves its backup to a file named Backup.blob.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... aultsecret
Set-AzureKeyVaultSecret
Get-AzureKeyVaultSecret
Remove-AzureKeyVaultSecret
Restore-AzureKeyVaultSecret