@azure/keyvault-secrets package

SecretClient fournit des méthodes pour gérer KeyVaultSecret dans Azure Key Vault. 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 description de KeyVaultSecrets. Le client prend également en charge la description DeletedSecret pour une suppression réversible d’Azure Key Vault.

Options de <xref:backupSecretOptions>.

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

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

Interface représentant un secret KeyVault supprimé.

Options de getDeletedSecret(string, GetDeletedSecretOptions).

Options de getSecret(string, GetSecretOptions).

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

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

Options de listDeletedSecrets(ListDeletedSecretsOptions).

Options de listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Options de listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

Interface qui suit les paramètres de l’itération paginée

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

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

Bien 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, PollOperationState documente l’état de l’opération de longue durée distante.

Elle doit être mise à jour au moins au démarrage de l’opération, quand elle est terminée et quand elle est annulée. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour par d’autres raisons.

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

Options de purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Options de restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Paramètres facultatifs acceptés par keyClient de KeyVault

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

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

Options de setSecret(string, string, SetSecretOptions).

Options de updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention.
KnownDeletionRecoveryLevel pouvez être utilisé de manière interchangeable avec DeleteRecoveryLevel, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

purgeable : désigne un état de coffre dans lequel la suppression est irréversible, sans possibilité de récupération. Ce niveau correspond à aucune protection disponible contre une opération De suppression ; les données sont irrécupérablement perdues lors de l’acceptation d’une opération Delete au niveau de l’entité ou supérieure (coffre, groupe de ressources, abonnement, etc.)
récupérable+purgeable: indique un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (c’est-à-dire purger). 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 si l’abonnement est annulé. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré
récupérable : désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger). 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 supprime définitivement après 90 jours, s’il n’est pas récupéré
récupérable+ProtectedSubscription: indique un coffre et un état 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 la suppression définitive) n’est pas autorisée, et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré
CustomRecoverable+Purgeable: indique un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (c’est-à-dire purger 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 si l’abonnement est annulé.
CustomRecoverable: indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant la disponibilité de l’abonnement.
CustomRecoverable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable, immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée et dans laquelle 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é.

Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention.

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

https://< nom-keyvault.vault.azure.net/secrets/<> nom-secret>/<identifiant-version-unique>

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>"
  }