@azure/keyvault-secrets package

Classes

SecretClient

The SecretClient provides methods to manage <xref:KeyVaultSecret> in the Azure Key Vault. The client supports creating, retrieving, updating, deleting, purging, backing up, restoring and listing KeyVaultSecrets. The client also supports listing <xref:DeletedSecret> for a soft-delete enabled Azure Key Vault.

Interfaces

BackupSecretOptions

Options for <xref:backupSecretOptions>.

BeginDeleteSecretOptions

An interface representing the optional parameters that can be passed to <xref:beginDeleteSecret>

BeginRecoverDeletedSecretOptions

An interface representing the optional parameters that can be passed to <xref:beginRecoverDeletedSecret>

DeletedSecret

An interface representing a deleted KeyVault Secret.

GetDeletedSecretOptions

Options for <xref:getDeletedSecret>.

GetSecretOptions

Options for <xref:getSecret>.

KeyVaultSecret

An interface representing a KeyVault Secret, with its name, value and <xref:SecretProperties>.

ListDeletedSecretsOptions

Options for <xref:listDeletedSecrets>.

ListPropertiesOfSecretVersionsOptions

Options for <xref:listPropertiesOfSecretVersions>.

ListPropertiesOfSecretsOptions

Options for <xref:listPropertiesOfSecrets>.

PurgeDeletedSecretOptions

Options for <xref:purgeDeletedSecret>.

RestoreSecretBackupOptions

Options for <xref:restoreSecretBackup>.

SecretClientOptions

The optional parameters accepted by the KeyVault's KeyClient

SecretPollerOptions

An interface representing the optional parameters that can be passed to <xref:beginDeleteSecret> and <xref:beginRecoverDeletedKey>.

SecretProperties

An interface representing the properties of a <xref:KeyVaultSecret>.

SetSecretOptions

Options for <xref:setSecret>.

UpdateSecretPropertiesOptions

Options for <xref:updateSecretProperties>.

Type Aliases

DeletionRecoveryLevel

Defines values for DeletionRecoveryLevel. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription', 'CustomizedRecoverable+Purgeable', 'CustomizedRecoverable', 'CustomizedRecoverable+ProtectedSubscription'