次の方法で共有


@azure/keyvault-keys package

クラス

CryptographyClient

Azure Key Vault キーまたはローカル JsonWebKeyに対して暗号化操作を実行するために使用されるクライアント。

KeyClient

KeyClient には、Azure Key Vault KeyVaultKey を管理するメソッドが用意されています。 クライアントは、KeyVaultKeys の作成、取得、更新、削除、消去、バックアップ、復元、一覧表示をサポートしています。 クライアントでは、論理的な削除が有効な Azure Key Vault の 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

削除された Key Vault キーを表すインターフェイス。

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, 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

キーの有効期間中に Key Vault によって実行されるアクションとそれに対応するトリガー。

KeyRotationPolicy

キーに属する完全なキー ローテーション ポリシー。

KeyRotationPolicyProperties

クライアントが特定のキーに対して設定できるキー ローテーション ポリシーのプロパティ。

また、lifetimeActions を空の配列に設定することで、キー ローテーション ポリシーを既定値にリセットすることもできます。

KeyVaultKey

Key Vault キーを表すインターフェイス。その名前、値、および KeyProperties

KeyVaultKeyIdentifier

Key Vault キー ID を構成するセグメントを表します。

ListDeletedKeysOptions

listDeletedKeys(ListDeletedKeysOptions)に渡される KeyClient ページング操作の省略可能なパラメーターを表すインターフェイス。

ListPropertiesOfKeyVersionsOptions

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)に渡される KeyClient ページング操作の省略可能なパラメーターを表すインターフェイス。

ListPropertiesOfKeysOptions

listPropertiesOfKeys(ListPropertiesOfKeysOptions)に渡される KeyClient ページング操作の省略可能なパラメーターを表すインターフェイス。

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 、DeletionRecoveryLevel と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

消去可能な: 削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。 このレベルは、削除操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます
回復可能+ 消去可能な: 削除が回復可能であり、即時および完全な削除 (消去) を許可するコンテナーの状態を示します。 このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、リテンション期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。 システムは、90日後に完全に削除します(回復されていない場合)
回復可能な: 即時および永続的な削除 (消去) を行わずに削除が回復可能なコンテナーの状態を示します。 このレベルでは、リテンション期間 (90 日) の間、およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。 システムは、90日後に完全に削除します(回復されていない場合)
Recoverable+ProtectedSubscription: コンテナーとサブスクリプションの状態を示します。この状態では、リテンション期間内 (90 日間)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができません。 システムは、90日後に完全に削除します(回復されていない場合)
CustomizedRecoverable+Purgeable: 削除が回復可能であり、即時および永続的な削除を許可するコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。 このレベルでは、消去操作が要求されていないか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。
CustomizedRecoverable: 即時および永続的な削除を行わずに削除を回復できるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。
CustomizedRecoverable+ProtectedSubscription: 削除が回復可能で即時かつ完全な削除 (消去) が許可されず、7<= SoftDeleteRetentionInDays < 90 の場合にサブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。 このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。

EncryptParameters

さまざまな暗号化アルゴリズムに適用される現在サポートされているすべての暗号化パラメーターを表す型。

EncryptionAlgorithm

JsonWebKeyEncryptionAlgorithm の値を定義します。
jsonWebKeyEncryptionAlgorithm と同じ意味で使用できる <xref:KnownJsonWebKeyEncryptionAlgorithm>、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

RSA-OAEP の
RSA-OAEP-256

RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

KeyCurveName

JsonWebKeyCurveName の値を定義します。
jsonWebKeyCurveName と同じ意味で使用できる <xref:KnownJsonWebKeyCurveName>、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

P-256: NIST P-256 楕円曲線、AKA SECG 曲線SECP256R1。
P-384: NIST P-384 楕円曲線、別名 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 の値を定義します。
jsonWebKeyOperation と同じ意味で使用できる <xref:KnownJsonWebKeyOperation>、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

暗号化する
復号化
sign
確認する
wrapKey
する
unwrapKey
する
インポートする
エクスポート

KeyRotationPolicyAction

実行されるアクション。

KeyType

JsonWebKeyType の値を定義します。
jsonWebKeyType と同じ意味で使用できる <xref:KnownJsonWebKeyType>、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

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 の値を定義します。
jsonWebKeySignatureAlgorithm と同じ意味で使用できる <xref:KnownJsonWebKeySignatureAlgorithm>、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

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: https://tools.ietf.org/html/rfc7518 で説明されているように、SHA-256 を使用した RSASSA-PKCS1-v1_5
RS384: SHA-384 を使用した RSASSA-PKCS1-v1_5(https://tools.ietf.org/html/rfc7518
RS512: https://tools.ietf.org/html/rfc7518 で説明されているように、SHA-512 を使用した RSASSA-PKCS1-v1_5
RSNULL: 予約済み
ES256: https://tools.ietf.org/html/rfc7518で説明されているように、P-256 および SHA-256 を使用した ECDSA。
ES384: P-384 および SHA-384 を使用した ECDSA (https://tools.ietf.org/html/rfc7518
ES512: https://tools.ietf.org/html/rfc7518 で説明されているように、P-521 および SHA-512 を使用した ECDSA
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)

指定された 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>"
  }

関数の詳細

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。

戻り値