SecretClient Classe

Uma interface de alto nível para gerenciar 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

Obrigatório

URL do cofre que o cliente acessará. Isso também é chamado de "Nome DNS" do cofre. Você deve validar se essa URL faz referência a um recurso de Key Vault válido. Para obter detalhes, consulte https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Obrigató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 ser usada. O padrão é o mais recente.

verify_challenge_resource

bool

Se o recurso de desafio de autenticação deve ser verificado corresponde ao domínio Key Vault. O padrão é True.

Métodos

backup_secret	Faça backup de um segredo em um formulário protegido utilizável somente pelo Key Vault do Azure. Requer permissão de backup/segredos.
begin_delete_secret	Exclua todas as versões de um segredo. Requer permissão de segredos/exclusão. Quando esse método retorna Key Vault começou a excluir o segredo. A exclusão pode levar vários segundos em um cofre com a exclusão reversível habilitada. Portanto, esse método retorna um poller que permite aguardar a conclusão da exclusão.
begin_recover_deleted_secret	Recupere um segredo excluído para sua versão mais recente. Possível somente em um cofre com exclusão reversível habilitada. Requer a permissão de recuperação/segredos. Se o cofre não tiver a exclusão reversível habilitada, begin_delete_secret será permanente e esse método retornará um erro. A tentativa de recuperar um segredo não excluído também retornará um erro. Quando esse método retorna Key Vault começou a recuperar o segredo. A recuperação pode levar vários segundos. Portanto, esse método retorna um poller que permite aguardar a conclusão da recuperação. A espera só é necessária quando você deseja usar o segredo recuperado em outra operação imediatamente.
close	Feche soquetes abertos pelo cliente. Chamar esse método é desnecessário ao usar o cliente como um gerenciador de contexto.
get_deleted_secret	Obter um segredo excluído. Possível somente em cofres com exclusão reversível habilitada. Requer permissão de obtenção/segredos.
get_secret	Obtenha um segredo. requer a permissão de segredos/obter.
list_deleted_secrets	Lista todos os segredos excluídos. Possível somente em cofres com exclusão reversível habilitada. Requer permissão de segredos/lista.
list_properties_of_secret_versions	Listar propriedades de todas as versões de um segredo, excluindo seus valores. Requer permissão de segredos/lista. Os itens de lista não incluem valores secretos. Use 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. Use get_secret para obter o valor de um segredo.
purge_deleted_secret	Exclui permanentemente um segredo excluído. Possível somente em cofres com exclusão reversível habilitada. Executa uma exclusão irreversível do segredo especificado, sem possibilidade de recuperação. A operação não estará disponível se o recovery_level não especificar "Purgável". Esse método só é necessário para limpar um segredo antes de seu scheduled_purge_date. Requer permissão de segredos/limpeza.
restore_secret_backup	Restaure um segredo de backup. Requer a permissão de restauração/segredos.
send_request	Executa uma solicitação de rede usando o pipeline existente do cliente. A URL de solicitação pode ser relativa à URL do cofre. A versão da API de serviço usada para a solicitação é a mesma do cliente, a menos que especificado de outra forma. Esse método não será gerado se a resposta for um erro; para gerar uma exceção, chame raise_for_status() no objeto de resposta retornado. Para obter mais informações sobre como enviar solicitações personalizadas com esse método, consulte https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	Defina um valor secreto. Se o nome estiver em uso, crie uma nova versão do segredo. Caso contrário, crie um novo segredo. Requer permissão de segredos/conjunto.
update_secret_properties	Atualize as propriedades de um segredo diferente de seu valor. Requer permissão de segredos/conjunto. Esse método atualiza as propriedades do segredo, como se ele está habilitado, mas não pode alterar o valor do segredo. Use set_secret para alterar o valor do segredo.

backup_secret

Faça backup de um segredo em um formulário protegido utilizável somente pelo Key Vault do Azure. Requer permissão de backup/segredos.

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

Parâmetros

name

str

Obrigatório

Nome do segredo a ser backup

Tipo de retorno

bytes

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

begin_delete_secret

Exclua todas as versões de um segredo. Requer permissão de segredos/exclusão.

Quando esse método retorna Key Vault começou a excluir o segredo. A exclusão pode levar vários segundos em um cofre com a exclusão reversível habilitada. Portanto, esse método retorna um poller que permite aguardar a conclusão da exclusão.

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

Parâmetros

name

str

Obrigatório

O nome do segredo a ser excluído.

Retornos

Um sondador para a operação de exclusão. O método de resultado do poller retorna o DeletedSecret sem aguardar a conclusão da exclusão. Se o cofre tiver a exclusão reversível habilitada e você quiser excluir permanentemente o segredo com purge_deleted_secret, chame o método de espera do poller primeiro. Ele será bloqueado até que a exclusão seja concluída. O método de espera requer permissão de obtenção/segredos.

Tipo de retorno

LROPoller[DeletedSecret]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

begin_recover_deleted_secret

Recupere um segredo excluído para sua versão mais recente. Possível somente em um cofre com exclusão reversível habilitada.

Requer a permissão de recuperação/segredos. Se o cofre não tiver a exclusão reversível habilitada, begin_delete_secret será permanente e esse método retornará um erro. A tentativa de recuperar um segredo não excluído também retornará um erro. Quando esse método retorna Key Vault começou a recuperar o segredo. A recuperação pode levar vários segundos. Portanto, esse método retorna um poller que permite aguardar a conclusão da recuperação. A espera só é necessária quando você deseja usar o segredo recuperado em outra operação imediatamente.

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

Parâmetros

name

str

Obrigatório

Nome do segredo excluído a ser recuperado

Retornos

Um sondador para a operação de recuperação. O método de resultado do poller retorna o segredo recuperado sem esperar a conclusão da SecretProperties recuperação. Se você quiser usar o segredo recuperado imediatamente, chame o método de espera do sondador, que bloqueia até que o segredo esteja pronto para uso. O método de espera requer permissão de obtenção/segredos.

Tipo de retorno

LROPoller[SecretProperties]

Exceções

HttpResponseError

close

Feche soquetes abertos pelo cliente.

Chamar esse método é desnecessário ao usar o cliente como um gerenciador de contexto.

close() -> None

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

get_deleted_secret

Obter um segredo excluído. Possível somente em cofres com exclusão reversível habilitada. Requer permissão de obtenção/segredos.

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

Parâmetros

name

str

Obrigatório

Nome do segredo excluído

Tipo de retorno

DeletedSecret

Exceções

ResourceNotFoundError

se o segredo excluído não existir,

HttpResponseError

para outros erros

get_secret

Obtenha um segredo. requer a permissão de segredos/obter.

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

Parâmetros

name

str

Obrigatório

O nome do segredo

version

str

Obrigatório

(opcional) Versão do segredo a ser obtido. Se não for especificado, obterá 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 excluídos. Possível somente em cofres com exclusão reversível habilitada.

Requer permissão de segredos/lista.

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

Retornos

Um iterador de segredos excluídos, excluindo seus valores

Tipo de retorno

ItemPaged[DeletedSecret]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

list_properties_of_secret_versions

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

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

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

Parâmetros

name

str

Obrigatório

Nome do segredo

Retornos

Um iterador de segredos, excluindo seus 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. Use get_secret para obter o valor de um segredo.

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

Retornos

Um iterador de segredos, excluindo seus valores

Tipo de retorno

ItemPaged[SecretProperties]

Exceções

ResourceNotFoundError

se o segredo não existir,

HttpResponseError

para outros erros

purge_deleted_secret

Exclui permanentemente um segredo excluído. Possível somente em cofres com exclusão reversível habilitada.

Executa uma exclusão irreversível do segredo especificado, sem possibilidade de recuperação. A operação não estará disponível se o recovery_level não especificar "Purgável". Esse método só é necessário para limpar um segredo antes de seu scheduled_purge_date.

Requer permissão de segredos/limpeza.

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

Parâmetros

name

str

Obrigatório

Nome do segredo excluído a ser limpo

Retornos

Nenhum

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 backup. Requer a permissão de restauração/segredos.

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

Parâmetros

backup

bytes

Obrigatório

Um backup secreto conforme retornado por backup_secret

Retornos

O segredo restaurado

Tipo de retorno

SecretProperties

Exceções

ResourceExistsError

se o nome do segredo já estiver em uso,

HttpResponseError

para outros erros

send_request

Executa uma solicitação de rede usando o pipeline existente do cliente.

A URL de solicitação pode ser relativa à URL do cofre. A versão da API de serviço usada para a solicitação é a mesma do cliente, a menos que especificado de outra forma. Esse método não será gerado se a resposta for um erro; para gerar uma exceção, chame raise_for_status() no objeto de resposta retornado. Para obter mais informações sobre como enviar solicitações personalizadas com esse método, consulte https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parâmetros

request

HttpRequest

Obrigatório

A solicitação de rede que você deseja fazer.

stream

bool

Se o conteúdo da resposta será transmitido. Usa False como padrão.

Retornos

A resposta da sua chamada de rede. Não faz tratamento de erros em sua 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 em uso, crie uma nova versão do segredo. Caso contrário, crie um novo segredo.

Requer permissão de segredos/conjunto.

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

Parâmetros

name

str

Obrigatório

O nome do segredo

value

str

Obrigatório

O valor do segredo

enabled

bool

Se o segredo está habilitado para uso.

tags

Dict[str, str] ou None

Metadados específicos do aplicativo na forma de pares chave-valor.

content_type

str

Uma cadeia de caracteres arbitrária que indica o tipo do segredo, por exemplo, 'password'

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 diferente de seu valor. Requer permissão de segredos/conjunto.

Esse método atualiza as propriedades do segredo, como se ele está habilitado, mas não pode alterar o valor do segredo. Use set_secret para alterar o valor do segredo.

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

Parâmetros

name

str

Obrigatório

Nome do segredo

version

str

Obrigatório

(opcional) Versão do segredo a ser atualizado. Se não for especificado, a versão mais recente será atualizada.

enabled

bool

Se o segredo está habilitado para uso.

tags

Dict[str, str] ou None

Metadados específicos do aplicativo na forma de pares chave-valor.

content_type

str

Uma cadeia de caracteres arbitrária que indica o tipo do segredo, por exemplo, 'password'

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