@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 |
DeletionRecoveryLevel の値を定義します。 サービスでサポートされている既知の値
消去可能: 削除が元に戻せない操作であり、復旧の可能性がないコンテナーの状態を示します。 このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。 |
| EncryptParameters |
現在サポートされているすべての暗号化パラメーターを表す型。異なる暗号化アルゴリズムに適用されます。 |
| EncryptionAlgorithm |
JsonWebKeyEncryptionAlgorithm の値を定義します。 サービスでサポートされている既知の値
RSA-OAEP |
| KeyCurveName |
JsonWebKeyCurveName の値を定義します。 サービスでサポートされている既知の値
P-256: NIST P-256 楕円曲線、別名 SECG 曲線 SECP256R1。 |
| KeyExportEncryptionAlgorithm |
KeyEncryptionAlgorithm の値を定義します。 KnownKeyExportEncryptionAlgorithm は KeyEncryptionAlgorithm と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
JsonWebKeyOperation の値を定義します。 サービスでサポートされている既知の値
encrypt |
| KeyRotationPolicyAction |
実行されるアクション。 |
| KeyType |
JsonWebKeyType の値を定義します。 サービスでサポートされている既知の値
EC: 楕円曲線。 |
| KeyWrapAlgorithm |
キーの折り返し/ラップ解除でサポートされているアルゴリズム |
| RsaEncryptionAlgorithm |
サポートされているすべての RSA 暗号化アルゴリズムを表す共用体の種類。 |
| SignatureAlgorithm |
JsonWebKeySignatureAlgorithm の値を定義します。 サービスでサポートされている既知の値
PS256: SHA-256 および MGF1 と SHA-256 を使用した RSASSA-PSS (以下を参照) https://tools.ietf.org/html/rfc7518 |
列挙型
| KnownDeletionRecoveryLevel |
サービスが受け入れる DeletionRecoveryLevel の既知の値。 |
| KnownEncryptionAlgorithms |
サービスが受け入れる EncryptionAlgorithm の既知の値。 |
| KnownKeyCurveNames |
サービスが受け入れる の <xref:JsonWebKeyCurveName> 既知の値。 |
| KnownKeyExportEncryptionAlgorithm |
サービスが受け入れる KeyExportEncryptionAlgorithm の既知の値。 |
| KnownKeyOperations |
サービスが受け入れる KeyOperation の既知の値。 |
| KnownKeyTypes |
サービスが受け入れる の <xref:JsonWebKeyType> 既知の値。 |
| KnownSignatureAlgorithms |
サービスが受け入れる の <xref: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。