Backup-AzureKeyVaultKey
Sichert einen Schlüssel in einem Schlüsseltresor.
Warnung
Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.
Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.
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>] Beschreibung
Das Cmdlet Backup-AzureKeyVaultKey sichert einen angegebenen Schlüssel in einem Schlüsseltresor, indem es heruntergeladen und in einer Datei gespeichert wird. Wenn mehrere Versionen des Schlüssels vorhanden sind, sind alle Versionen in der Sicherung enthalten. Da der heruntergeladene Inhalt verschlüsselt ist, kann er nicht außerhalb von Azure Key Vault verwendet werden. Sie können einen gesicherten Schlüssel in einem beliebigen Schlüsseltresor im Abonnement wiederherstellen, von dem er gesichert wurde. Typische Gründe für die Verwendung dieses Cmdlets sind:
Sie möchten eine Kopie Ihres Schlüssels löschen, damit Sie über eine Offlinekopie verfügen, falls Sie ihren Schlüssel versehentlich in Ihrem Schlüsseltresor löschen.
Sie haben einen Schlüssel mit Key Vault erstellt und möchten nun den Schlüssel in eine andere Azure-Region klonen, damit Sie ihn aus allen Instanzen Ihrer verteilten Anwendung verwenden können. Verwenden Sie das Cmdlet Backup-AzureKeyVaultKey , um den Schlüssel im verschlüsselten Format abzurufen, und verwenden Sie dann das Cmdlet Restore-AzureKeyVaultKey, und geben Sie einen Schlüsseltresor in der zweiten Region an.
Beispiele
Beispiel 1: Sichern eines Schlüssels mit einem automatisch generierten Dateinamen
PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
C:\Users\username\mykeyvault-mykey-1527029447.01191Dieser Befehl ruft den Schlüssel "MyKey" aus dem Schlüsseltresor mit dem Namen "MyKeyVault" ab und speichert eine Sicherung dieses Schlüssels in einer Datei, die automatisch für Sie benannt wird, und zeigt den Dateinamen an.
Beispiel 2: Sichern eines Schlüssels zu einem angegebenen Dateinamen
PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'
C:\Backup.blobMit diesem Befehl wird der Schlüssel "MyKey" aus dem Schlüsseltresor "MyKeyVault" abgerufen und eine Sicherung dieses Schlüssels in einer Datei namens "Backup.blob" gespeichert.
Beispiel 3: Sichern Sie einen zuvor abgerufenen Schlüssel auf einen angegebenen Dateinamen, und überschreiben Sie die Zieldatei ohne Aufforderung.
PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blobMit diesem Befehl wird eine Sicherung des Schlüssels namens $key erstellt. Name im Tresor mit dem Namen $key. VaultName zu einer Datei mit dem Namen "Backup.blob" wird automatisch überschrieben, wenn sie bereits vorhanden ist.
Parameter
-Confirm
Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Überschreiben Der angegebenen Datei, falls vorhanden
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Schlüsselbundle zum Sichern, weitergeleitet aus der Ausgabe eines Abrufaufrufs.
| Type: | PSKeyVaultKeyIdentityItem |
| Aliases: | Key |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Gibt den Namen des zu sichernden Schlüssels an.
| Type: | String |
| Aliases: | KeyName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFile
Gibt die Ausgabedatei an, in der das Sicherungs-BLOB gespeichert ist. Wenn Sie diesen Parameter nicht angeben, generiert dieses Cmdlet einen Dateinamen für Sie. Wenn Sie den Namen einer vorhandenen Ausgabedatei angeben, wird der Vorgang nicht abgeschlossen und gibt eine Fehlermeldung zurück, dass die Sicherungsdatei bereits vorhanden ist.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VaultName
Gibt den Namen des Schlüsseltresors an, der den zu sichernden Schlüssel enthält.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Eingaben
Parameter: InputObject (ByValue)