CertificateClient Classe

Uma interface de alto nível para gerenciar certificados de um cofre.

Herança

azure.keyvault.certificates._shared.client_base.KeyVaultClientBase

CertificateClient

Construtor

CertificateClient(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_certificate	Faça backup de um certificado em um formulário protegido utilizável somente pelo Azure Key Vault. Requer permissão de backup/certificados. Isso se destina a permitir a cópia de um certificado de um cofre para outro. Ambos os cofres devem pertencer à mesma assinatura do Azure. Além disso, o backup/restauração não pode ser executado entre limites geopolíticos. Por exemplo, um backup de um cofre em uma região dos EUA não pode ser restaurado para um cofre em uma região da UE.
begin_create_certificate	Cria um certificado. Se essa for a primeira versão, o recurso de certificado será criado. Esta operação requer permissão de certificados/criar. Aguardar o sondador retornado requer a permissão de obtenção/certificados e fornecerá o certificado se a criação for bem-sucedida ou a CertificateOperation se não for – caso contrário, ele gerará um HttpResponseError.
begin_delete_certificate	Exclua todas as versões de um certificado. Requer permissão de certificados/exclusão. Quando esse método retorna Key Vault começou a excluir o certificado. A exclusão pode levar vários segundos em um cofre com a exclusão reversível habilitada. Portanto, esse método retorna um sondador, permitindo que você aguarde a conclusão da exclusão.
begin_recover_deleted_certificate	Recupere um certificado excluído para sua versão mais recente. Possível somente em um cofre com exclusão reversível habilitada. Requer certificados/permissão de recuperação. Quando esse método retorna Key Vault começou a recuperar o certificado. A recuperação pode levar vários segundos. Portanto, esse método retorna um sondador, permitindo que você aguarde a conclusão da recuperação. Aguardar só é necessário quando você deseja usar o certificado recuperado em outra operação imediatamente.
cancel_certificate_operation	Cancela uma operação de certificado em andamento. Requer a permissão de certificados/atualização.
close	Feche soquetes abertos pelo cliente. Chamar esse método é desnecessário ao usar o cliente como um gerenciador de contexto.
create_issuer	Define o emissor do certificado especificado. Requer a permissão certificates/setissuers.
delete_certificate_operation	Exclui e interrompe a operação de criação de um certificado específico. Requer a permissão de certificados/atualização.
delete_contacts	Exclui os contatos de certificado do cofre de chaves. Requer a permissão certificates/managecontacts.
delete_issuer	Exclui o emissor do certificado especificado. Requer a permissão certificates/manageissuers/deleteissuers.
get_certificate	Obtém um certificado com sua política de gerenciamento anexada. Requer permissão de obtenção/certificados. Não aceita a versão do certificado como um parâmetro. Para obter uma versão específica do certificado, chame get_certificate_version.
get_certificate_operation	Obtém a operação de criação de um certificado. Requer a permissão de obtenção/certificados.
get_certificate_policy	Obtém a política de um certificado. Requer permissão de obtenção/certificados. Retorna os recursos de política de certificado especificados no cofre de chaves.
get_certificate_version	Obtém uma versão específica de um certificado sem retornar sua política de gerenciamento. Requer permissão de obtenção/certificados. Para obter a versão mais recente do certificado ou para obter a política do certificado também, chame get_certificate.
get_contacts	Obtém os contatos de certificado para o cofre de chaves. Requer a permissão certificates/managecontacts.
get_deleted_certificate	Obter um certificado excluído. Possível somente em um cofre com exclusão reversível habilitada. Requer permissão de obtenção/certificados. Recupera as informações de certificado excluídas mais seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual.
get_issuer	Obtém o emissor do certificado especificado. Requer a permissão certificates/manageissuers/getissuers.
import_certificate	Importar um certificado criado externamente. Requer certificados/permissão de importação. Importa um certificado válido existente, contendo uma chave privada, para o Azure Key Vault. O certificado a ser importado deve estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deverá conter a chave, bem como certificados x509, e você deverá fornecer um policy com content_type de pem.
list_deleted_certificates	Lista os certificados excluídos atualmente recuperáveis. Possível somente se o cofre estiver habilitado para exclusão reversível. Requer a permissão certificates/get/list. Recupera os certificados no cofre atual que estão em um estado excluído e prontos para recuperação ou limpeza. Essa operação inclui informações específicas de exclusão.
list_properties_of_certificate_versions	Liste os identificadores e as propriedades das versões de um certificado. Requer permissão de certificados/lista.
list_properties_of_certificates	Listar identificadores e propriedades de todos os certificados no cofre. Requer permissão de certificados/lista.
list_properties_of_issuers	Lista as propriedades dos emissores de certificado para o cofre de chaves. Requer a permissão certificates/manageissuers/getissuers.
merge_certificate	Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor. requer a permissão certificates/create. Executa a mesclagem de um certificado ou cadeia de certificados com um par de chaves atualmente disponível no serviço. Certifique-se de que, ao criar o certificado a ser mesclado usando begin_create_certificate , você defina seu emissor como 'Desconhecido'. Dessa forma, Key Vault sabe que o certificado não será assinado por um emissor conhecido por ele.
purge_deleted_certificate	Exclui permanentemente um certificado excluído. Possível somente em cofres com exclusão reversível habilitada. Requer certificados/permissão de limpeza. Executa uma exclusão irreversível do certificado especificado, sem a possibilidade de recuperação. A operação não estará disponível se o recovery_level não especificar 'Purgeable'. Esse método só é necessário para limpar um certificado antes de seu scheduled_purge_date.
restore_certificate_backup	Restaure um backup de certificado para o cofre. Requer permissão de certificados/restauração. Isso restaura todas as versões do certificado, com seu nome, atributos e políticas de controle de acesso. Se o nome do certificado já estiver em uso, a restauração dele falhará. Além disso, o cofre de destino deve pertencer à mesma assinatura do Microsoft Azure que o cofre de origem.
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_contacts	Define os contatos de certificado para o cofre de chaves. Requer permissão de certificados/managecontacts.
update_certificate_policy	Atualizações a política de um certificado. Requer certificados/permissão de atualização. Defina os membros especificados na política de certificado. Deixa outros como nulos.
update_certificate_properties	Altere as propriedades de um certificado. Requer certificados/permissão de atualização.
update_issuer	Atualizações o emissor do certificado especificado. Requer permissão de certificados/setissuers.

backup_certificate

Faça backup de um certificado em um formulário protegido utilizável somente pelo Azure Key Vault.

Requer permissão de backup/certificados. Isso se destina a permitir a cópia de um certificado de um cofre para outro. Ambos os cofres devem pertencer à mesma assinatura do Azure. Além disso, o backup/restauração não pode ser executado entre limites geopolíticos. Por exemplo, um backup de um cofre em uma região dos EUA não pode ser restaurado para um cofre em uma região da UE.

backup_certificate(certificate_name: str, **kwargs) -> bytes

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

Retornos

O blob de backup que contém o certificado de backup.

Tipo de retorno

bytes

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

begin_create_certificate

Cria um certificado.

Se essa for a primeira versão, o recurso de certificado será criado. Esta operação requer permissão de certificados/criar. Aguardar o sondador retornado requer a permissão de obtenção/certificados e fornecerá o certificado se a criação for bem-sucedida ou a CertificateOperation se não for – caso contrário, ele gerará um HttpResponseError.

begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

policy

CertificatePolicy

Obrigatório

A política de gerenciamento do certificado. O assunto ou uma das propriedades de nome alternativo da entidade são necessárias.

enabled

bool

Se o certificado está habilitado para uso.

tags

dict[str, str]

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

Retornos

Um LROPoller para a operação de criação de certificado. Aguardar o poller fornecerá o certificado se a criação for bem-sucedida ou a CertificateOperation, caso contrário.

Tipo de retorno

LROPoller[KeyVaultCertificate,

CertificateOperation]

Exceções

ValueError

se a política de certificado for inválida,

HttpResponseError

para outros erros.

begin_delete_certificate

Exclua todas as versões de um certificado. Requer permissão de certificados/exclusão.

Quando esse método retorna Key Vault começou a excluir o certificado. A exclusão pode levar vários segundos em um cofre com a exclusão reversível habilitada. Portanto, esse método retorna um sondador, permitindo que você aguarde a conclusão da exclusão.

begin_delete_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado a ser excluído.

Retornos

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

Tipo de retorno

LROPoller[DeletedCertificate]

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

begin_recover_deleted_certificate

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

Requer certificados/permissão de recuperação. Quando esse método retorna Key Vault começou a recuperar o certificado. A recuperação pode levar vários segundos. Portanto, esse método retorna um sondador, permitindo que você aguarde a conclusão da recuperação. Aguardar só é necessário quando você deseja usar o certificado recuperado em outra operação imediatamente.

begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado excluído a ser recuperado

Retornos

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

Tipo de retorno

LROPoller[KeyVaultCertificate]

Exceções

HttpResponseError

cancel_certificate_operation

Cancela uma operação de certificado em andamento. Requer a permissão de certificados/atualização.

cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

Retornos

A operação de certificado cancelada

Tipo de retorno

CertificateOperation

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 certificado não existir,

HttpResponseError

para outros erros

create_issuer

Define o emissor do certificado especificado. Requer a permissão certificates/setissuers.

create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuer

Parâmetros

issuer_name

str

Obrigatório

O nome do emissor.

provider

str

Obrigatório

O provedor do emissor.

enabled

bool

Se o emissor está habilitado para uso.

account_id

str

O nome de usuário/nome da conta/id da conta.

password

str

A chave de senha/segredo/conta.

organization_id

str

ID da organização

admin_contacts

list[AdministratorContact]

Entre em contato com os detalhes dos administradores da organização do emissor do certificado.

Retornos

O CertificateIssuer criado

Tipo de retorno

CertificateIssuer

Exceções

HttpResponseError

delete_certificate_operation

Exclui e interrompe a operação de criação de um certificado específico.

Requer a permissão de certificados/atualização.

delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

Retornos

O CertificateOperation excluído

Tipo de retorno

CertificateOperation

Exceções

HttpResponseError

delete_contacts

Exclui os contatos de certificado do cofre de chaves. Requer a permissão certificates/managecontacts.

delete_contacts(**kwargs) -> List[CertificateContact]

Retornos

Os contatos excluídos do cofre de chaves.

Tipo de retorno

list[CertificateContact]

Exceções

HttpResponseError

delete_issuer

Exclui o emissor do certificado especificado.

Requer a permissão certificates/manageissuers/deleteissuers.

delete_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parâmetros

issuer_name

str

Obrigatório

O nome do emissor.

Retornos

CertificateIssuer

Tipo de retorno

CertificateIssuer

Exceções

HttpResponseError

get_certificate

Obtém um certificado com sua política de gerenciamento anexada. Requer permissão de obtenção/certificados.

Não aceita a versão do certificado como um parâmetro. Para obter uma versão específica do certificado, chame get_certificate_version.

get_certificate(certificate_name: str, **kwargs) -> KeyVaultCertificate

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado no cofre fornecido.

Retornos

Uma instância do KeyVaultCertificate

Tipo de retorno

KeyVaultCertificate

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

get_certificate_operation

Obtém a operação de criação de um certificado. Requer a permissão de obtenção/certificados.

get_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

Retornos

O CertificateOperation criado

Tipo de retorno

CertificateOperation

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

get_certificate_policy

Obtém a política de um certificado. Requer permissão de obtenção/certificados.

Retorna os recursos de política de certificado especificados no cofre de chaves.

get_certificate_policy(certificate_name: str, **kwargs) -> CertificatePolicy

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado em um determinado cofre de chaves.

Retornos

A política de certificado

Tipo de retorno

CertificatePolicy

Exceções

HttpResponseError

get_certificate_version

Obtém uma versão específica de um certificado sem retornar sua política de gerenciamento.

Requer permissão de obtenção/certificados. Para obter a versão mais recente do certificado ou para obter a política do certificado também, chame get_certificate.

get_certificate_version(certificate_name: str, version: str, **kwargs) -> KeyVaultCertificate

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado no cofre fornecido.

version

str

Obrigatório

A versão do certificado.

Retornos

Uma instância do KeyVaultCertificate

Tipo de retorno

KeyVaultCertificate

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

get_contacts

Obtém os contatos de certificado para o cofre de chaves. Requer a permissão certificates/managecontacts.

get_contacts(**kwargs) -> List[CertificateContact]

Retornos

Os contatos do certificado para o cofre de chaves.

Tipo de retorno

list[CertificateContact]

Exceções

HttpResponseError

get_deleted_certificate

Obter um certificado excluído. Possível somente em um cofre com exclusão reversível habilitada.

Requer permissão de obtenção/certificados. Recupera as informações de certificado excluídas mais seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual.

get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificate

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

Retornos

O certificado excluído

Tipo de retorno

DeletedCertificate

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

get_issuer

Obtém o emissor do certificado especificado. Requer a permissão certificates/manageissuers/getissuers.

get_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parâmetros

issuer_name

str

Obrigatório

O nome do emissor.

Retornos

O emissor do certificado especificado.

Tipo de retorno

CertificateIssuer

Exceções

ResourceNotFoundError

se o emissor não existir,

HttpResponseError

para outros erros

import_certificate

Importar um certificado criado externamente. Requer certificados/permissão de importação.

Importa um certificado válido existente, contendo uma chave privada, para o Azure Key Vault. O certificado a ser importado deve estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deverá conter a chave, bem como certificados x509, e você deverá fornecer um policy com content_type de pem.

import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificate

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

certificate_bytes

bytes

Obrigatório

Bytes do objeto de certificado a ser importado. Esse certificado precisa conter a chave privada.

enabled

bool

Se o certificado está habilitado para uso.

tags

dict[str, str]

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

password

str

Se a chave privada no certificado passado for criptografada, ela será a senha usada para criptografia.

policy

CertificatePolicy

A política de gerenciamento do certificado. Necessário se estiver importando um certificado de formato PEM, com definido pemcomo content_type .

Retornos

O KeyVaultCertificate importado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

list_deleted_certificates

Lista os certificados excluídos atualmente recuperáveis. Possível somente se o cofre estiver habilitado para exclusão reversível.

Requer a permissão certificates/get/list. Recupera os certificados no cofre atual que estão em um estado excluído e prontos para recuperação ou limpeza. Essa operação inclui informações específicas de exclusão.

list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]

Parâmetros

include_pending

bool

Especifica se os certificados que não são completamente excluídos devem ser incluídos. Disponível somente para versões de API v7.0 e posteriores.

Retornos

Uma instância semelhante a um iterador de DeletedCertificate

Tipo de retorno

ItemPaged[DeletedCertificate]

Exceções

HttpResponseError

list_properties_of_certificate_versions

Liste os identificadores e as propriedades das versões de um certificado.

Requer permissão de certificados/lista.

list_properties_of_certificate_versions(certificate_name: str, **kwargs) -> ItemPaged[CertificateProperties]

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado.

Retornos

Uma instância semelhante a um iterador de CertificateProperties

Tipo de retorno

ItemPaged[CertificateProperties]

Exceções

HttpResponseError

list_properties_of_certificates

Listar identificadores e propriedades de todos os certificados no cofre.

Requer permissão de certificados/lista.

list_properties_of_certificates(**kwargs) -> ItemPaged[CertificateProperties]

Parâmetros

include_pending

bool

Especifica se os certificados que não são completamente provisionados devem ser incluídos. Disponível somente para versões de API v7.0 e posteriores.

Retornos

Uma instância semelhante a um iterador de CertificateProperties

Tipo de retorno

ItemPaged[CertificateProperties]

Exceções

HttpResponseError

list_properties_of_issuers

Lista as propriedades dos emissores de certificado para o cofre de chaves.

Requer a permissão certificates/manageissuers/getissuers.

list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]

Retornos

Uma instância de emissor semelhante a um iterador

Tipo de retorno

ItemPaged[CertificateIssuer]

Exceções

HttpResponseError

merge_certificate

Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor.

requer a permissão certificates/create. Executa a mesclagem de um certificado ou cadeia de certificados com um par de chaves atualmente disponível no serviço. Certifique-se de que, ao criar o certificado a ser mesclado usando begin_create_certificate , você defina seu emissor como 'Desconhecido'. Dessa forma, Key Vault sabe que o certificado não será assinado por um emissor conhecido por ele.

merge_certificate(certificate_name: str, x509_certificates: List[bytes], **kwargs) -> KeyVaultCertificate

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado

x509_certificates

list[bytes]

Obrigatório

O certificado ou a cadeia de certificados a ser mesclada.

enabled

bool ou None

Se o certificado está habilitado para uso.

tags

dict[str, str] ou None

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

Retornos

O certificado mesclado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

purge_deleted_certificate

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

Requer certificados/permissão de limpeza. Executa uma exclusão irreversível do certificado especificado, sem a possibilidade de recuperação. A operação não estará disponível se o recovery_level não especificar 'Purgeable'. Esse método só é necessário para limpar um certificado antes de seu scheduled_purge_date.

purge_deleted_certificate(certificate_name: str, **kwargs) -> None

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

restore_certificate_backup

Restaure um backup de certificado para o cofre. Requer permissão de certificados/restauração.

Isso restaura todas as versões do certificado, com seu nome, atributos e políticas de controle de acesso. Se o nome do certificado já estiver em uso, a restauração dele falhará. Além disso, o cofre de destino deve pertencer à mesma assinatura do Microsoft Azure que o cofre de origem.

restore_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificate

Parâmetros

backup

bytes

Obrigatório

O blob de backup associado a um pacote de certificados.

Retornos

O KeyVaultCertificate restaurado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

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 chamada de rede. Não faz tratamento de erros em sua resposta.

Tipo de retorno

HttpResponse

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

set_contacts

Define os contatos de certificado para o cofre de chaves. Requer permissão de certificados/managecontacts.

set_contacts(contacts: List[CertificateContact], **kwargs) -> List[CertificateContact]

Parâmetros

contacts

list[CertificateContact]

Obrigatório

A lista de contatos para os certificados do cofre.

Retornos

A lista criada de contatos

Tipo de retorno

list[CertificateContact]

Exceções

HttpResponseError

update_certificate_policy

Atualizações a política de um certificado. Requer certificados/permissão de atualização.

Defina os membros especificados na política de certificado. Deixa outros como nulos.

update_certificate_policy(certificate_name: str, policy: CertificatePolicy, **kwargs) -> CertificatePolicy

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado no cofre fornecido.

policy

CertificatePolicy

Obrigatório

A política do certificado.

Retornos

A política de certificado

Tipo de retorno

CertificatePolicy

Exceções

HttpResponseError

update_certificate_properties

Altere as propriedades de um certificado. Requer certificados/permissão de atualização.

update_certificate_properties(certificate_name: str, version: str | None = None, **kwargs) -> KeyVaultCertificate

Parâmetros

certificate_name

str

Obrigatório

O nome do certificado no cofre de chaves fornecido.

version

str

Obrigatório

A versão do certificado.

enabled

bool

Se o certificado está habilitado para uso.

tags

dict[str, str]

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

Retornos

O KeyVaultCertificate atualizado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

update_issuer

Atualizações o emissor do certificado especificado. Requer permissão de certificados/setissuers.

update_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parâmetros

issuer_name

str

Obrigatório

O nome do emissor.

enabled

bool

Se o emissor está habilitado para uso.

provider

str

O provedor do emissor

account_id

str

O nome de usuário/nome de conta/id da conta.

password

str

A chave de senha/segredo/conta.

organization_id

str

ID da organização

admin_contacts

list[AdministratorContact]

Detalhes de contato dos administradores da organização do emissor do certificado

Retornos

O emissor atualizado

Tipo de retorno

CertificateIssuer

Exceções

HttpResponseError

Atributos

vault_url