Backup-AzKeyVaultSecret
语法
BySecretName (默认值)
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>]
说明
Backup-AzKeyVaultSecret cmdlet 通过下载密钥保管库并将其存储在文件中来备份密钥保管库中的指定机密。
如果机密有多个版本，则备份中包含所有版本。
由于下载的内容已加密，因此不能在Azure 密钥保管库之外使用它。
可以将备份的机密还原到订阅中备份的任何密钥保管库。
使用此 cmdlet 的典型原因是：
- 你想要托管机密的副本，以便在意外删除密钥保管库中的机密时，拥有脱机副本。
- 已将机密添加到密钥保管库，现在想要将机密克隆到其他Azure区域，以便可以从分布式应用程序的所有实例使用它。 使用 Backup-AzKeyVaultSecret cmdlet 以加密格式检索机密，然后使用 Restore-AzKeyVaultSecret cmdlet 并在第二个区域中指定密钥保管库。 （请注意，区域必须属于同一地理位置。
示例
示例 1：使用自动生成的文件名备份机密
Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
C:\Users\username\mykeyvault-mysecret-1527029447.01191
此命令从名为 MyKeyVault 的密钥保管库中检索名为 MySecret 的机密，并将该机密的备份保存到自动命名的文件，并显示文件名。
示例 2：将机密备份到指定的文件名，在不提示的情况下覆盖现有文件
Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blob
此命令从名为 MyKeyVault 的密钥保管库中检索名为 MySecret 的机密，并将该机密的备份保存到名为 Backup.blob 的文件。
示例 3：备份以前检索到指定文件名的机密
$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'
C:\Backup.blob
此命令使用$secret对象的保管库名称和名称检索机密，并将其备份保存到名为 Backup.blob 的文件。
示例 4：使用自动生成的文件名备份机密（使用 Uri）
Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'
参数
-Confirm
在运行 cmdlet 之前，提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Force
如果存在，请在覆盖输出文件之前提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Id
KeyVault 机密的 URI。
请确保它遵循以下格式： https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | SecretId |
参数集
BySecretUri
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
要备份的机密，从检索调用的输出传入。
BySecret
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Name
指定要备份的机密的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | SecretName |
参数集
BySecretName
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-OutputFile
指定在其中存储备份 Blob 的输出文件。
如果未指定此参数，则此 cmdlet 会为你生成文件名。
如果指定现有输出文件的名称，该作将不会完成，并返回一条错误消息，指出备份文件已存在。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 2 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-VaultName
指定包含要备份的机密的密钥保管库的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
BySecretName
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。
命令脚本未运行。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持以下常用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
输出
