wrap Key - wrap Key

服务:

Key Vault

API 版本:

7.4

使用指定的密钥包装对称密钥。
WRAP作支持使用以前存储在 Azure Key Vault 中的密钥加密密钥对对称密钥进行加密。 WRAP作仅适用于存储在 Azure Key Vault 中的对称密钥，因为可以使用密钥的公共部分执行使用非对称密钥的保护。 对于具有密钥引用但无权访问公钥材料的调用方来说，非对称密钥支持此操作。 此作需要密钥/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 minLength: 1	算法标识符
value	True	string (base64url)
aad		string (base64url)	使用经过身份验证的加密算法时要进行身份验证但不加密/解密的其他数据。
iv		string (base64url)	对称算法的加密随机非重复初始化向量。
tag		string (base64url)	使用经过身份验证的算法执行解密时要进行身份验证的标记。

响应

名称	类型	说明
200 OK	KeyOperationResult	包装的对称密钥。
Other Status Codes	KeyVaultError	Key Vault 错误响应，描述作失败的原因。

示例

Wrapkey

示例请求

HTTP

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

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

示例响应

状态代码:

200

{
  "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

Object

密钥保管库服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

JsonWebKeyEncryptionAlgorithm

枚举

算法标识符

值	说明
A128CBC
A128CBCPAD
A128GCM
A128KW
A192CBC
A192CBCPAD
A192GCM
A192KW
A256CBC
A256CBCPAD
A256GCM
A256KW
RSA-OAEP
RSA-OAEP-256
RSA1_5

KeyOperationResult

Object

键作结果。

名称	类型	说明
aad	string (base64url)
iv	string (base64url)
kid	string	密钥标识符
tag	string (base64url)
value	string (base64url)

KeyOperationsParameters

Object

关键作参数。

名称	类型	说明
aad	string (base64url)	使用经过身份验证的加密算法时要进行身份验证但不加密/解密的其他数据。
alg	JsonWebKeyEncryptionAlgorithm minLength: 1	算法标识符
iv	string (base64url)	对称算法的加密随机非重复初始化向量。
tag	string (base64url)	使用经过身份验证的算法执行解密时要进行身份验证的标记。
value	string (base64url)

KeyVaultError

Object

密钥保管库错误异常。

名称	类型	说明
error	Error	密钥保管库服务器错误。