@azure/keyvault-secrets package

SecretClient fornisce metodi per gestire KeyVaultSecret in Azure Key Vault. Il client supporta la creazione, il recupero, l'aggiornamento, l'eliminazione, l'eliminazione, il backup, il ripristino e l'elenco di KeyVaultSecrets. Il client supporta anche l'elenco DeletedSecret per un'eliminazione temporanea abilitata per Azure Key Vault.

Opzioni per <xref:backupSecretOptions>.

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginDeleteSecret(string, BeginDeleteSecretOptions)

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Interfaccia che rappresenta un segreto keyvault eliminato.

Opzioni per getDeletedSecret(string, GetDeletedSecretOptions).

Opzioni per getSecret(string, GetSecretOptions).

Interfaccia che rappresenta un segreto KeyVault, con il nome, il valore e SecretProperties.

Rappresenta i segmenti che compongono un ID segreto dell'insieme di credenziali delle chiavi.

Opzioni per listDeletedSecrets(ListDeletedSecretsOptions).

Opzioni per listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Opzioni per listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

Interfaccia che tiene traccia delle impostazioni per l'iterazione di paging

Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.

PollOperationState contiene un elenco di opinioni del set di proprietà più piccolo necessario per definire un poller di operazione a esecuzione prolungata.

Mentre la classe Poller funziona come meccanismo di controllo locale per avviare l'attivazione, attendere e potenzialmente annullare un'operazione a esecuzione prolungata, PollOperationState documenta lo stato dell'operazione a esecuzione prolungata remota.

Deve essere aggiornato almeno all'avvio dell'operazione, al termine dell'operazione e al momento dell'annullamento. Tuttavia, le implementazioni possono avere qualsiasi altro numero di proprietà che possono essere aggiornate da altri motivi.

Rappresentazione astratta di un poller, destinata a esporre solo l'API minima con cui l'utente deve lavorare.

Opzioni per purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Opzioni per restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Parametri facoltativi accettati da KeyClient dell'insieme di credenziali delle chiavi

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginDeleteSecret(string, BeginDeleteSecretOptions) e <xref:beginRecoverDeletedKey>.

Interfaccia che rappresenta le proprietà di un KeyVaultSecret.

Opzioni per setSecret(string, string, SetSecretOptions).

Opzioni per updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Definisce i valori per DeletionRecoveryLevel.
KnownDeletionRecoveryLevel può essere usato in modo intercambiabile con DeletionRecoveryLevel, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

purgeable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è un'operazione irreversibile, senza la possibilità di ripristino. Questo livello corrisponde a nessuna protezione disponibile per un'operazione di eliminazione; i dati vengono persi in modo irreversibile quando si accetta un'operazione di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via)
Ripristinabile+Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato
Ripristinabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato
Recoverable+ProtectedSubscription: indica un insieme di credenziali e uno stato della sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ad esempio l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata in modo permanente. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato
CustomizedRecoverable+Purgeable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente ,ad esempio quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata.
CustomizedRecoverable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio, ripulire quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile.
CustomizedRecoverable+ProtectedSubscription: indica un insieme di credenziali e uno stato di sottoscrizione in cui l'eliminazione è recuperabile, immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e riflette anche il fatto che la sottoscrizione stessa non può essere annullata.

Valori noti di DeletionRecoveryLevel accettati dal servizio.

Analizza l'ID segreto dell'insieme di credenziali delle chiavi specificato. Un esempio è:

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

Durante l'analisi dell'ID precedente, questa funzione restituisce:

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