Freigeben über

Backup-AzKeyVaultSecret

Modul:
Az.KeyVault Module

Sichert einen Geheimschlüssel in einem Schlüsseltresor.

Syntax

BySecretName (Standard) 

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

BySecretUri 

Backup-AzKeyVaultSecret
    [-Id] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BySecret 

Backup-AzKeyVaultSecret
    [-InputObject] <PSKeyVaultSecretIdentityItem>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Beschreibung

Das Cmdlet Backup-AzKeyVaultSecret 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-AzKeyVaultSecret, um den geheimen Schlüssel im verschlüsselten Format abzurufen, und verwenden Sie dann das Cmdlet Restore-AzKeyVaultSecret, 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

Backup-AzKeyVaultSecret -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

Backup-AzKeyVaultSecret -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

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -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.

Beispiel 4: Sichern eines geheimen Schlüssels mit einem automatisch generierten Dateinamen (mit URI)

Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'

Parameter

-Confirm

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

Parametereigenschaften

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

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

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

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
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

-Id

Der URI des Schlüsselschlüsselschlüssels. Stellen Sie sicher, dass es dem Format folgt: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Parametereigenschaften

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

Parametersätze

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

-InputObject

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

Parametereigenschaften

Typ:PSKeyVaultSecretIdentityItem
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Geheimnis

Parametersätze

BySecret
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 geheimen Schlüssels an, der gesichert werden soll.

Parametereigenschaften

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

Parametersätze

BySecretName
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 geheimen Schlüssel enthält, der gesichert werden soll.

Parametereigenschaften

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

Parametersätze

BySecretName
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:False
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

PSKeyVaultSecretIdentityItem

Ausgaben

String