共用方式為

Backup-AzureKeyVaultSecret

  • 參考
模組:
AzureRM.KeyVault

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

警告

自 2024 年 2 月 29 日起，AzureRM PowerShell 模組已正式淘汰。 建議使用者從 AzureRM 遷移至 Az PowerShell 模組，以確保持續支援和更新。

雖然 AzureRM 模組可能仍可運作，但不再維護或支援它，但會根據用戶的判斷權和風險放置任何繼續使用。 如需轉換至 Az 模組的指引，請參閱我們的 移轉資源 。

Syntax

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

Description

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

  • 您想要委付密碼的複本，以便在不小心刪除密鑰保存庫中的秘密時，擁有脫機複本。
  • 您已將秘密新增至金鑰保存庫，現在想要將秘密複製到不同的 Azure 區域，以便從分散式應用程式的所有實例使用它。 使用Backup-AzureKeyVaultSecret Cmdlet 擷取加密格式的秘密，然後使用 Restore-AzureKeyVaultSecret Cmdlet，並在第二個區域中指定密鑰保存庫。 （請注意，區域必須屬於相同的地理位置。

範例

範例 1：使用自動產生的檔名備份秘密

PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

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

範例 2：將秘密備份至指定的檔名，而不提示，覆寫現有的檔案

PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

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

範例 3：備份先前擷取到指定檔名的秘密

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

此命令會使用$secret物件的保存庫名稱和名稱來擷取秘密，並將其備份儲存至名為Backup.blob的檔案。

參數

-Confirm

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

類型:SwitchParameter
Aliases:cf
Position:Named
預設值:False
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

類型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

如果存在，請先提示您進行確認，然後再覆寫輸出檔案。

類型:SwitchParameter
Position:Named
預設值:False
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

要備份的秘密，從擷取呼叫的輸出中管線。

類型:PSKeyVaultSecretIdentityItem
Aliases:Secret
Position:0
預設值:None
必要:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

指定要備份的秘密名稱。

類型:String
Aliases:SecretName
Position:1
預設值:None
必要:True
Accept pipeline input:False
Accept wildcard characters:False

-OutputFile

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

類型:String
Position:2
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

指定要備份之秘密的金鑰保存庫名稱。

類型:String
Position:0
預設值:None
必要:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

類型:SwitchParameter
Aliases:wi
Position:Named
預設值:False
必要:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

PSKeyVaultSecretIdentityItem

參數：InputObject （ByValue）

輸出

String