Partager via

@azure/keyvault-secrets package

  • Référence

Classes

SecretClient

SecretClient fournit des méthodes pour gérer KeyVaultSecret dans le Key Vault Azure. Le client prend en charge la création, la récupération, la mise à jour, la suppression, la purge, la sauvegarde, la restauration et la liste des KeyVaultSecrets. Le client prend également en charge la liste DeletedSecret pour une suppression réversible d’Azure Key Vault.

Interfaces

BackupSecretOptions

Options pour <xref:backupSecretOptions>.
BeginDeleteSecretOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret

Interface représentant un secret KeyVault supprimé.
GetDeletedSecretOptions

Options pour getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions

Options pour getSecret(string, GetSecretOptions).
KeyVaultSecret

Interface représentant un secret KeyVault, avec son nom, sa valeur et SecretProperties.
KeyVaultSecretIdentifier

Représente les segments qui composent un ID de secret Key Vault.
ListDeletedSecretsOptions

Options pour listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions

Options pour listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions

Options pour listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings

Interface qui effectue le suivi des paramètres de l’itération paginée
PagedAsyncIterableIterator

Interface qui permet l’itération asynchrone itérable à la fois à l’achèvement et par page.
PollOperationState

PollOperationState contient une liste avisée du plus petit ensemble de propriétés nécessaire pour définir un pollueur d’opérations de longue durée.

Alors que la classe Poller fonctionne comme mécanisme de contrôle local pour démarrer le déclenchement, attendre et éventuellement annuler une opération de longue durée, l’état PollOperationState documente l’état de l’opération distante de longue durée.

Elle doit être mise à jour au moins au démarrage de l’opération, à sa fin et à son annulation. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour pour d’autres raisons.
PollerLike

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.
PurgeDeletedSecretOptions

Options pour purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions

Options pour restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions

Paramètres facultatifs acceptés par keyClient de KeyVault
SecretPollerOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteSecret(string, BeginDeleteSecretOptions) et <xref:beginRecoverDeletedKey>.
SecretProperties

Interface représentant les propriétés d’un KeyVaultSecret.
SetSecretOptions

Options pour setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions

Options pour updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Alias de type

DeletionRecoveryLevel

Définit les valeurs de DeletionRecoveryLevel.
KnownDeletionRecoveryLevel peut être utilisé indifféremment avec DeleteRecoveryLevel. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Purgeable : indique un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération De suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération de suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Récupérable+Purgeable : désigne un état de coffre dans lequel la suppression est récupérable, et qui autorise également la suppression immédiate et définitive (c’est-à-dire le vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de vidage est demandée ou que l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Récupérable : indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Récupérable+ProtectedSubscription : indique un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
CustomizedRecoverable+Purgeable : désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également la suppression immédiate et définitive (par exemple, le vidage lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de vidage est demandée ou que l’abonnement est annulé.
CustomizedRecoverable : indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, purge quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription : indique un état de coffre et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.

Énumérations

KnownDeletionRecoveryLevel

Valeurs connues de DeletionRecoveryLevel que le service accepte.

Functions

parseKeyVaultSecretIdentifier(string)

Analyse l’ID de secret Key Vault donné. Voici un exemple :

https://.vault.azure.net/secrets//

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

Informations relatives à la fonction

parseKeyVaultSecretIdentifier(string)

Analyse l’ID de secret Key Vault donné. Voici un exemple :

https://.vault.azure.net/secrets//

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Paramètres

id

string

ID du secret Key Vault.

Retours

KeyVaultSecretIdentifier