SecretClient Classe

Interfaccia generale per la gestione dei segreti di un insieme di credenziali.

Ereditarietà

azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

Costruttore

SecretClient(vault_url: str, credential: TokenCredential, **kwargs)

Parametri

vault_url

str

Necessario

URL dell'insieme di credenziali a cui il client accederà. Viene chiamato anche "Nome DNS" dell'insieme di credenziali. È necessario verificare che questo URL faccia riferimento a una risorsa Key Vault valida. Per informazioni dettagliate, vedere https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Necessario

Oggetto che può fornire un token di accesso per l'insieme di credenziali, ad esempio una credenziale da identity

api_version

ApiVersion

Versione dell'API del servizio da usare. Il valore predefinito è quello più recente.

verify_challenge_resource

bool

Se verificare che la risorsa di verifica dell'autenticazione corrisponda al dominio di Key Vault. Impostazione predefinita su True.

Metodi

backup_secret	Eseguire il backup di un segreto in un modulo protetto utilizzabile solo da Azure Key Vault. Richiede l'autorizzazione segreti/backup.
begin_delete_secret	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_recover_deleted_secret	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.
close	Chiudere i socket aperti dal client. La chiamata a questo metodo non è necessaria quando si usa il client come gestione contesto.
get_deleted_secret	Ottenere un segreto eliminato. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata. Richiede segreti/ottenere l'autorizzazione.
get_secret	Ottenere un segreto. richiede l'autorizzazione secrets/get.
list_deleted_secrets	Elenca tutti i segreti eliminati. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata. Richiede l'autorizzazione segreti/elenco.
list_properties_of_secret_versions	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_secrets	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.
purge_deleted_secret	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.
restore_secret_backup	Ripristinare un segreto di backup. Richiede l'autorizzazione segreti/ripristino.
send_request	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.
set_secret	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.
update_secret_properties	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.

backup_secret

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

name

str

Necessario

Nome del segreto da eseguire il backup

Tipo restituito

bytes

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

begin_delete_secret

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

name

str

Necessario

Nome del segreto da eliminare.

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

LROPoller[DeletedSecret]

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

begin_recover_deleted_secret

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

name

str

Necessario

Nome del segreto eliminato da ripristinare

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

LROPoller[SecretProperties]

Eccezioni

HttpResponseError

close

Chiudere i socket aperti dal client.

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

close() -> None

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

get_deleted_secret

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

name

str

Necessario

Nome del segreto eliminato

Tipo restituito

DeletedSecret

Eccezioni

ResourceNotFoundError

se il segreto eliminato non esiste,

HttpResponseError

per altri errori

get_secret

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

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

Parametri

name

str

Necessario

Nome del segreto

version

str

Necessario

(facoltativo) Versione del segreto da ottenere. Se non specificato, ottiene la versione più recente.

Tipo restituito

KeyVaultSecret

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

list_deleted_secrets

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

ItemPaged[DeletedSecret]

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

list_properties_of_secret_versions

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

name

str

Necessario

Nome del segreto

Restituisce

Iteratore di segreti, esclusi i valori

Tipo restituito

ItemPaged[SecretProperties]

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

list_properties_of_secrets

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

ItemPaged[SecretProperties]

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

purge_deleted_secret

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

name

str

Necessario

Nome del segreto eliminato da eliminare

Restituisce

Nessuno

Eccezioni

HttpResponseError

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

restore_secret_backup

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

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

Parametri

backup

bytes

Necessario

Backup segreto restituito da backup_secret

Restituisce

Segreto ripristinato

Tipo restituito

SecretProperties

Eccezioni

ResourceExistsError

se il nome del segreto è già in uso,

HttpResponseError

per altri errori

send_request

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

request

HttpRequest

Necessario

Richiesta di rete da effettuare.

stream

bool

Indica se il payload della risposta verrà trasmesso. Il valore predefinito è False.

Restituisce

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

Tipo restituito

HttpResponse

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

set_secret

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

name

str

Necessario

Nome del segreto

value

str

Necessario

Valore del segreto

enabled

bool

Indica se il segreto è abilitato per l'uso.

tags

Dict[str, str] oppure None

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

content_type

str

Stringa arbitraria che indica il tipo del segreto, ad esempio 'password'

not_before

datetime

Non prima della data del segreto in formato UTC

expires_on

datetime

Data di scadenza del segreto in formato UTC

Tipo restituito

KeyVaultSecret

Eccezioni

HttpResponseError

update_secret_properties

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

name

str

Necessario

Nome del segreto

version

str

Necessario

(facoltativo) Versione del segreto da aggiornare. Se non specificato, la versione più recente viene aggiornata.

enabled

bool

Indica se il segreto è abilitato per l'uso.

tags

Dict[str, str] oppure None

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

content_type

str

Stringa arbitraria che indica il tipo del segreto, ad esempio 'password'

not_before

datetime

Non prima della data del segreto in formato UTC

expires_on

datetime

Data di scadenza del segreto in formato UTC

Tipo restituito

SecretProperties

Eccezioni

ResourceNotFoundError

se il segreto non esiste,

HttpResponseError

per altri errori

Attributi

vault_url