SecretClient class

  • Référence
Paquet:
@azure/keyvault-secrets

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.

Constructeurs

SecretClient(string, TokenCredential, SecretClientOptions)

Crée une instance de SecretClient.

Exemple d’utilisation :

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

Propriétés

vaultUrl

URL de base du coffre

Méthodes

backupSecret(string, BackupSecretOptions)

Demande qu’une sauvegarde du secret spécifié soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/sauvegarde.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Sauvegarde le secret spécifié.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Supprime un secret stocké dans Azure Key Vault. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit supprimé.

Cette opération nécessite l’autorisation secrets/suppression.

Exemple d’utilisation :

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Supprime un secret d’un coffre de clés spécifié.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Récupère le secret supprimé dans le coffre spécifié. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit récupéré.

Cette opération nécessite l’autorisation secrets/récupération.

Exemple d’utilisation :

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Récupère le secret supprimé dans la dernière version.
getDeletedSecret(string, GetDeletedSecretOptions)

La méthode getDeletedSecret retourne le secret supprimé spécifié avec ses attributs. Cette opération nécessite l’autorisation secrets/obtenir.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Obtient le secret supprimé spécifié.
getSecret(string, GetSecretOptions)

La méthode getSecret s’applique à tout secret stocké dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Obtenez un secret spécifié à partir d’un coffre de clés donné.
listDeletedSecrets(ListDeletedSecretsOptions)

Itère les secrets supprimés dans le coffre. L'identificateur et les attributs de la clé secrète complète sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Cette opération nécessite l’autorisation secrets/liste.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Répertorier tous les secrets dans le coffre.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itère la dernière version de tous les secrets du coffre. L'identificateur et les attributs de la clé secrète complète sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Cette opération nécessite l’autorisation secrets/liste.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Répertorier tous les secrets dans le coffre.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itère toutes les versions du secret donné dans le coffre. L'identificateur et les attributs de la clé secrète complète sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Cette opération nécessite l’autorisation secrets/liste.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

L’opération de vidage du secret supprimé supprime le secret définitivement, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé pour la suppression réversible. Cette opération nécessite l’autorisation secrets/vidage.

Exemple d’utilisation :

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Supprime définitivement le secret spécifié.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaure un secret sauvegardé et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation secrets/restauration.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Restaure un secret sauvegardé dans un coffre.
setSecret(string, string, SetSecretOptions)

La méthode setSecret ajoute une version secrète ou secrète au Key Vault Azure. Si la clé secrète nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Cette opération nécessite l’autorisation secrets/set.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Ajoute un secret dans un coffre de clés spécifié.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

La méthode updateSecret modifie les attributs spécifiés d’un secret stocké existant. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d'une clé secrète elle-même ne peut pas être modifiée. Cette opération nécessite l’autorisation secrets/set.

Exemple d’utilisation :

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Mises à jour les attributs associés à un secret spécifié dans un coffre de clés donné.

Détails du constructeur

SecretClient(string, TokenCredential, SecretClientOptions)

Crée une instance de SecretClient.

Exemple d’utilisation :

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

Paramètres

vaultUrl

string

URL de base du coffre. Vous devez vérifier que cette URL fait référence à une ressource Key Vault valide. Pour plus d'informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objet qui implémente l’interface TokenCredential utilisée pour authentifier les demandes adressées au service. Utilisez le @azure/identity package pour créer des informations d’identification qui correspondent à vos besoins.

pipelineOptions
SecretClientOptions

Options de pipeline utilisées pour configurer Key Vault demandes d’API. Omettez ce paramètre pour utiliser la configuration de pipeline par défaut.

Détails de la propriété

vaultUrl

URL de base du coffre

vaultUrl: string

Valeur de propriété

string

Détails de la méthode

backupSecret(string, BackupSecretOptions)

Demande qu’une sauvegarde du secret spécifié soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/sauvegarde.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Sauvegarde le secret spécifié.

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

Paramètres

secretName

string

Nom du secret.

options
BackupSecretOptions

Paramètres facultatifs.

Retours

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Supprime un secret stocké dans Azure Key Vault. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit supprimé.

Cette opération nécessite l’autorisation secrets/suppression.

Exemple d’utilisation :

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Supprime un secret d’un coffre de clés spécifié.

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

Paramètres

name

string

options
BeginDeleteSecretOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Récupère le secret supprimé dans le coffre spécifié. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit récupéré.

Cette opération nécessite l’autorisation secrets/récupération.

Exemple d’utilisation :

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Récupère le secret supprimé dans la dernière version.

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

Paramètres

name

string

options
BeginRecoverDeletedSecretOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

La méthode getDeletedSecret retourne le secret supprimé spécifié avec ses attributs. Cette opération nécessite l’autorisation secrets/obtenir.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Obtient le secret supprimé spécifié.

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

Paramètres

secretName

string

Nom du secret.

options
GetDeletedSecretOptions

Paramètres facultatifs.

Retours

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

La méthode getSecret s’applique à tout secret stocké dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Obtenez un secret spécifié à partir d’un coffre de clés donné.

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

Paramètres

secretName

string

Nom du secret.

options
GetSecretOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Itère les secrets supprimés dans le coffre. L'identificateur et les attributs de la clé secrète complète sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Cette opération nécessite l’autorisation secrets/liste.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Répertorier tous les secrets dans le coffre.

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

Paramètres

options
ListDeletedSecretsOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itère la dernière version de tous les secrets du coffre. L'identificateur et les attributs de la clé secrète complète sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Cette opération nécessite l’autorisation secrets/liste.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Répertorier tous les secrets dans le coffre.

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Paramètres

options
ListPropertiesOfSecretsOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itère toutes les versions du secret donné dans le coffre. L'identificateur et les attributs de la clé secrète complète sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Cette opération nécessite l’autorisation secrets/liste.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Paramètres

secretName

string

Nom du secret pour lequel extraire les versions.

options
ListPropertiesOfSecretVersionsOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

L’opération de vidage du secret supprimé supprime le secret définitivement, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé pour la suppression réversible. Cette opération nécessite l’autorisation secrets/vidage.

Exemple d’utilisation :

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Supprime définitivement le secret spécifié.

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

Paramètres

secretName

string

Nom du secret.

options
PurgeDeletedSecretOptions

Paramètres facultatifs.

Retours

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaure un secret sauvegardé et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation secrets/restauration.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Restaure un secret sauvegardé dans un coffre.

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

Paramètres

secretBundleBackup

Uint8Array

Objet blob de sauvegarde associé à un bundle de secrets.

options
RestoreSecretBackupOptions

Paramètres facultatifs.

Retours

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

La méthode setSecret ajoute une version secrète ou secrète au Key Vault Azure. Si la clé secrète nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Cette opération nécessite l’autorisation secrets/set.

Exemple d’utilisation :

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Ajoute un secret dans un coffre de clés spécifié.

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

Paramètres

secretName

string

Nom du secret.

value

string

Valeur de la clé secrète.

options
SetSecretOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

La méthode updateSecret modifie les attributs spécifiés d’un secret stocké existant. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d'une clé secrète elle-même ne peut pas être modifiée. Cette opération nécessite l’autorisation secrets/set.

Exemple d’utilisation :

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Mises à jour les attributs associés à un secret spécifié dans un coffre de clés donné.

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

Paramètres

secretName

string

Nom du secret.

secretVersion

string

Version du secret.

options
UpdateSecretPropertiesOptions

Paramètres facultatifs.

Retours

Promise<SecretProperties>