@azure/keyvault-keys package
クラス
| CryptographyClient |
Azure Key Vault キーまたはローカル <xref:JsonWebKey>に対して暗号化操作を実行するために使用されるクライアント。 |
| KeyClient |
KeyClient には、Azure Key Vault で <xref:KeyVaultKey> を管理するメソッドが用意されています。 クライアントは、KeyVaultKeys の作成、取得、更新、削除、消去、バックアップ、復元、一覧表示をサポートしています。 クライアントでは、論理的な削除が有効な Azure Key Vault の <xref:DeletedKey> の一覧表示もサポートされています。 |
インターフェイス
| AesCbcDecryptParameters |
AES-CBC 暗号化アルゴリズムの復号化パラメーター。 |
| AesCbcEncryptParameters |
AES-CBC 暗号化アルゴリズムの暗号化パラメーター。 |
| AesGcmDecryptParameters |
AES-GCM 暗号化アルゴリズムの復号化パラメーター。 |
| AesGcmEncryptParameters |
AES-GCM 暗号化アルゴリズムの暗号化パラメーター。 |
| BackupKeyOptions |
<xref:backupKey>のオプション。 |
| BeginDeleteKeyOptions |
<xref:beginDeleteKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| BeginRecoverDeletedKeyOptions |
<xref:beginRecoverDeletedKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CreateEcKeyOptions |
<xref:createEcKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CreateKeyOptions |
<xref:createKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CreateOctKeyOptions |
<xref:createOctKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CreateRsaKeyOptions |
<xref:createRsaKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CryptographyClientOptions |
KeyVault の CryptographyClient で受け入れられる省略可能なパラメーター |
| CryptographyOptions |
暗号化 API メソッドのオプションを表すインターフェイスについては、<xref:CryptographyClient> を参照してください。 |
| DecryptOptions |
<xref:decrypt>のオプション。 |
| DecryptResult |
<xref:decrypt> 操作の結果。 |
| DeletedKey |
削除された Key Vault キーを表すインターフェイス。 |
| EncryptOptions |
<xref:encrypt>のオプション。 |
| EncryptResult |
<xref:encrypt> 操作の結果。 |
| GetDeletedKeyOptions |
<xref:getDeletedKey>のオプション。 |
| GetKeyOptions |
<xref:getKey>のオプション。 |
| ImportKeyOptions |
<xref:importKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| JsonWebKey |
http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 時点 |
| KeyClientOptions |
KeyVault の KeyClient で受け入れられる省略可能なパラメーター |
| KeyPollerOptions |
<xref:beginDeleteKey> および <xref:beginRecoverDeletedKey> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| KeyProperties |
<xref:KeyVaultKey> のプロパティを表すインターフェイス |
| KeyVaultKey |
Key Vault キーを表すインターフェイス。名前、値、<xref:KeyProperties>。 |
| KeyVaultKeyIdentifier |
Key Vault キー ID を構成するセグメントを表します。 |
| ListDeletedKeysOptions |
<xref:listDeletedKeys>に渡される KeyClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| ListPropertiesOfKeyVersionsOptions |
<xref:listPropertiesOfKeyVersions>に渡される KeyClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| ListPropertiesOfKeysOptions |
<xref:listPropertiesOfKeys>に渡される KeyClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| PurgeDeletedKeyOptions |
<xref:purgeDeletedKey>のオプション。 |
| RestoreKeyBackupOptions |
<xref:restoreKeyBackup>のオプション。 |
| RsaDecryptParameters |
RSA 暗号化アルゴリズムの復号化パラメーター。 |
| RsaEncryptParameters |
RSA 暗号化アルゴリズムの暗号化パラメーター。 |
| SignOptions |
<xref:sign>のオプション。 |
| SignResult |
<xref:sign> 操作の結果。 |
| UnwrapKeyOptions |
<xref:unwrapKey>のオプション。 |
| UnwrapResult |
<xref:unwrap> 操作の結果。 |
| UpdateKeyPropertiesOptions |
<xref:updateKeyProperties>のオプション。 |
| VerifyDataOptions |
<xref:verifyData> のオプション |
| VerifyOptions |
<xref:verify>のオプション。 |
| VerifyResult |
<xref:verify> 操作の結果。 |
| WrapKeyOptions |
<xref:wrapKey>のオプション。 |
| WrapResult |
<xref:wrap> 操作の結果。 |
型エイリアス
| AesCbcEncryptionAlgorithm |
サポートされているすべての AES-CBC 暗号化アルゴリズムを表す共用体の種類。 |
| AesGcmEncryptionAlgorithm |
サポートされているすべての AES-GCM 暗号化アルゴリズムを表す共用体の種類。 |
| DecryptParameters |
さまざまな暗号化アルゴリズムに適用される現在サポートされているすべての復号化パラメーターを表す型。 |
| DeletionRecoveryLevel |
DeletionRecoveryLevel の値を定義します。 サービスでサポートされている値を把握する
消去可能な: 削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。 このレベルは、削除操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます |
| EncryptParameters |
さまざまな暗号化アルゴリズムに適用される現在サポートされているすべての暗号化パラメーターを表す型。 |
| EncryptionAlgorithm |
JsonWebKeyEncryptionAlgorithm の値を定義します。 サービスでサポートされている値を把握するRSA-OAEP の |
| KeyCurveName |
JsonWebKeyCurveName の値を定義します。 サービスでサポートされている値を把握する
P-256: NIST P-256 楕円曲線、AKA SECG 曲線SECP256R1。 |
| KeyOperation |
JsonWebKeyOperation の値を定義します。 サービスでサポートされている値を把握する
暗号化する |
| KeyType |
JsonWebKeyType の値を定義します。 サービスでサポートされている値を把握する
EC: 楕円曲線 |
| KeyWrapAlgorithm |
キーラッピング/ラップ解除でサポートされているアルゴリズム |
| RsaEncryptionAlgorithm |
サポートされているすべての RSA 暗号化アルゴリズムを表す共用体の種類。 |
| SignatureAlgorithm |
JsonWebKeySignatureAlgorithm の値を定義します。 サービスでサポートされている値を把握する
PS256: SHA-256 および MGF1 と SHA-256 を使用した RSASSA-PSS(https://tools.ietf.org/html/rfc7518 |
列挙型
| KnownDeletionRecoveryLevel |
サービスが受け入れる <xref:DeletionRecoveryLevel> の既知の値。 |
| KnownEncryptionAlgorithms |
サービスが受け入れる <xref:JsonWebKeyEncryptionAlgorithm> の既知の値。 |
| KnownKeyCurveNames |
サービスが受け入れる <xref:JsonWebKeyCurveName> の既知の値。 |
| KnownKeyOperations |
サービスが受け入れる <xref:JsonWebKeyOperation> の既知の値。 |
| KnownKeyTypes |
サービスが受け入れる <xref:JsonWebKeyType> の既知の値。 |
| KnownSignatureAlgorithms |
サービスが受け入れる <xref:JsonWebKeySignatureAlgorithm> の既知の値。 |
関数
| parse |
指定された Key Vault キー ID を解析します。たとえば、https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id です。> 上記の ID を解析すると、この関数は次を返します。 |
関数の詳細
parseKeyVaultKeyIdentifier(string)
指定された Key Vault キー ID を解析します。たとえば、https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id です。>
上記の 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)パラメーター
- id
-
string
Key Vault キーの ID。
