Backup-AzKeyVaultKey

  • 參考
模組:
Az.KeyVault

備份金鑰保存庫中的金鑰。

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

Backup-AzKeyVaultKey Cmdlet 會藉由下載密鑰保存庫並將它儲存在檔案中，來備份密鑰保存庫中的指定密鑰。 如果金鑰有多個版本，所有版本都會包含在備份中。 由於下載的內容已加密，因此無法在 Azure 金鑰保存庫 外部使用。 您可以將備份的金鑰還原到其備份的來源訂用帳戶中的任何金鑰保存庫。 使用此 Cmdlet 的一般原因包括：

  • 您想要委付金鑰的複本，以便在不小心刪除金鑰保存庫中的密鑰時，擁有離線複本。

  • 您已使用 金鑰保存庫 建立金鑰，現在想要將密鑰複製到不同的 Azure 區域，以便從分散式應用程式的所有實例使用它。 使用Backup-AzKeyVaultKey Cmdlet 擷取加密格式的密鑰，然後使用 Restore-AzKeyVaultKey Cmdlet，並在第二個區域中指定密鑰保存庫。

範例

範例 1：使用自動產生的檔名備份金鑰

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

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

此命令會從名為 MyKeyVault 的金鑰保存庫擷取名為 MyKey 的金鑰，並將該金鑰的備份儲存至自動為您命名的檔案，並顯示檔名。

範例 2：將金鑰備份至指定的檔案名

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

C:\Backup.blob

此命令會從名為 MyKeyVault 的金鑰保存庫擷取名為 MyKey 的金鑰，並將該金鑰的備份儲存至名為 Backup.blob 的檔案。

範例 3：將先前擷取的金鑰備份至指定的檔名，而不提示覆寫目的地檔案。

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

C:\Backup.blob

此命令會建立名為 $key 之金鑰的備份。名為 $key 的保存庫中的名稱。VaultName 至名為 Backup.blob 的檔案，如果檔案已經存在，則會以無訊息方式覆寫檔案。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

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

-Force

如果存在，請覆寫指定的檔案

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

-HsmName

HSM 名稱。 Cmdlet 會根據名稱和目前選取的環境，建構受控 HSM 的 FQDN。

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

-InputObject

要備份的金鑰組合，從擷取呼叫的輸出進行管線處理。

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

-Name

指定要備份的金鑰名稱。

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

-OutputFile

指定備份 Blob 儲存所在的輸出檔案。 如果您未指定此參數，此 Cmdlet 會為您產生檔名。 如果您指定現有輸出檔的名稱，作業將不會完成，並傳回備份檔已經存在的錯誤訊息。

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

-VaultName

指定要備份之金鑰的金鑰儲存庫名稱。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

PSKeyVaultKeyIdentityItem

輸出

String