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

wrap Key - wrap Key

使用指定的密钥包装对称密钥。
WRAP 操作支持使用以前存储在 Azure 密钥保管库中的密钥加密密钥来加密对称密钥。 只需要对 Azure 密钥保管库中存储的对称密钥严格执行 WRAP 操作,因为可以使用密钥的公共部分执行非对称密钥保护。 非对称密钥支持此操作,这是为了给具有密钥引用,但无权访问公钥材料的调用方提供方便。 此操作需要 keys/wrapKey 权限。

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/wrapkey?api-version=7.4

URI 参数

名称 必需 类型 说明
key-name
path True

string

键的名称。

key-version
path True

string

密钥的版本。

vaultBaseUrl
path True

string

保管库名称,例如 https://myvault.vault.azure.net

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
alg True

JsonWebKeyEncryptionAlgorithm

算法标识符

value True

string

aad

string

使用经过身份验证的加密算法时要进行身份验证但不加密/解密的其他数据。

iv

string

对称算法的加密随机非重复初始化向量。

tag

string

使用经过身份验证的算法执行解密时要进行身份验证的标记。

响应

名称 类型 说明
200 OK

KeyOperationResult

包装的对称密钥。

Other Status Codes

KeyVaultError

密钥保管库描述操作失败原因的错误响应。

示例

Wrapkey

示例请求

POST https://myvault.vault.azure.net//keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6/wrapkey?api-version=7.4

{
  "alg": "RSA1_5",
  "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}

示例响应

{
  "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
  "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw"
}

定义

名称 说明
Error

密钥保管库服务器错误。

JsonWebKeyEncryptionAlgorithm

算法标识符

KeyOperationResult

键操作结果。

KeyOperationsParameters

关键操作参数。

KeyVaultError

密钥保管库错误异常。

Error

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。

innererror

Error

密钥保管库服务器错误。

message

string

错误消息。

JsonWebKeyEncryptionAlgorithm

算法标识符

名称 类型 说明
A128CBC

string

A128CBCPAD

string

A128GCM

string

A128KW

string

A192CBC

string

A192CBCPAD

string

A192GCM

string

A192KW

string

A256CBC

string

A256CBCPAD

string

A256GCM

string

A256KW

string

RSA-OAEP

string

RSA-OAEP-256

string

RSA1_5

string

KeyOperationResult

键操作结果。

名称 类型 说明
aad

string

iv

string

kid

string

密钥标识符

tag

string

value

string

KeyOperationsParameters

关键操作参数。

名称 类型 说明
aad

string

使用经过身份验证的加密算法时要进行身份验证但不加密/解密的其他数据。

alg

JsonWebKeyEncryptionAlgorithm

算法标识符

iv

string

对称算法的加密随机非重复初始化向量。

tag

string

使用经过身份验证的算法执行解密时要进行身份验证的标记。

value

string

KeyVaultError

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。