Freigeben über

Backup-AzKeyVaultKey

Modul:
Az.KeyVault Module

Sichert einen Schlüssel in einem Schlüsseltresor.

Syntax

ByKeyName (Standard) 

Backup-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmByKeyName 

Backup-AzKeyVaultKey
    [-Name] <String>
    [[-OutputFile] <String>]
    -HsmName <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKey 

Backup-AzKeyVaultKey
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Beschreibung

Das Cmdlet Backup-AzKeyVaultKey sichert einen angegebenen Schlüssel in einem Schlüsseltresor durch Herunterladen und Speichern in einer Datei. 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-AzKeyVaultKey , um den Schlüssel im verschlüsselten Format abzurufen, und verwenden Sie dann das Cmdlet Restore-AzKeyVaultKey, und geben Sie einen Schlüsseltresor in der zweiten Region an.

Beispiele

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

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

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

Dieser 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

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Mit 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.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Mit 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

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Parametereigenschaften

Typ:IAzureContextContainer
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:AzContext, AzureRmContext, AzureCredential

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Force

Überschreiben Der angegebenen Datei, falls vorhanden

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-HsmName

HSM-Name. Cmdlet erstellt den FQDN eines verwalteten HSM basierend auf dem Namen und der aktuell ausgewählten Umgebung.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

HsmByKeyName
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-InputObject

Schlüsselbundle zum Sichern, weitergeleitet aus der Ausgabe eines Abrufaufrufs.

Parametereigenschaften

Typ:PSKeyVaultKeyIdentityItem
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Key

Parametersätze

ByKey
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Name

Gibt den Namen des zu sichernden Schlüssels an.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Schlüsselname

Parametersätze

ByKeyName
Position:1
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
HsmByKeyName
Position:1
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten: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.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:2
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-VaultName

Gibt den Namen des Schlüsseltresors an, der den zu sichernden Schlüssel enthält.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ByKeyName
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

PSKeyVaultKeyIdentityItem

Ausgaben

String