Partager via

@azure/keyvault-secrets package

  • Référence

Classes

SecretClient

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.

Interfaces

BackupSecretOptions

Options de <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 de getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions

Options de 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 de listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions

Options de listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions

Options de listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings

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

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

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.
PollerLike

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

Options de purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions

Options de 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 de setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions

Options de updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Alias de type

DeletionRecoveryLevel

Définit des valeurs pour DeletionRecoveryLevel.
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é.

É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