Backup-AzureKeyVaultKey
Maakt een back-up van een sleutel in een sleutelkluis.
Waarschuwing
De AzureRM PowerShell-module is vanaf 29 februari 2024 officieel afgeschaft. Gebruikers wordt aangeraden om van AzureRM naar de Az PowerShell-module te migreren om ondersteuning en updates te garanderen.
Hoewel de AzureRM-module nog steeds kan functioneren, wordt deze niet meer onderhouden of ondersteund, waardoor het gebruik naar eigen goeddunken en risico van de gebruiker blijft bestaan. Raadpleeg onze migratiebronnen voor hulp bij de overgang naar de Az-module.
Syntax
Backup-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Backup-AzureKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
De cmdlet Backup-AzureKeyVaultKey maakt een back-up van een opgegeven sleutel in een sleutelkluis door deze te downloaden en op te slaan in een bestand. Als er meerdere versies van de sleutel zijn, worden alle versies opgenomen in de back-up. Omdat de gedownloade inhoud is versleuteld, kan deze niet worden gebruikt buiten Azure Key Vault. U kunt een back-upsleutel herstellen naar elke sleutelkluis in het abonnement waarvan een back-up is gemaakt. Veelvoorkomende redenen voor het gebruik van deze cmdlet zijn:
U wilt een kopie van uw sleutel borgen, zodat u een offlinekopie hebt voor het geval u uw sleutel per ongeluk verwijdert in uw sleutelkluis.
U hebt een sleutel gemaakt met Key Vault en u wilt de sleutel nu klonen in een andere Azure-regio, zodat u deze kunt gebruiken vanuit alle exemplaren van uw gedistribueerde toepassing. Gebruik de cmdlet Backup-AzureKeyVaultKey om de sleutel op te halen in versleutelde indeling en gebruik vervolgens de cmdlet Restore-AzureKeyVaultKey en geef een sleutelkluis op in de tweede regio.
Voorbeelden
Voorbeeld 1: Een back-up maken van een sleutel met een automatisch gegenereerde bestandsnaam
PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
C:\Users\username\mykeyvault-mykey-1527029447.01191Met deze opdracht wordt de sleutel met de naam MyKey opgehaald uit de sleutelkluis met de naam MyKeyVault en wordt een back-up van die sleutel opgeslagen in een bestand dat automatisch voor u wordt genoemd en wordt de bestandsnaam weergegeven.
Voorbeeld 2: Een back-up maken van een sleutel naar een opgegeven bestandsnaam
PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'
C:\Backup.blobMet deze opdracht wordt de sleutel MyKey opgehaald uit de sleutelkluis met de naam MyKeyVault en wordt een back-up van die sleutel opgeslagen in een bestand met de naam Backup.blob.
Voorbeeld 3: Maak een back-up van een eerder opgehaalde sleutel naar een opgegeven bestandsnaam, waarbij het doelbestand wordt overschreven zonder dat u hierom wordt gevraagd.
PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blobMet deze opdracht maakt u een back-up van de sleutel met de naam $key. Naam in de kluis met de naam $key. VaultName naar een bestand met de naam Backup.blob, overschrijft het bestand op de achtergrond als het al bestaat.
Parameters
-Confirm
Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Het opgegeven bestand overschrijven als het bestaat
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Sleutelbundel om een back-up te maken, gepijplijnd vanuit de uitvoer van een ophaalaanroep.
| Type: | PSKeyVaultKeyIdentityItem |
| Aliases: | Key |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Hiermee geeft u de naam van de sleutel waarvan een back-up moet worden gemaakt.
| Type: | String |
| Aliases: | KeyName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFile
Hiermee geeft u het uitvoerbestand waarin de back-upblob wordt opgeslagen. Als u deze parameter niet opgeeft, genereert deze cmdlet een bestandsnaam voor u. Als u de naam van een bestaand uitvoerbestand opgeeft, wordt de bewerking niet voltooid en wordt er een foutbericht geretourneerd dat het back-upbestand al bestaat.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VaultName
Hiermee geeft u de naam op van de sleutelkluis die de sleutel bevat waarvan een back-up moet worden gemaakt.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Invoerwaarden
Parameters: InputObject (ByValue)