@azure/keyvault-keys package
类
| CryptographyClient |
用于对 Azure Key Vault 密钥或本地 JsonWebKey执行加密操作的客户端。 |
| KeyClient |
KeyClient 提供了在 Azure Key Vault 中管理 KeyVaultKey 的方法。 客户端支持创建、检索、更新、删除、清除、备份、还原和列出 KeyVaultKeys。 客户端还支持列出已启用软删除的 Azure Key Vault DeletedKey。 |
接口
类型别名
| AesCbcEncryptionAlgorithm |
表示所有支持的 AES-CBC 加密算法的联合类型。 |
| AesGcmEncryptionAlgorithm |
表示所有支持的 AES-GCM 加密算法的联合类型。 |
| DecryptParameters |
一种类型，表示所有当前支持的解密参数，因为它们适用于不同的加密算法。 |
| DeletionRecoveryLevel |
反映当前保管库中证书当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。 服务支持的已知值
可清除：表示删除是不可逆操作的保管库状态，而无法进行恢复。 此级别对应于不可用于删除操作的保护;在接受实体级别或更高级别的删除操作（保管库、资源组、订阅等）时，数据将不可挽回地丢失。 |
| EncryptParameters |
一种类型，表示所有当前支持的加密参数，因为它们适用于不同的加密算法。 |
| EncryptionAlgorithm |
用于加密和解密的算法。 服务支持的已知值
RSA-OAEP：[不建议]使用最佳非对称加密填充（OAEP）的 RSAES，如 https://tools.ietf.org/html/rfc3447中所述，第 A.2.1 节中 RFC 3447 指定的默认参数。 这些默认参数使用 SHA-1 哈希函数和 SHA-1 附带的 MGF1 掩码生成函数。 Microsoft 建议使用 RSA_OAEP_256 或更强的算法增强安全性。 Microsoft不 不建议 RSA_OAEP，仅针对向后兼容而包含。 RSA_OAEP利用 SHA1，该 SHA1 存在已知的碰撞问题。 |
| KeyCurveName |
椭圆曲线名称。 有关有效值，请参阅 JsonWebKeyCurveName。 服务支持的已知值
P-256：NIST P-256 椭圆曲线，AKA SECG 曲线SECP256R1。 |
| KeyExportEncryptionAlgorithm |
定义 KeyEncryptionAlgorithm 的值。 KnownKeyExportEncryptionAlgorithm 可与 KeyEncryptionAlgorithm 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
JSON Web 密钥作。 有关详细信息，请参阅 JsonWebKeyOperation。 服务支持的已知值
加密：指示密钥可用于加密。 |
| KeyRotationPolicyAction |
将执行的操作。 |
| KeyType |
jsonWebKey 键类型（kty），如 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40中定义。 服务支持的已知值
EC：椭圆曲线。 |
| KeyWrapAlgorithm |
密钥包装/解包支持的算法 |
| RsaEncryptionAlgorithm |
表示所有支持的 RSA 加密算法的联合类型。 |
| SignatureAlgorithm |
签名/验证算法标识符。 有关可能的算法类型的详细信息，请参阅 JsonWebKeySignatureAlgorithm。 服务支持的已知值
PS256：将 SHA-256 和 MGF1 与 SHA-256 配合使用 RSASSA-PSS，如 https://tools.ietf.org/html/rfc7518 |
枚举
| KnownDeletionRecoveryLevel |
反映当前保管库中证书当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除证书;否则，只有系统才能在保留间隔结束时清除证书。 |
| KnownEncryptionAlgorithms |
用于加密和解密的算法。 |
| KnownKeyCurveNames |
椭圆曲线名称。 有关有效值，请参阅 JsonWebKeyCurveName。 |
| KnownKeyExportEncryptionAlgorithm |
用于保护导出密钥材料的加密算法 |
| KnownKeyOperations |
服务接受的 KeyOperation 的已知值。 |
| KnownKeyTypes |
jsonWebKey 键类型（kty），如 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40中定义。 |
| KnownSignatureAlgorithms |
签名/验证算法标识符。 有关可能的算法类型的详细信息，请参阅 JsonWebKeySignatureAlgorithm。 |
函数
| parse |
分析给定的 Key Vault 密钥 ID。例如： https://.vault.azure.net/keys// 在分析上述 ID 时，此函数返回： |
函数详细信息
parseKeyVaultKeyIdentifier(string)
分析给定的 Key Vault 密钥 ID。例如：
https://.vault.azure.net/keys//
在分析上述 ID 时，此函数返回：
{
sourceId: "https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id>",
vaultUrl: "https://<keyvault-name>.vault.azure.net",
version: "<unique-version-id>",
name: "<key-name>"
}
function parseKeyVaultKeyIdentifier(id: string): KeyVaultKeyIdentifier参数
- id
-
string
Key Vault 密钥的 ID。