Backup-AzureKeyVaultKey

Biztonsági másolatot készít egy kulcstartóban lévő kulcsról.

Fontos

Mivel az Az PowerShell-modulok mostantól az AzureRM PowerShell-modulok összes funkcióját és egyebeket is tartalmazzák, 2024. február 29-én kivonjuk az AzureRM PowerShell-modulokat.

A szolgáltatáskimaradások elkerülése érdekében 2024. február 29-ig frissítse az AzureRM PowerShell-modulokat használó szkripteket az Az PowerShell-modulok használatára. A szkriptek automatikus frissítéséhez kövesse a rövid útmutatót.

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>]

Description

A Backup-AzureKeyVaultKey parancsmag letölti és egy fájlban tárolja a kulcstartóban lévő megadott kulcs biztonsági másolatát. Ha a kulcsnak több verziója is van, a biztonsági másolat tartalmazza az összes verziót. Mivel a letöltött tartalom titkosítva van, nem használható az Azure Key Vault kívül. A biztonsági mentési kulcsot visszaállíthatja az előfizetés bármely kulcstartójára, amelyről biztonsági másolatot készít. A parancsmag használatának tipikus okai a következők:

  • A kulcs egy másolatát el szeretné helyezni, hogy legyen egy offline példánya arra az esetre, ha véletlenül törli a kulcsot a kulcstartóból.

  • Létrehozott egy kulcsot Key Vault használatával, és most egy másik Azure-régióba szeretné klónozni, hogy az elosztott alkalmazás összes példányából használhassa. A Backup-AzureKeyVaultKey parancsmaggal kérje le a kulcsot titkosított formátumban, majd használja a Restore-AzureKeyVaultKey parancsmagot, és adjon meg egy kulcstartót a második régióban.

Példák

1. példa: Kulcs biztonsági mentése automatikusan létrehozott fájlnévvel

PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

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

Ez a parancs lekéri a MyKey nevű kulcsot a MyKeyVault nevű kulcstartóból, és menti a kulcs biztonsági másolatát egy automatikusan elnevezett fájlba, és megjeleníti a fájl nevét.

2. példa: Kulcs biztonsági mentése egy megadott fájlnévre

PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Ez a parancs lekéri a MyKey nevű kulcsot a MyKeyVault kulcstartóból, és a kulcs biztonsági másolatát egy Backup.blob nevű fájlba menti.

3. példa: Korábban lekért kulcs biztonsági mentése egy megadott fájlnévre, a célfájl felülírása kérés nélkül.

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

C:\Backup.blob

Ez a parancs létrehoz egy biztonsági másolatot a $key nevű kulcsról. A $key nevű tároló neve. VaultName egy Backup.blob nevű fájlhoz, amely csendesen felülírja a fájlt, ha már létezik.

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

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

-DefaultProfile

Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés

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

-Force

A megadott fájl felülírása, ha létezik

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

-InputObject

Kulcscsomag a biztonsági mentéshez, amely egy lekéréses hívás kimenetéből van beállítva.

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

-Name

Megadja a biztonsági mentésre kijelölt kulcs nevét.

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

-OutputFile

Megadja azt a kimeneti fájlt, amelyben a biztonsági mentési blob tárolva van. Ha nem adja meg ezt a paramétert, ez a parancsmag létrehoz egy fájlnevet. Ha egy meglévő kimeneti fájl nevét adja meg, a művelet nem fejeződik be, és hibaüzenetet ad vissza arról, hogy a biztonsági mentési fájl már létezik.

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

-VaultName

Megadja annak a kulcstartónak a nevét, amely a biztonsági mentéshez szükséges kulcsot tartalmazza.

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

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut.

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

Bevitelek

PSKeyVaultKeyIdentityItem

Paraméterek: InputObject (ByValue)

Kimenetek

String