你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

KeyClient.BackupKey(String, CancellationToken) 方法

定义

请求将指定密钥的备份下载到客户端。

public virtual Azure.Response<byte[]> BackupKey (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member BackupKey : string * System.Threading.CancellationToken -> Azure.Response<byte[]>
override this.BackupKey : string * System.Threading.CancellationToken -> Azure.Response<byte[]>
Public Overridable Function BackupKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Byte())

参数

name
String

键的名称。

cancellationToken
CancellationToken

控制 CancellationToken 请求生存期的 。

返回

例外

name 是一个空字符串。

name 为 null。

服务器返回了错误。 有关从服务器返回的详细信息,请参阅 Message

注解

密钥备份操作以受保护的形式从 Azure 密钥保管库导出密钥。 请注意,此操作不会以可在 Azure 密钥保管库系统外部使用的形式返回实际密钥,返回的密钥会受到 Azure 密钥保管库 HSM 或 Azure 密钥保管库本身的保护。 此操作的目的在于允许客户端在一个 Azure 密钥保管库实例中生成密钥,备份该密钥,然后将其还原到另一个 Azure 密钥保管库实例。 备份操作可用于从 Azure 密钥保管库中导出受保护形式的任何密钥类型。 无法备份密钥的单个版本。 只能在地理边界内执行备份/还原,这意味着,无法将一个地理区域中的备份还原到另一个地理区域。 例如,无法在欧洲地理区域还原美国地理区域中的备份。 此操作需要密钥/备份权限。

适用于