SecretClient Classe

Eseguire il backup di un segreto in un modulo protetto utilizzabile solo da Azure Key Vault. Richiede l'autorizzazione segreti/backup.

backup_secret(name: str, **kwargs) -> bytes

Parametri

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Eliminare tutte le versioni di un segreto. Richiede l'autorizzazione segreti/eliminazione.

Quando questo metodo restituisce Key Vault ha iniziato a eliminare il segreto. L'eliminazione può richiedere diversi secondi in un insieme di credenziali con eliminazione temporanea abilitata. Questo metodo restituisce quindi un poller che consente di attendere il completamento dell'eliminazione.

begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]

Parametri

Restituisce

Un poller per l'operazione di eliminazione. Il metodo risultato del poller restituisce l'oggetto senza attendere il DeletedSecret completamento dell'eliminazione. Se l'insieme di credenziali ha abilitato l'eliminazione temporanea e si vuole eliminare definitivamente il segreto con purge_deleted_secret, chiamare prima il metodo di attesa del poller. Verrà bloccato fino al completamento dell'eliminazione. Il metodo wait richiede segreti/ottenere l'autorizzazione.

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Recuperare un segreto eliminato nella versione più recente. Possibile solo in un insieme di credenziali con eliminazione temporanea abilitata.

Richiede l'autorizzazione segreti/ripristino. Se l'insieme di credenziali non ha abilitato l'eliminazione temporanea, begin_delete_secret è permanente e questo metodo restituirà un errore. Il tentativo di ripristinare un segreto non eliminato restituirà anche un errore. Quando questo metodo restituisce Key Vault ha iniziato a recuperare il segreto. Il ripristino può richiedere diversi secondi. Questo metodo restituisce quindi un poller che consente di attendere il completamento del ripristino. L'attesa è necessaria solo quando si vuole usare il segreto recuperato in un'altra operazione immediatamente.

begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]

Parametri

Restituisce

Un poller per l'operazione di ripristino. Il metodo risultato del poller restituisce il segreto SecretProperties recuperato senza attendere il completamento del ripristino. Se si vuole usare immediatamente il segreto recuperato, chiamare il metodo di attesa del poller, che blocca fino a quando il segreto non è pronto per l'uso. Il metodo wait richiede segreti/ottenere l'autorizzazione.

Tipo restituito

Eccezioni

Chiudere i socket aperti dal client.

La chiamata a questo metodo non è necessaria quando si usa il client come gestione contesto.

close() -> None

Eccezioni

se il segreto non esiste,

per altri errori

Ottenere un segreto eliminato. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata. Richiede segreti/ottenere l'autorizzazione.

get_deleted_secret(name: str, **kwargs) -> DeletedSecret

Parametri

Tipo restituito

Eccezioni

se il segreto eliminato non esiste,

per altri errori

Ottenere un segreto. richiede l'autorizzazione secrets/get.

get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret

Parametri

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Elenca tutti i segreti eliminati. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata.

Richiede l'autorizzazione segreti/elenco.

list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]

Restituisce

Iteratore di segreti eliminati, esclusi i relativi valori

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Elencare le proprietà di tutte le versioni di un segreto, escluse le relative proprietà. Richiede l'autorizzazione segreti/elenco.

Gli elementi dell'elenco non includono valori segreti. Usare get_secret per ottenere il valore di un segreto.

list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]

Parametri

Restituisce

Iteratore di segreti, esclusi i valori

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Elencare identificatori e attributi di tutti i segreti nell'insieme di credenziali. Richiede l'autorizzazione segreti/elenco.

Gli elementi dell'elenco non includono valori segreti. Usare get_secret per ottenere il valore di un segreto.

list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]

Restituisce

Iteratore di segreti, esclusi i valori

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Elimina definitivamente un segreto eliminato. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata.

Esegue un'eliminazione irreversibile del segreto specificato, senza possibilità di ripristino. L'operazione non è disponibile se non recovery_level specifica "Purgeable". Questo metodo è necessario solo per eliminare un segreto prima del relativo scheduled_purge_date.

Richiede l'autorizzazione di rimozione/segreti.

purge_deleted_secret(name: str, **kwargs) -> None

Parametri

Restituisce

Nessuno

Eccezioni

Esempio

   # if the vault has soft-delete enabled, purge permanently deletes the secret
   # (with soft-delete disabled, begin_delete_secret is permanent)
   secret_client.purge_deleted_secret("secret-name")

Ripristinare un segreto di backup. Richiede l'autorizzazione segreti/ripristino.

restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties

Parametri

Restituisce

Segreto ripristinato

Tipo restituito

Eccezioni

se il nome del segreto è già in uso,

per altri errori

Esegue una richiesta di rete usando la pipeline esistente del client.

L'URL della richiesta può essere relativo all'URL dell'insieme di credenziali. La versione dell'API del servizio usata per la richiesta è uguale a quella del client, a meno che non sia specificato in altro modo. Questo metodo non genera se la risposta è un errore; per generare un'eccezione, chiamare raise_for_status() nell'oggetto risposta restituito. Per altre informazioni su come inviare richieste personalizzate con questo metodo, vedere https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parametri

Restituisce

Risposta della chiamata di rete. Non esegue la gestione degli errori nella risposta.

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori

Impostare un valore segreto. Se il nome è in uso, creare una nuova versione del segreto. In caso contrario, creare un nuovo segreto.

Richiede l'autorizzazione segreti/set.

set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret

Parametri

Tipo restituito

Eccezioni

Aggiornare le proprietà di un segreto diverso dal relativo valore. Richiede l'autorizzazione segreti/set.

Questo metodo aggiorna le proprietà del segreto, ad esempio se è abilitato, ma non può modificare il valore del segreto. Usare set_secret per modificare il valore del segreto.

update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties

Parametri

Tipo restituito

Eccezioni

se il segreto non esiste,

per altri errori