Backup-AzKeyVaultKey

  • Referens
Modul:
Az.KeyVault

Säkerhetskopierar en nyckel i ett nyckelvalv.

Syntax

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

Description

Cmdleten Backup-AzKeyVaultKey säkerhetskopierar en angiven nyckel i ett nyckelvalv genom att ladda ned den och lagra den i en fil. Om det finns flera versioner av nyckeln ingår alla versioner i säkerhetskopian. Eftersom det nedladdade innehållet är krypterat kan det inte användas utanför Azure Key Vault. Du kan återställa en säkerhetskopierad nyckel till valfritt nyckelvalv i prenumerationen som den säkerhetskopierades från. Vanliga orsaker till att använda den här cmdleten är:

  • Du vill desponera en kopia av nyckeln så att du har en offlinekopia om du av misstag tar bort nyckeln i nyckelvalvet.

  • Du har skapat en nyckel med Key Vault och vill nu klona nyckeln till en annan Azure-region, så att du kan använda den från alla instanser av ditt distribuerade program. Använd cmdleten Backup-AzKeyVaultKey för att hämta nyckeln i krypterat format och sedan använda cmdleten Restore-AzKeyVaultKey och ange ett nyckelvalv i den andra regionen.

Exempel

Exempel 1: Säkerhetskopiera en nyckel med ett automatiskt genererat filnamn

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

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

Det här kommandot hämtar nyckeln mykey från nyckelvalvet med namnet MyKeyVault och sparar en säkerhetskopia av nyckeln till en fil som automatiskt namnges åt dig och visar filnamnet.

Exempel 2: Säkerhetskopiera en nyckel till ett angivet filnamn

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

C:\Backup.blob

Det här kommandot hämtar nyckeln med namnet MyKey från nyckelvalvet MyKeyVault och sparar en säkerhetskopia av nyckeln till en fil med namnet Backup.blob.

Exempel 3: Säkerhetskopiera en tidigare hämtad nyckel till ett angivet filnamn och skriv över målfilen utan att fråga.

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

C:\Backup.blob

Det här kommandot skapar en säkerhetskopia av nyckeln med namnet $key. Namn i valvet med namnet $key. VaultName till en fil med namnet Backup.blob, som tyst skriver över filen om den redan finns.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Skriv över den angivna filen om den finns

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

-HsmName

HSM-namn. Cmdleten konstruerar FQDN för en hanterad HSM baserat på namnet och den valda miljön.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Nyckelpaket för att säkerhetskopiera, pipelines in från utdata från ett hämtningsanrop.

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

-Name

Anger namnet på nyckeln som ska säkerhetskopieras.

Type:String
Aliases:KeyName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OutputFile

Anger den utdatafil där säkerhetskopieringsbloben lagras. Om du inte anger den här parametern genererar den här cmdleten ett filnamn åt dig. Om du anger namnet på en befintlig utdatafil slutförs inte åtgärden och returnerar ett felmeddelande om att säkerhetskopieringsfilen redan finns.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

Anger namnet på nyckelvalvet som innehåller nyckeln som ska säkerhetskopieras.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

PSKeyVaultKeyIdentityItem

Utdata

String