Backup-AzureKeyVaultSecret

  • Referenz
Modul:
AzureRM.KeyVault

Sichert einen Geheimschlü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-AzureKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzureKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Das Cmdlet Backup-AzureKeyVaultSecret sichert einen angegebenen Geheimschlüssel in einem Schlüsseltresor, indem es heruntergeladen und in einer Datei gespeichert wird. Wenn mehrere Versionen des geheimen 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 Geheimschlüssel in einem beliebigen Schlüsseltresor im Abonnement wiederherstellen, von dem es gesichert wurde. Typische Gründe für die Verwendung dieses Cmdlets sind:

  • Sie möchten eine Kopie Ihres geheimen Schlüssels löschen, damit Sie über eine Offlinekopie verfügen, falls Sie Ihren Geheimschlüssel versehentlich in Ihrem Schlüsseltresor löschen.
  • Sie haben einem Schlüsseltresor einen Geheimschlüssel hinzugefügt und möchten nun den Geheimschlüssel in eine andere Azure-Region klonen, damit Sie es aus allen Instanzen Ihrer verteilten Anwendung verwenden können. Verwenden Sie das Cmdlet Backup-AzureKeyVaultSecret, um den geheimen Schlüssel im verschlüsselten Format abzurufen, und verwenden Sie dann das Cmdlet Restore-AzureKeyVaultSecret, und geben Sie einen Schlüsseltresor in der zweiten Region an. (Beachten Sie, dass die Regionen derselben Geografie angehören müssen.)

Beispiele

Beispiel 1: Sichern eines geheimen Schlüssels mit einem automatisch generierten Dateinamen

PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

C:\Users\username\mykeyvault-mysecret-1527029447.01191

Mit diesem Befehl wird der geheime Schlüssel "MySecret" aus dem Schlüsseltresor "MyKeyVault" abgerufen und eine Sicherung dieses geheimen Schlüssels in einer Datei gespeichert, die automatisch für Sie benannt wird, und zeigt den Dateinamen an.

Beispiel 2: Sichern eines geheimen Schlüssels mit einem angegebenen Dateinamen, Überschreiben der vorhandenen Datei ohne Aufforderung

PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Mit diesem Befehl wird der geheime Schlüssel "MySecret" aus dem Schlüsseltresor "MyKeyVault" abgerufen und eine Sicherung dieses geheimen Schlüssels in einer Datei namens "Backup.blob" gespeichert.

Beispiel 3: Sichern eines geheimen Schlüssels, der zuvor in einen angegebenen Dateinamen abgerufen wurde

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Dieser Befehl verwendet den Tresornamen und den Namen des $secret Objekts, um den geheimen Schlüssel abzurufen und die Sicherung in einer Datei namens "Backup.blob" zu speichern.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

Fordert Sie zur Bestätigung auf, bevor Sie die Ausgabedatei überschreiben, sofern vorhanden.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Geheimer Schlüssel, der gesichert werden soll, weitergeleitet aus der Ausgabe eines Abrufaufrufs.

Type:PSKeyVaultSecretIdentityItem
Aliases:Secret
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Gibt den Namen des geheimen Schlüssels an, der gesichert werden soll.

Type:String
Aliases:SecretName
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 geheimen Schlüssel enthält, der gesichert werden soll.

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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

PSKeyVaultSecretIdentityItem

Parameter: InputObject (ByValue)

Ausgaben

String