EchoVib

A high-level interface for managing a vault’s secrets.

• vault_url (str) – URL of the vault the client will access. This is also called the vault’s “DNS Name”.

• credential – An object which can provide an access token for the vault, such as a credential from azure.identity

• api_version (str) – version of the Key Vault API to use. Defaults to the most recent.

• transport (HttpTransport) – transport to use. Defaults to RequestsTransport.

Example

 from azure.identity import DefaultAzureCredential from azure.keyvault.secrets import SecretClient # Create a SecretClient using default Azure credentials credentials = DefaultAzureCredential() secret_client = SecretClient(vault_url, credentials) 

Back up a secret in a protected form useable only by Azure Key Vault. Requires secrets/backup permission.

name (str) – Name of the secret to back up

bytes

ResourceNotFoundError if the secret doesn’t exist, HttpResponseError for other errors

Example

# backup secret # returns the raw bytes of the backed up secret secret_backup = secret_client.backup_secret("secret-name") print(secret_backup) 

Delete all versions of a secret. Requires secrets/delete permission.

When this method returns Key Vault has begun deleting the secret. Deletion may take several seconds in a vault with soft-delete enabled. This method therefore returns a poller enabling you to wait for deletion to complete.

name (str) – Name of the secret to delete.

A poller for the delete operation. The poller’s result method returns the DeletedSecret without waiting for deletion to complete. If the vault has soft-delete enabled and you want to permanently delete the secret with purge_deleted_secret(), call the poller’s wait method first. It will block until the deletion is complete. The wait method requires secrets/get permission.

LROPoller[DeletedSecret]

ResourceNotFoundError if the secret doesn’t exist, HttpResponseError for other errors

Example

 # delete a secret deleted_secret_poller = secret_client.begin_delete_secret("secret-name") deleted_secret = deleted_secret_poller.result() print(deleted_secret.name) # if the vault has soft-delete enabled, the secret's, deleted_date # scheduled purge date and recovery id are set print(deleted_secret.deleted_date) print(deleted_secret.scheduled_purge_date) print(deleted_secret.recovery_id) # if you want to block until secret is deleted server-side, call wait() on the poller deleted_secret_poller.wait() 

Recover a deleted secret to its latest version. Possible only in a vault with soft-delete enabled.

If the vault does not have soft-delete enabled, begin_delete_secret() is permanent, and this method will return an error. Attempting to recover a non-deleted secret will also return an error.

When this method returns Key Vault has begun recovering the secret. Recovery may take several seconds. This method therefore returns a poller enabling you to wait for recovery to complete. Waiting is only necessary when you want to use the recovered secret in another operation immediately.

Requires the secrets/recover permission.

name (str) – Name of the deleted secret to recover

A poller for the recovery operation. The poller’s result method returns the recovered Secret without waiting for recovery to complete. If you want to use the recovered secret immediately, call the poller’s wait method, which blocks until the secret is ready to use. The wait method requires secrets/get permission.

LROPoller[SecretProperties]

HttpResponseError

Example

 # recover deleted secret to the latest version recover_secret_poller = secret_client.begin_recover_deleted_secret("secret-name") recovered_secret = recover_secret_poller.result() print(recovered_secret.id) print(recovered_secret.name) # if you want to block until secret is recovered server-side, call wait() on the poller recover_secret_poller.wait() 

Get a deleted secret. Possible only in vaults with soft-delete enabled. Requires secrets/get permission.

name (str) – Name of the deleted secret

DeletedSecret

ResourceNotFoundError if the deleted secret doesn’t exist, HttpResponseError for other errors

Example

# gets a deleted secret (requires soft-delete enabled for the vault) deleted_secret = secret_client.get_deleted_secret("secret-name") print(deleted_secret.name) 

Get a secret. Requires the secrets/get permission.

• name (str) – The name of the secret

• version (str) – (optional) Version of the secret to get. If unspecified, gets the latest version.

KeyVaultSecret

ResourceNotFoundError if the secret doesn’t exist, HttpResponseError for other errors

Example

 # get the latest version of a secret secret = secret_client.get_secret("secret-name") # alternatively, specify a version secret = secret_client.get_secret("secret-name", secret.properties.version) print(secret.id) print(secret.name) print(secret.properties.version) print(secret.properties.vault_url) 

Lists all deleted secrets. Possible only in vaults with soft-delete enabled.

Requires secrets/list permission.

An iterator of deleted secrets, excluding their values

ItemPaged[DeletedSecret]

Example

 # gets an iterator of deleted secrets (requires soft-delete enabled for the vault) deleted_secrets = secret_client.list_deleted_secrets() for secret in deleted_secrets: # the list doesn't include values or versions of the deleted secrets print(secret.id) print(secret.name) print(secret.scheduled_purge_date) print(secret.recovery_id) print(secret.deleted_date) 

List properties of all versions of a secret, excluding their values. Requires secrets/list permission.

List items don’t include secret values. Use get_secret() to get a secret’s value.

name (str) – Name of the secret

An iterator of secrets, excluding their values

ItemPaged[SecretProperties]

Example

secret_versions = secret_client.list_properties_of_secret_versions("secret-name") for secret in secrets: # the list doesn't include the values at each version print(secret.id) print(secret.enabled) print(secret.updated_on) 

List identifiers and attributes of all secrets in the vault. Requires secrets/list permission.

List items don’t include secret values. Use get_secret() to get a secret’s value.

An iterator of secrets, excluding their values

ItemPaged[SecretProperties]

Example

 # list secrets secrets = secret_client.list_properties_of_secrets() for secret in secrets: # the list doesn't include values or versions of the secrets print(secret.id) print(secret.name) print(secret.enabled) 

Permanently delete a secret. Possible only in vaults with soft-delete enabled.

If the vault doesn’t have soft-delete enabled, begin_delete_secret() permanently deletes the secret, and this method will return an error.

Requires secrets/purge permission.

name (str) – Name of the secret to purge

None

HttpResponseError

Example

# 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 a backed up secret. Requires the secrets/restore permission.

backup (bytes) – A secret backup as returned by backup_secret()

The restored secret

SecretProperties

ResourceExistsError if the secret’s name is already in use, HttpResponseError for other errors

Example

 # restores a backed up secret restored_secret = secret_client.restore_secret_backup(secret_backup) print(restored_secret.id) print(restored_secret.version) 

Set a secret value. If name is in use, create a new version of the secret. If not, create a new secret.

Requires secrets/set permission.

• name (str) – The name of the secret

• value (str) – The value of the secret

• enabled (bool) – Whether the secret is enabled for use.

• tags (dict[str, str]) – Application specific metadata in the form of key-value pairs.

• content_type (str) – An arbitrary string indicating the type of the secret, e.g. ‘password’

• not_before (datetime) – Not before date of the secret in UTC

• expires_on (datetime) – Expiry date of the secret in UTC

KeyVaultSecret

HttpResponseError

Example

from dateutil import parser as date_parse expires_on = date_parse.parse("2050-02-02T08:00:00.000Z") # create a secret, setting optional arguments secret = secret_client.set_secret("secret-name", "secret-value", expires_on=expires_on) print(secret.name) print(secret.properties.version) print(secret.properties.expires_on) 

Update properties of a secret other than its value. Requires secrets/set permission.

This method updates properties of the secret, such as whether it’s enabled, but can’t change the secret’s value. Use set_secret() to change the secret’s value.

• name (str) – Name of the secret

• version (str) – (optional) Version of the secret to update. If unspecified, the latest version is updated.

• enabled (bool) – Whether the secret is enabled for use.

• tags (dict[str, str]) – Application specific metadata in the form of key-value pairs.

• content_type (str) – An arbitrary string indicating the type of the secret, e.g. ‘password’

• not_before (datetime) – Not before date of the secret in UTC

• expires_on (datetime) – Expiry date of the secret in UTC

SecretProperties

ResourceNotFoundError if the secret doesn’t exist, HttpResponseError for other errors

Example

 # update attributes of an existing secret content_type = "text/plain" tags = {"foo": "updated tag"} updated_secret_properties = secret_client.update_secret_properties( "secret-name", content_type=content_type, tags=tags ) print(updated_secret_properties.version) print(updated_secret_properties.updated_on) print(updated_secret_properties.content_type) print(updated_secret_properties.tags) 

All of a secret’s properties, and its value.

The secret’s id

str

The secret’s name

str

The secret’s properties

SecretProperties

The secret’s value

str

A secret’s id and attributes.

An arbitrary string indicating the type of the secret

str

When the secret was created, in UTC

datetime

Whether the secret is enabled for use

bool

When the secret expires, in UTC

datetime

The secret’s id

str

If this secret backs a certificate, this property is the identifier of the corresponding key.

str

The secret’s name

str

The time before which the secret can not be used, in UTC

datetime

The vault’s deletion recovery level for secrets

str

Application specific metadata in the form of key-value pairs

dict

When the secret was last updated, in UTC

datetime

URL of the vault containing the secret

str

The secret’s version

str

A deleted secret’s properties and information about its deletion. If soft-delete is enabled, returns information about its recovery as well.

When the secret was deleted, in UTC

datetime

The secret’s id

str

The secret’s name

str

The properties of the deleted secret

SecretProperties

An identifier used to recover the deleted secret. Returns None if soft-delete is disabled.

str

When the secret is scheduled to be purged, in UTC. Returns None if soft-delete is disabled.

datetime

Subpackages¶

ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnploqKmptbC6jpqxrqqVYrimxdWarKWsXaiypL7ErapobF5le3F7wLOsq51eoLK6wsCuo61mo5qws7HTrGWhrJ2h