SecretClient Classe

Uma interface de alto nível para gerir os segredos de um cofre.

Herança

azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

Construtor

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

Parâmetros

vault_url

str

Necessário

URL do cofre ao qual o cliente irá aceder. Também se chama "Nome DNS" do cofre. Deve validar que este URL faz referência a um recurso Key Vault válido. Veja https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential

TokenCredential

Necessário

Um objeto que pode fornecer um token de acesso para o cofre, como uma credencial de identity

api_version

ApiVersion

Versão da API de serviço a utilizar. A predefinição é a mais recente.

verify_challenge_resource

bool

A verificação do recurso de desafio de autenticação corresponde ao domínio Key Vault. Predefinições para Verdadeiro.

Métodos

backup_secret	Crie uma cópia de segurança de um segredo num formulário protegido utilizável apenas pelo Azure Key Vault. Requer permissões de segredos/cópias de segurança.
begin_delete_secret	Elimine todas as versões de um segredo. Requer permissões de segredos/eliminação. Quando este método devolve Key Vault começou a eliminar o segredo. A eliminação pode demorar vários segundos num cofre com a eliminação recuperável ativada. Por conseguinte, este método devolve um poller que lhe permite aguardar que a eliminação seja concluída.
begin_recover_deleted_secret	Recuperar um segredo eliminado para a versão mais recente. Só é possível num cofre com a eliminação recuperável ativada. Requer os segredos/permissão de recuperação. Se o cofre não tiver a eliminação recuperável ativada, begin_delete_secret será permanente e este método devolverá um erro. Tentar recuperar um segredo não eliminado também devolverá um erro. Quando este método devolve Key Vault começou a recuperar o segredo. A recuperação pode demorar vários segundos. Por conseguinte, este método devolve um poller que lhe permite aguardar pela conclusão da recuperação. A espera só é necessária quando pretender utilizar o segredo recuperado noutra operação imediatamente.
close	Feche os sockets abertos pelo cliente. Chamar este método é desnecessário ao utilizar o cliente como um gestor de contexto.
get_deleted_secret	Obtenha um segredo eliminado. Só é possível em cofres com a eliminação recuperável ativada. Requer segredos/obter permissão.
get_secret	Obtenha um segredo. Requer os segredos/obter permissão.
list_deleted_secrets	Lista todos os segredos eliminados. Só é possível em cofres com a eliminação recuperável ativada. Requer permissão de segredos/lista.
list_properties_of_secret_versions	Liste as propriedades de todas as versões de um segredo, excluindo os respetivos valores. Requer permissão de segredos/lista. Os itens de lista não incluem valores secretos. Utilize get_secret para obter o valor de um segredo.
list_properties_of_secrets	Listar identificadores e atributos de todos os segredos no cofre. Requer permissão de segredos/lista. Os itens de lista não incluem valores secretos. Utilize get_secret para obter o valor de um segredo.
purge_deleted_secret	Elimina permanentemente um segredo eliminado. Só é possível em cofres com a eliminação recuperável ativada. Efetua uma eliminação irreversível do segredo especificado, sem possibilidade de recuperação. A operação não está disponível se não recovery_level especificar "Purgável". Este método só é necessário para remover um segredo antes do respetivo scheduled_purge_date. Requer permissões de remoção/segredos.
restore_secret_backup	Restaure um segredo de cópia de segurança. Requer a permissão segredos/restauro.
send_request	Executa um pedido de rede com o pipeline existente do cliente. O URL do pedido pode ser relativo ao URL do cofre. A versão da API de serviço utilizada para o pedido é igual à do cliente, salvo especificação em contrário. Este método não aumenta se a resposta for um erro; para gerar uma exceção, chame raise_for_status() no objeto de resposta devolvido. Para obter mais informações sobre como enviar pedidos personalizados com este método, consulte https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	Defina um valor secreto. Se o nome estiver a ser utilizado, crie uma nova versão do segredo. Caso contrário, crie um novo segredo. Requer permissões de segredos/conjuntos.
update_secret_properties	Atualize as propriedades de um segredo que não seja o respetivo valor. Requer permissões de segredos/conjuntos. Este método atualiza as propriedades do segredo, como se está ativado, mas não pode alterar o valor do segredo. Utilize set_secret para alterar o valor do segredo.

backup_secret

Crie uma cópia de segurança de um segredo num formulário protegido utilizável apenas pelo Azure Key Vault. Requer permissões de segredos/cópias de segurança.

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

Parâmetros

name

str

Necessário

Nome do segredo para fazer uma cópia de segurança

Tipo de retorno

bytes

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

begin_delete_secret

Elimine todas as versões de um segredo. Requer permissões de segredos/eliminação.

Quando este método devolve Key Vault começou a eliminar o segredo. A eliminação pode demorar vários segundos num cofre com a eliminação recuperável ativada. Por conseguinte, este método devolve um poller que lhe permite aguardar que a eliminação seja concluída.

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

Parâmetros

name

str

Necessário

Nome do segredo a eliminar.

Devoluções

Um poller para a operação de eliminação. O método de resultado do poller devolve o DeletedSecret sem aguardar que a eliminação seja concluída. Se o cofre tiver a eliminação recuperável ativada e quiser eliminar permanentemente o segredo com purge_deleted_secret, chame primeiro o método de espera do poller. Bloqueará até a eliminação estar concluída. O método de espera requer segredos/obter permissão.

Tipo de retorno

LROPoller[DeletedSecret]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

begin_recover_deleted_secret

Recuperar um segredo eliminado para a versão mais recente. Só é possível num cofre com a eliminação recuperável ativada.

Requer os segredos/permissão de recuperação. Se o cofre não tiver a eliminação recuperável ativada, begin_delete_secret será permanente e este método devolverá um erro. Tentar recuperar um segredo não eliminado também devolverá um erro. Quando este método devolve Key Vault começou a recuperar o segredo. A recuperação pode demorar vários segundos. Por conseguinte, este método devolve um poller que lhe permite aguardar pela conclusão da recuperação. A espera só é necessária quando pretender utilizar o segredo recuperado noutra operação imediatamente.

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

Parâmetros

name

str

Necessário

Nome do segredo eliminado a recuperar

Devoluções

Um poller para a operação de recuperação. O método de resultado do poller devolve os segredos SecretProperties recuperados sem aguardar que a recuperação seja concluída. Se quiser utilizar o segredo recuperado imediatamente, chame o método de espera do poller, que bloqueia até que o segredo esteja pronto para ser utilizado. O método de espera requer segredos/obter permissão.

Tipo de retorno

LROPoller[SecretProperties]

Exceções

HttpResponseError

close

Feche os sockets abertos pelo cliente.

Chamar este método é desnecessário ao utilizar o cliente como um gestor de contexto.

close() -> None

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

get_deleted_secret

Obtenha um segredo eliminado. Só é possível em cofres com a eliminação recuperável ativada. Requer segredos/obter permissão.

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

Parâmetros

name

str

Necessário

Nome do segredo eliminado

Tipo de retorno

DeletedSecret

Exceções

ResourceNotFoundError

se o segredo eliminado não existir,

HttpResponseError

para outros erros

get_secret

Obtenha um segredo. Requer os segredos/obter permissão.

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

Parâmetros

name

str

Necessário

O nome do segredo

version

str

Necessário

(opcional) Versão do segredo a obter. Se não for especificado, obtém a versão mais recente.

Tipo de retorno

KeyVaultSecret

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

list_deleted_secrets

Lista todos os segredos eliminados. Só é possível em cofres com a eliminação recuperável ativada.

Requer permissão de segredos/lista.

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

Devoluções

Um iterador de segredos eliminados, excluindo os respetivos valores

Tipo de retorno

ItemPaged[DeletedSecret]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

list_properties_of_secret_versions

Liste as propriedades de todas as versões de um segredo, excluindo os respetivos valores. Requer permissão de segredos/lista.

Os itens de lista não incluem valores secretos. Utilize get_secret para obter o valor de um segredo.

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

Parâmetros

name

str

Necessário

Nome do segredo

Devoluções

Um iterador de segredos, excluindo os respetivos valores

Tipo de retorno

ItemPaged[SecretProperties]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

list_properties_of_secrets

Listar identificadores e atributos de todos os segredos no cofre. Requer permissão de segredos/lista.

Os itens de lista não incluem valores secretos. Utilize get_secret para obter o valor de um segredo.

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

Devoluções

Um iterador de segredos, excluindo os respetivos valores

Tipo de retorno

ItemPaged[SecretProperties]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

purge_deleted_secret

Elimina permanentemente um segredo eliminado. Só é possível em cofres com a eliminação recuperável ativada.

Efetua uma eliminação irreversível do segredo especificado, sem possibilidade de recuperação. A operação não está disponível se não recovery_level especificar "Purgável". Este método só é necessário para remover um segredo antes do respetivo scheduled_purge_date.

Requer permissões de remoção/segredos.

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

Parâmetros

name

str

Necessário

Nome do segredo eliminado a remover

Devoluções

Nenhuma

Exceções

HttpResponseError

Exemplos

   # 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

Restaure um segredo de cópia de segurança. Requer a permissão segredos/restauro.

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

Parâmetros

backup

bytes

Necessário

Uma cópia de segurança secreta, conforme devolvido por backup_secret

Devoluções

O segredo restaurado

Tipo de retorno

SecretProperties

Exceções

ResourceExistsError

se o nome do segredo já estiver a ser utilizado,

HttpResponseError

para outros erros

send_request

Executa um pedido de rede com o pipeline existente do cliente.

O URL do pedido pode ser relativo ao URL do cofre. A versão da API de serviço utilizada para o pedido é igual à do cliente, salvo especificação em contrário. Este método não aumenta se a resposta for um erro; para gerar uma exceção, chame raise_for_status() no objeto de resposta devolvido. Para obter mais informações sobre como enviar pedidos personalizados com este método, consulte https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parâmetros

request

HttpRequest

Necessário

O pedido de rede que pretende fazer.

stream

bool

Se o payload de resposta será transmitido em fluxo. Predefinições para Falso.

Devoluções

A resposta da chamada de rede. Não efetua o processamento de erros na resposta.

Tipo de retorno

HttpResponse

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

set_secret

Defina um valor secreto. Se o nome estiver a ser utilizado, crie uma nova versão do segredo. Caso contrário, crie um novo segredo.

Requer permissões de segredos/conjuntos.

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

Parâmetros

name

str

Necessário

O nome do segredo

value

str

Necessário

O valor do segredo

enabled

bool

Se o segredo está ativado para utilização.

tags

Dict[str, str] ou None

Metadados específicos da aplicação na forma de pares chave-valor.

content_type

str

Uma cadeia arbitrária que indica o tipo do segredo, por exemplo, "palavra-passe"

not_before

datetime

Não antes da data do segredo em UTC

expires_on

datetime

Data de expiração do segredo em UTC

Tipo de retorno

KeyVaultSecret

Exceções

HttpResponseError

update_secret_properties

Atualize as propriedades de um segredo que não seja o respetivo valor. Requer permissões de segredos/conjuntos.

Este método atualiza as propriedades do segredo, como se está ativado, mas não pode alterar o valor do segredo. Utilize set_secret para alterar o valor do segredo.

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

Parâmetros

name

str

Necessário

Nome do segredo

version

str

Necessário

(opcional) Versão do segredo a atualizar. Se não for especificado, a versão mais recente é atualizada.

enabled

bool

Se o segredo está ativado para utilização.

tags

Dict[str, str] ou None

Metadados específicos da aplicação na forma de pares chave-valor.

content_type

str

Uma cadeia arbitrária que indica o tipo do segredo, por exemplo, "palavra-passe"

not_before

datetime

Não antes da data do segredo em UTC

expires_on

datetime

Data de expiração do segredo em UTC

Tipo de retorno

SecretProperties

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

Atributos

vault_url