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

@azure/keyvault-keys package

类

CryptographyClient	用于对 Azure Key Vault 密钥或本地 JsonWebKey 执行加密操作的客户端。
KeyClient	KeyClient 提供了在 Azure 密钥保管库中管理 KeyVaultKey 的方法。 客户端支持创建、检索、更新、删除、清除、备份、还原和列出 KeyVaultKeys。 客户端还支持列出已启用软删除的 Azure 密钥保管库的 DeletedKey。

接口

AesCbcDecryptParameters	AES-CBC 加密算法的解密参数。
AesCbcEncryptParameters	AES-CBC 加密算法的加密参数。
AesGcmDecryptParameters	AES-GCM 加密算法的解密参数。
AesGcmEncryptParameters	AES-GCM 加密算法的加密参数。
BackupKeyOptions	的选项 backupKey(string, BackupKeyOptions)。
BeginDeleteKeyOptions	表示可传递给的可选参数的接口 beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	表示可传递给的可选参数的接口 beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	表示可传递给的可选参数的接口 createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	表示可传递给的可选参数的接口 createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	表示可传递给的可选参数的接口 createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	表示可传递给的可选参数的接口 createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	KeyVault 的 CryptographyClient 接受的可选参数
CryptographyOptions	表示加密 API 方法选项的接口，有关详细信息，请转到 CryptographyClient 。
DecryptOptions	的选项 decrypt(DecryptParameters, DecryptOptions)。
DecryptResult	操作的结果 decrypt(DecryptParameters, DecryptOptions) 。
DeletedKey	表示已删除密钥保管库密钥的接口。
EncryptOptions	的选项 encrypt(EncryptParameters, EncryptOptions)。
EncryptResult	操作的结果 encrypt(EncryptParameters, EncryptOptions) 。
GetCryptographyClientOptions	getCryptographyClient 的选项。
GetDeletedKeyOptions	的选项 getDeletedKey(string, GetDeletedKeyOptions)。
GetKeyOptions	的选项 getKey(string, GetKeyOptions)。
GetKeyRotationPolicyOptions	<xref:KeyClient.getRotationPolicy> 的选项
GetRandomBytesOptions	getRandomBytes 的选项
ImportKeyOptions	表示可传递给的可选参数的接口 importKey(string, JsonWebKey_2, ImportKeyOptions)
JsonWebKey	截至 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	KeyVault 的 KeyClient 接受的可选参数
KeyPollerOptions	一个接口，表示可传递给 和 的 beginDeleteKey(string, BeginDeleteKeyOptions) 可选参数 beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	表示 KeyVaultKey 属性的接口
KeyReleasePolicy	可导出密钥的策略规则。
KeyRotationLifetimeAction	一个操作及其相应的触发器，将由密钥保管库在密钥的生存期内执行。
KeyRotationPolicy	属于密钥的完整密钥轮换策略。
KeyRotationPolicyProperties	客户端可为给定密钥设置的密钥轮换策略的属性。 还可以通过将 lifetimeActions 设置为空数组，将密钥轮换策略重置为其默认值。
KeyVaultKey	表示密钥保管库键的接口，其名称、值和 KeyProperties。
KeyVaultKeyIdentifier	表示构成密钥保管库键 ID 的段。
ListDeletedKeysOptions	表示传递给 的 KeyClient 分页操作的可选参数的 listDeletedKeys(ListDeletedKeysOptions)接口。
ListPropertiesOfKeyVersionsOptions	表示传递给 的 KeyClient 分页操作的可选参数的 listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)接口。
ListPropertiesOfKeysOptions	表示传递给 的 KeyClient 分页操作的可选参数的 listPropertiesOfKeys(ListPropertiesOfKeysOptions)接口。
PageSettings	一个接口，用于跟踪分页迭代的设置
PagedAsyncIterableIterator	一个接口，允许异步迭代到完成和按页迭代。
PollOperationState	PollOperationState 包含定义任何长时间运行的操作轮询程序所需的最小属性集的优化列表。 虽然 Poller 类充当本地控制机制来开始触发、等待并可能取消长时间运行的操作，但 PollOperationState 会记录远程长时间运行的操作的状态。 它至少应在操作开始时、完成和取消时进行更新。 不过，实现可以具有任何其他数目的属性，这些属性可以因其他原因而更新。
PollerLike	轮询器抽象表示形式，旨在公开用户需要使用的最小 API。
PurgeDeletedKeyOptions	的选项 purgeDeletedKey(string, PurgeDeletedKeyOptions)。
ReleaseKeyOptions	releaseKey 的选项
ReleaseKeyResult	releaseKey 操作的结果。
RestoreKeyBackupOptions	的选项 restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)。
RotateKeyOptions	rotateKey 的选项
RsaDecryptParameters	RSA 加密算法的解密参数。
RsaEncryptParameters	RSA 加密算法的加密参数。
SignOptions	的选项 sign(string, Uint8Array, SignOptions)。
SignResult	操作的结果 sign(string, Uint8Array, SignOptions) 。
UnwrapKeyOptions	的选项 unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)。
UnwrapResult	操作的结果 <xref:unwrap> 。
UpdateKeyPropertiesOptions	的选项 updateKeyProperties(string, string, UpdateKeyPropertiesOptions)。
UpdateKeyRotationPolicyOptions	updateKeyRotationPolicy 的选项
VerifyDataOptions	verifyData(string, Uint8Array, Uint8Array, VerifyOptions) 的选项
VerifyOptions	的选项 verify(string, Uint8Array, Uint8Array, VerifyOptions)。
VerifyResult	操作的结果 verify(string, Uint8Array, Uint8Array, VerifyOptions) 。
WrapKeyOptions	的选项 wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)。
WrapResult	操作的结果 <xref:wrap> 。

类型别名

AesCbcEncryptionAlgorithm	表示所有支持的 AES-CBC 加密算法的联合类型。
AesGcmEncryptionAlgorithm	表示所有支持的 AES-GCM 加密算法的联合类型。
DecryptParameters	一种类型，表示当前支持的所有解密参数，因为它们应用于不同的加密算法。
DeletionRecoveryLevel	定义 DeletionRecoveryLevel 的值。 KnownDeletionRecoveryLevel 可与 DeleteRecoveryLevel 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 可清除：表示保管库状态，其中删除操作不可逆，无法恢复。 此级别对应于对删除操作没有可用的保护;在实体级别或更高 (保管库、资源组、订阅等接受删除操作时，数据将不可挽回地丢失) 可恢复+可清除：表示可恢复删除的保管库状态，还允许立即和永久删除 (即清除) 。 此级别保证删除实体在保留间隔 (90 天) 的可恢复性，除非请求清除操作或取消订阅。 系统将在 90 天后永久删除它（如果未恢复） 可恢复：表示可恢复删除的保管库状态，无法立即和永久删除 (即清除) 。 此级别保证在保留间隔 (90 天) 且订阅仍然可用期间，已删除实体的可恢复性。 系统将在 90 天后永久删除它（如果未恢复） 可恢复+ProtectedSubscription：表示保管库和订阅状态，其中删除可以在 90 天的保留间隔 (内恢复) ， (即不允许清除) ，并且订阅本身无法永久取消。 系统将在 90 天后永久删除它（如果未恢复） CustomizedRecoverable+Purgeable：表示可恢复删除的保管库状态，还允许立即和永久删除 (，即在 7<= SoftDeleteRetentionInDays < 90) 时清除。 除非请求清除操作或取消订阅，否则此级别可保证已删除实体在保留间隔期间的可恢复性。 CustomizedRecoverable：表示一个保管库状态，其中删除是可恢复的，并且不可能立即和永久删除 (，即当 7<= SoftDeleteRetentionInDays < 90) 时清除。此级别可保证已删除实体在保留间隔期间以及订阅仍可用时的可恢复性。 CustomizedRecoverable+ProtectedSubscription：表示保管库和订阅状态，其中删除是可恢复的、即时和永久删除 (即不允许清除) ，并且当 7<= SoftDeleteRetentionInDays < 90 时，订阅本身无法永久取消。 此级别可保证已删除实体在保留间隔期间的可恢复性，还反映了订阅本身无法取消这一事实。
EncryptParameters	一种类型，表示应用于不同加密算法时当前支持的所有加密参数。
EncryptionAlgorithm	定义 JsonWebKeyEncryptionAlgorithm 的值。 <xref:KnownJsonWebKeyEncryptionAlgorithm> 可与 JsonWebKeyEncryptionAlgorithm 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	定义 JsonWebKeyCurveName 的值。 <xref:KnownJsonWebKeyCurveName> 可与 JsonWebKeyCurveName 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 P-256：NIST P-256 椭圆曲线，AKA SECG 曲线 SECP256R1。 P-384：NIST P-384 椭圆曲线、AKA SECG 曲线 SECP384R1。 P-521：NIST P-521 椭圆曲线，AKA SECG 曲线 SECP521R1。 P-256K：SECG SECP256K1 椭圆曲线。
KeyExportEncryptionAlgorithm	定义 KeyEncryptionAlgorithm 的值。 KnownKeyExportEncryptionAlgorithm 可与 KeyEncryptionAlgorithm 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	定义 JsonWebKeyOperation 的值。 <xref:KnownJsonWebKeyOperation> 可与 JsonWebKeyOperation 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 encrypt decrypt sign verify wrapKey unwrapKey import export
KeyRotationPolicyAction	将执行的操作。
KeyType	定义 JsonWebKeyType 的值。 <xref:KnownJsonWebKeyType> 可与 JsonWebKeyType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 EC：椭圆曲线。 EC-HSM：带存储在 HSM 中的私钥的椭圆曲线。 RSA：RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM：具有存储在 HSM 中的私钥的 RSA。 oct：八进制序列 (用于表示对称密钥) oct-HSM：八进制序列 (用于表示存储 HSM 的对称密钥) 。
KeyWrapAlgorithm	支持的密钥包装/解包算法
RsaEncryptionAlgorithm	表示所有支持的 RSA 加密算法的联合类型。
SignatureAlgorithm	定义 JsonWebKeySignatureAlgorithm 的值。 <xref:KnownJsonWebKeySignatureAlgorithm> 可与 JsonWebKeySignatureAlgorithm 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 PS256：将 SHA-256 和 MGF1 与 SHA-256 配合使用的 RSASSA-PSS，如中所述 https://tools.ietf.org/html/rfc7518 PS384：将 SHA-384 和 MGF1 与 SHA-384 配合使用的 RSASSA-PSS，如 https://tools.ietf.org/html/rfc7518 PS512：将 SHA-512 和 MGF1 与 SHA-512 配合使用的 RSASSA-PSS，如中所述 https://tools.ietf.org/html/rfc7518 RS256：RSASSA-PKCS1-v1_5 使用 SHA-256，如中所述 https://tools.ietf.org/html/rfc7518 RS384：RSASSA-PKCS1-v1_5 使用 SHA-384，如中所述 https://tools.ietf.org/html/rfc7518 RS512：RSASSA-PKCS1-v1_5 使用 SHA-512，如中所述 https://tools.ietf.org/html/rfc7518 RSNULL：保留 ES256：使用 P-256 和 SHA-256 的 ECDSA，如 中所述 https://tools.ietf.org/html/rfc7518。 ES384：使用 P-384 和 SHA-384 的 ECDSA，如 https://tools.ietf.org/html/rfc7518 ES512：使用 P-521 和 SHA-512 的 ECDSA，如中所述 https://tools.ietf.org/html/rfc7518 ES256K：使用 P-256K 和 SHA-256 的 ECDSA，如 https://tools.ietf.org/html/rfc7518

枚举

KnownDeletionRecoveryLevel	服务接受的 DeletionRecoveryLevel 的已知值。
KnownEncryptionAlgorithms	服务接受的 EncryptionAlgorithm 的已知值。
KnownKeyCurveNames	服务接受的 <xref:JsonWebKeyCurveName> 已知值。
KnownKeyExportEncryptionAlgorithm	服务接受的 KeyExportEncryptionAlgorithm 的已知值。
KnownKeyOperations	服务接受的 KeyOperation 的已知值。
KnownKeyTypes	服务接受的 <xref:JsonWebKeyType> 已知值。
KnownSignatureAlgorithms	服务接受的 <xref:JsonWebKeySignatureAlgorithm> 已知值。

函数

parseKeyVaultKeyIdentifier(string)

分析给定的密钥保管库密钥 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>" }

函数详细信息

parseKeyVaultKeyIdentifier(string)

分析给定的密钥保管库密钥 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

密钥保管库密钥的 ID。

返回

KeyVaultKeyIdentifier