@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，其有已知的衝突問題。 |
| 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：RSASSA-PSS 搭配 SHA-256 和 MGF1 搭配 SHA-256，如 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 金鑰標識碼。例如： https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id> 在剖析上述識別碼時，此函式會傳回： |
函式詳細資料
parseKeyVaultKeyIdentifier(string)
剖析指定的 Key Vault 金鑰標識碼。例如：
https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-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 金鑰的標識碼。