@azure/keyvault-keys package
Classes
| CryptographyClient |
A client used to perform cryptographic operations with Azure Key Vault keys. |
| KeyClient |
The KeyClient provides methods to manage <xref:KeyVaultKey> in the Azure Key Vault. The client supports creating, retrieving, updating, deleting, purging, backing up, restoring and listing KeyVaultKeys. The client also supports listing <xref:DeletedKey> for a soft-delete enabled Azure Key Vault. |
Interfaces
| BackupKeyOptions |
Options for <xref:backupKey>. |
| BeginDeleteKeyOptions |
An interface representing the optional parameters that can be passed to <xref:beginDeleteKey> |
| BeginRecoverDeletedKeyOptions |
An interface representing the optional parameters that can be passed to <xref:beginRecoverDeletedKey> |
| CreateEcKeyOptions |
An interface representing the optional parameters that can be passed to <xref:createEcKey> |
| CreateKeyOptions |
An interface representing the optional parameters that can be passed to <xref:createKey> |
| CreateRsaKeyOptions |
An interface representing the optional parameters that can be passed to <xref:createRsaKey> |
| CryptographyClientOptions |
The optional parameters accepted by the KeyVault's CryptographyClient |
| CryptographyOptions |
An interface representing the options of the cryptography API methods, go to the <xref:CryptographyClient> for more information. |
| DecryptOptions |
Options for <xref:decrypt>. |
| DecryptResult |
Result of the <xref:decrypt> operation. |
| DeletedKey |
An interface representing a deleted KeyVault Key. |
| EncryptOptions |
Options for <xref:encrypt>. |
| EncryptResult |
Result of the <xref:encrypt> operation. |
| GetDeletedKeyOptions |
Options for <xref:getDeletedKey>. |
| GetKeyOptions |
Options for <xref:getKey>. |
| ImportKeyOptions |
An interface representing the optional parameters that can be passed to <xref:importKey> |
| JsonWebKey |
As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
The optional parameters accepted by the KeyVault's KeyClient |
| KeyPollerOptions |
An interface representing the optional parameters that can be passed to <xref:beginDeleteKey> and <xref:beginRecoverDeletedKey> |
| KeyProperties |
An interface representing the Properties of <xref:KeyVaultKey> |
| KeyVaultKey |
An interface representing a KeyVault Key, with its name, value and <xref:KeyProperties>. |
| ListDeletedKeysOptions |
An interface representing optional parameters for KeyClient paged operations passed to <xref:listDeletedKeys>. |
| ListPropertiesOfKeyVersionsOptions |
An interface representing optional parameters for KeyClient paged operations passed to <xref:listPropertiesOfKeyVersions>. |
| ListPropertiesOfKeysOptions |
An interface representing optional parameters for KeyClient paged operations passed to <xref:listPropertiesOfKeys>. |
| PurgeDeletedKeyOptions |
Options for <xref:purgeDeletedKey>. |
| RestoreKeyBackupOptions |
Options for <xref:restoreKeyBackup>. |
| SignOptions |
Options for <xref:sign>. |
| SignResult |
Result of the <xref:sign> operation. |
| UnwrapKeyOptions |
Options for <xref:unwrapKey>. |
| UnwrapResult |
Result of the <xref:unwrap> operation. |
| UpdateKeyPropertiesOptions |
Options for <xref:updateKeyProperties>. |
| VerifyOptions |
Options for <xref:verify>. |
| VerifyResult |
Result of the <xref:verify> operation. |
| WrapKeyOptions |
Options for <xref:wrapKey>. |
| WrapResult |
Result of the <xref:wrap> operation. |
Type Aliases
| DeletionRecoveryLevel |
Defines values for DeletionRecoveryLevel. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription', 'CustomizedRecoverable+Purgeable', 'CustomizedRecoverable', 'CustomizedRecoverable+ProtectedSubscription' |
| EncryptionAlgorithm |
Defines values for EncryptionAlgorithm. Possible values include: 'RSA-OAEP', 'RSA-OAEP-256', 'RSA1_5' |
| KeyCurveName |
Defines values for KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K' |
| KeyOperation |
Defines values for KeyOperation. Possible values include: 'encrypt', 'decrypt', 'sign', 'verify', 'wrapKey', 'unwrapKey', 'import' |
| KeyType |
Defines values for KeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' |
| KeyWrapAlgorithm |
Supported algorithms for key wrapping/unwrapping |
| SignatureAlgorithm |
Defines values for SignatureAlgorithm. Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'ES256K' |