SecretClient class

Crea un'istanza di SecretClient.

Esempio di utilizzo:

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)

Parametri

URL di base dell'insieme di credenziali

vaultUrl: string

Valore della proprietà

Richiede che un backup del segreto specificato venga scaricato nel client. Tutte le versioni del segreto verranno scaricate. Questa operazione richiede l'autorizzazione segreti/backup.

Esempio di utilizzo:

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

Esegue il backup del segreto specificato.

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

Parametri

Restituisce

Elimina un segreto archiviato in Azure Key Vault. Questa funzione restituisce un poller di operazione long running che consente di attendere in modo indefinito fino all'eliminazione del segreto.

Questa operazione richiede l'autorizzazione segreti/eliminazione.

Esempio di utilizzo:

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);

Elimina un segreto da un insieme di credenziali delle chiavi specificato.

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

Parametri

Restituisce

Recupera il segreto eliminato nell'insieme di credenziali specificato. Questa funzione restituisce un poller di operazione long running che consente di attendere in modo indefinito fino a quando il segreto non viene ripristinato.

Questa operazione richiede l'autorizzazione segreti/ripristino.

Esempio di utilizzo:

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);

Recupera il segreto eliminato nella versione più recente.

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

Parametri

Restituisce

Il metodo getDeletedSecret restituisce il segreto eliminato specificato insieme ai relativi attributi. Questa operazione richiede i segreti o ottenere l'autorizzazione.

Esempio di utilizzo:

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

Ottiene il segreto eliminato specificato.

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

Parametri

Restituisce

Il metodo getSecret è applicabile a qualsiasi segreto archiviato in Azure Key Vault. Questa operazione richiede i segreti o ottenere l'autorizzazione.

Esempio di utilizzo:

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

Ottenere un segreto specificato da un determinato insieme di credenziali delle chiavi.

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

Parametri

Restituisce

Consente di eseguire l'iterazione dei segreti eliminati nell'insieme di credenziali. Nella risposta vengono forniti l'identificatore completo del segreto e gli attributi. Non vengono restituiti valori per i segreti. Queste operazioni richiedono l'autorizzazione segreti/elenco.

Esempio di utilizzo:

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

Elencare tutti i segreti nell'insieme di credenziali.

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

Parametri

Restituisce

Scorre la versione più recente di tutti i segreti nell'insieme di credenziali. Nella risposta vengono forniti l'identificatore completo del segreto e gli attributi. Non vengono restituiti valori per i segreti. Queste operazioni richiedono l'autorizzazione segreti/elenco.

Esempio di utilizzo:

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

Elencare tutti i segreti nell'insieme di credenziali.

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

Parametri

Restituisce

Scorre tutte le versioni del segreto specificato nell'insieme di credenziali. Nella risposta vengono forniti l'identificatore completo del segreto e gli attributi. Non vengono restituiti valori per i segreti. Queste operazioni richiedono l'autorizzazione segreti/elenco.

Esempio di utilizzo:

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>

Parametri

Restituisce

L'operazione di eliminazione del segreto eliminato rimuove definitivamente il segreto, senza la possibilità di ripristino. Questa operazione può essere abilitata solo in un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione richiede l'autorizzazione segreti/eliminazione.

Esempio di utilizzo:

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

Elimina definitivamente il segreto specificato.

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

Parametri

Restituisce

Ripristina un segreto di cui è stato eseguito il backup e tutte le relative versioni in un insieme di credenziali. Questa operazione richiede l'autorizzazione segreti/ripristino.

Esempio di utilizzo:

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

Ripristina un segreto di cui è stato eseguito il backup in un insieme di credenziali.

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

Parametri

Restituisce

Il metodo setSecret aggiunge una versione privata o privata al Key Vault di Azure. Se il segreto denominato esiste già, l'insieme di credenziali chiave di Azure ne crea una nuova versione. Questa operazione richiede l'autorizzazione secrets/set.

Esempio di utilizzo:

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

Aggiunge un segreto in un insieme di credenziali delle chiavi specificato.

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

Parametri

Restituisce

Il metodo updateSecret modifica gli attributi specificati di un segreto archiviato esistente. Le proprietà non specificate nella richiesta vengono lasciate invariate. Il valore di un segreto non è di per sé modificabile. Questa operazione richiede l'autorizzazione secrets/set.

Esempio di utilizzo:

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

Aggiornamenti gli attributi associati a un segreto specificato in un determinato insieme di credenziali delle chiavi.

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

Parametri

Restituisce