Backup-AzKeyVaultKey
语法
ByKeyName (默认值)
Backup-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
HsmByKeyName
Backup-AzKeyVaultKey
[-Name] <String>
[[-OutputFile] <String>]
-HsmName <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByKey
Backup-AzKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Backup-AzKeyVaultKey cmdlet 通过下载该密钥并将其存储在文件中来备份密钥保管库中的指定密钥。
如果密钥有多个版本,则备份中包含所有版本。
由于下载的内容已加密,因此不能在 Azure Key Vault 外部使用它。
可以将备份密钥还原到订阅中备份的任意密钥保管库。
使用此 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 之前,提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Force
覆盖给定文件(如果存在)
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-HsmName
HSM 名称。 Cmdlet 基于名称和当前所选环境构造托管 HSM 的 FQDN。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
HsmByKeyName
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
要备份的密钥捆绑包,从检索调用的输出传入。
ByKey
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Name
指定要备份的密钥的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 键名 |
参数集
ByKeyName
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
HsmByKeyName
| 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 |
参数集
ByKeyName
| 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。
输出