CertificateClient Classe

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

Retornos

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

Tipo de retorno

Exceções

se o certificado não existir,

para outros erros

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

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

Exceções

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

para outros erros.

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

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

Exceções

se o certificado não existir,

para outros erros

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

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

Exceções

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

Retornos

A operação de certificado cancelada

Tipo de retorno

Exceções

Feche soquetes abertos pelo cliente.

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

close() -> None

Exceções

se o certificado não existir,

para outros erros

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

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

Parâmetros

Retornos

O CertificateIssuer criado

Tipo de retorno

Exceções

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

Retornos

O CertificateOperation excluído

Tipo de retorno

Exceções

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

Exceções

Exclui o emissor do certificado especificado.

Requer a permissão certificates/manageissuers/deleteissuers.

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

Parâmetros

Retornos

CertificateIssuer

Tipo de retorno

Exceções

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

Retornos

Uma instância do KeyVaultCertificate

Tipo de retorno

Exceções

se o certificado não existir,

para outros erros

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

Retornos

O CertificateOperation criado

Tipo de retorno

Exceções

se o certificado não existir,

para outros erros

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

Retornos

A política de certificado

Tipo de retorno

Exceções

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

Retornos

Uma instância do KeyVaultCertificate

Tipo de retorno

Exceções

se o certificado não existir,

para outros erros

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

Exceções

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

Retornos

O certificado excluído

Tipo de retorno

Exceções

se o certificado não existir,

para outros erros

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

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

Parâmetros

Retornos

O emissor do certificado especificado.

Tipo de retorno

Exceções

se o emissor não existir,

para outros erros

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

Retornos

O KeyVaultCertificate importado

Tipo de retorno

Exceções

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

Retornos

Uma instância semelhante a um iterador de DeletedCertificate

Tipo de retorno

Exceções

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

Retornos

Uma instância semelhante a um iterador de CertificateProperties

Tipo de retorno

Exceções

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

Retornos

Uma instância semelhante a um iterador de CertificateProperties

Tipo de retorno

Exceções

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

Exceções

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

Retornos

O certificado mesclado

Tipo de retorno

Exceções

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

Retornos

Nenhum

Tipo de retorno

Exceções

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

Retornos

O KeyVaultCertificate restaurado

Tipo de retorno

Exceções

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

Retornos

A resposta da chamada de rede. Não faz tratamento de erros em sua resposta.

Tipo de retorno

Exceções

se o certificado não existir,

para outros erros

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

Retornos

A lista criada de contatos

Tipo de retorno

Exceções

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

Retornos

A política de certificado

Tipo de retorno

Exceções

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

Retornos

O KeyVaultCertificate atualizado

Tipo de retorno

Exceções

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

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

Parâmetros

Retornos

O emissor atualizado

Tipo de retorno

Exceções