CertificateClient Classe

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

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_certificate	Crie uma cópia de segurança de um certificado num formulário protegido utilizável apenas pelo Azure Key Vault. Requer permissões de certificados/cópias de segurança. Isto destina-se a permitir a cópia de um certificado de um cofre para outro. Ambos os cofres têm de ser propriedade da mesma subscrição do Azure. Além disso, não é possível efetuar cópias de segurança/restauro entre limites geopolíticos. Por exemplo, uma cópia de segurança de um cofre numa região dos EUA não pode ser restaurada para um cofre numa região da UE.
begin_create_certificate	Cria um novo certificado. Se esta for a primeira versão, o recurso de certificado é criado. Esta operação requer a permissão certificados/criar. Aguardar pelo poller devolvido requer os certificados/obter permissão e dá-lhe o certificado se a criação for bem-sucedida ou a CertificateOperation, caso contrário, gera um HttpResponseError.
begin_delete_certificate	Elimine todas as versões de um certificado. Requer permissões de certificados/eliminação. Quando este método devolve Key Vault começou a eliminar o certificado. 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_certificate	Recuperar um certificado eliminado para a versão mais recente. Só é possível num cofre com a eliminação recuperável ativada. Requer permissões de certificados/recuperação. Quando este método devolve Key Vault começou a recuperar o certificado. 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 certificado recuperado noutra operação imediatamente.
cancel_certificate_operation	Cancela uma operação de certificado em curso. Requer a permissão de certificados/atualização.
close	Feche os sockets abertos pelo cliente. Chamar este método é desnecessário ao utilizar o cliente como um gestor de contexto.
create_issuer	Define o emissor de certificados especificado. Requer permissões de certificados/setissuers.
delete_certificate_operation	Elimina e interrompe a operação de criação de um certificado específico. Requer a permissão de certificados/atualização.
delete_contacts	Elimina os contactos do certificado do cofre de chaves. Requer a permissão certificados/managecontacts.
delete_issuer	Elimina o emissor de certificados especificado. Requer permissões de certificados/manageissuers/deleteissuers.
get_certificate	Obtém um certificado com a política de gestão anexada. Requer certificados/obter permissão. 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 os certificados/obter permissão.
get_certificate_policy	Obtém a política de um certificado. Requer certificados/obter permissão. Devolve 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 devolver a política de gestão. Requer certificados/obter permissão. Para obter a versão mais recente do certificado ou para obter também a política do certificado, chame get_certificate.
get_contacts	Obtém os contactos do certificado do cofre de chaves. Requer a permissão certificados/managecontacts.
get_deleted_certificate	Obter um certificado eliminado. Só é possível num cofre com a eliminação recuperável ativada. Requer certificados/obter permissão. Obtém as informações do certificado eliminado e os respetivos atributos, como o intervalo de retenção, a eliminação permanente agendada e o nível de recuperação de eliminação atual.
get_issuer	Obtém o emissor de certificados especificado. Requer a permissão certificados/manageissuers/getissuers.
import_certificate	Importar um certificado criado externamente. Requer certificados/permissão de importação. Importa um certificado válido existente, que contém uma chave privada, para o Azure Key Vault. O certificado a importar pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o ficheiro PEM tem de conter a chave, bem como certificados x509, e tem de fornecer um policy com content_type de pem.
list_deleted_certificates	Lista os certificados eliminados atualmente recuperáveis. Só é possível se o cofre estiver ativado para eliminação recuperável. Requer permissões de certificados/get/list. Obtém os certificados no cofre atual que estão num estado eliminado e estão prontos para recuperação ou remoção. Esta operação inclui informações específicas de eliminação.
list_properties_of_certificate_versions	Liste os identificadores e propriedades das versões de um certificado. Requer permissões de certificados/lista.
list_properties_of_certificates	Listar identificadores e propriedades de todos os certificados no cofre. Requer permissões de certificados/lista.
list_properties_of_issuers	Lista as propriedades dos emissores de certificados do cofre de chaves. Requer a permissão certificados/manageissuers/getissuers.
merge_certificate	Intercala um certificado ou uma cadeia de certificados com um par de chaves existente no servidor. Requer os certificados/permissão de criação. Efetua a intercalação 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 para intercalar, begin_create_certificate defina o emissor como "Desconhecido". Desta forma, Key Vault sabe que o certificado não será assinado por um emissor conhecido pelo mesmo.
purge_deleted_certificate	Elimina permanentemente um certificado eliminado. Só é possível em cofres com a eliminação recuperável ativada. Requer certificados/permissão de remoção. Efetua uma eliminação irreversível do certificado especificado, sem possibilidade de recuperação. A operação não está disponível se o recovery_level não especificar "Purgeable". Este método só é necessário para remover um certificado antes do respetivo scheduled_purge_date.
restore_certificate_backup	Restaure uma cópia de segurança de certificados para o cofre. Requer certificados/permissão de restauro. Isto restaura todas as versões do certificado, com o respetivo nome, atributos e políticas de controlo de acesso. Se o nome do certificado já estiver a ser utilizado, o restauro falhará. Além disso, o cofre de destino tem de ser propriedade da mesma subscrição do Microsoft Azure que o cofre de origem.
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 é a mesma do cliente, salvo especificação em contrário. Este método não gera 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_contacts	Define os contactos do certificado para o cofre de chaves. Requer permissões de certificados/managecontacts.
update_certificate_policy	Atualizações a política de um certificado. Requer permissões de certificados/atualização. Defina membros especificados na política de certificados. Deixa os outros como nulos.
update_certificate_properties	Alterar as propriedades de um certificado. Requer permissões de certificados/atualização.
update_issuer	Atualizações o emissor de certificados especificado. Requer permissões de certificados/setissuers.

backup_certificate

Crie uma cópia de segurança de um certificado num formulário protegido utilizável apenas pelo Azure Key Vault.

Requer permissões de certificados/cópias de segurança. Isto destina-se a permitir a cópia de um certificado de um cofre para outro. Ambos os cofres têm de ser propriedade da mesma subscrição do Azure. Além disso, não é possível efetuar cópias de segurança/restauro entre limites geopolíticos. Por exemplo, uma cópia de segurança de um cofre numa região dos EUA não pode ser restaurada para um cofre numa região da UE.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

Devoluções

O blob de cópia de segurança que contém o certificado de cópia de segurança.

Tipo de retorno

bytes

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

begin_create_certificate

Cria um novo certificado.

Se esta for a primeira versão, o recurso de certificado é criado. Esta operação requer a permissão certificados/criar. Aguardar pelo poller devolvido requer os certificados/obter permissão e dá-lhe o certificado se a criação for bem-sucedida ou a CertificateOperation, caso contrário, gera um HttpResponseError.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

policy

CertificatePolicy

Necessário

A política de gestão do certificado. É necessário um assunto ou uma das propriedades de nome alternativo do requerente.

enabled

bool

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

tags

dict[str, str]

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

Devoluções

Um LROPoller para a operação de criação de certificados. A aguardar pelo poller dá-lhe 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

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

Quando este método devolve Key Vault começou a eliminar o certificado. 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_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]

Parâmetros

certificate_name

str

Necessário

O nome do certificado a eliminar.

Devoluções

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

Tipo de retorno

LROPoller[DeletedCertificate]

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

begin_recover_deleted_certificate

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

Requer permissões de certificados/recuperação. Quando este método devolve Key Vault começou a recuperar o certificado. 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 certificado recuperado noutra operação imediatamente.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado eliminado a recuperar

Devoluções

Um poller para a operação de recuperação. O método de resultado do poller devolve o recuperado KeyVaultCertificate sem aguardar que a recuperação seja concluída. Se quiser utilizar o certificado recuperado imediatamente, chame o método de espera do poller, que bloqueia até o certificado estar pronto para ser utilizado. 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 curso. Requer a permissão de certificados/atualização.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

Devoluções

A operação de certificado cancelada

Tipo de retorno

CertificateOperation

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

HttpResponseError

para outros erros

create_issuer

Define o emissor de certificados especificado. Requer permissões de certificados/setissuers.

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

Parâmetros

issuer_name

str

Necessário

O nome do emissor.

provider

str

Necessário

O fornecedor do emissor.

enabled

bool

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

account_id

str

O nome de utilizador/nome da conta/ID da conta.

password

str

A palavra-passe/segredo/chave de conta.

organization_id

str

ID da organização

admin_contacts

list[AdministratorContact]

Detalhes de contacto dos administradores da organização do emissor de certificados.

Devoluções

O CertificateIssuer criado

Tipo de retorno

CertificateIssuer

Exceções

HttpResponseError

delete_certificate_operation

Elimina 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

Necessário

O nome do certificado.

Devoluções

A CertificateOperation eliminada

Tipo de retorno

CertificateOperation

Exceções

HttpResponseError

delete_contacts

Elimina os contactos do certificado do cofre de chaves. Requer a permissão certificados/managecontacts.

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

Devoluções

Os contactos eliminados do cofre de chaves.

Tipo de retorno

list[CertificateContact]

Exceções

HttpResponseError

delete_issuer

Elimina o emissor de certificados especificado.

Requer permissões de certificados/manageissuers/deleteissuers.

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

Parâmetros

issuer_name

str

Necessário

O nome do emissor.

Devoluções

CertificateIssuer

Tipo de retorno

CertificateIssuer

Exceções

HttpResponseError

get_certificate

Obtém um certificado com a política de gestão anexada. Requer certificados/obter permissão.

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

Necessário

O nome do certificado no cofre especificado.

Devoluções

Uma instância de 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 os certificados/obter permissão.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

Devoluções

A CertificateOperation criada

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 certificados/obter permissão.

Devolve 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

Necessário

O nome do certificado num determinado cofre de chaves.

Devoluções

A política de certificados

Tipo de retorno

CertificatePolicy

Exceções

HttpResponseError

get_certificate_version

Obtém uma versão específica de um certificado sem devolver a política de gestão.

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

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado no cofre especificado.

version

str

Necessário

A versão do certificado.

Devoluções

Uma instância de KeyVaultCertificate

Tipo de retorno

KeyVaultCertificate

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

get_contacts

Obtém os contactos do certificado do cofre de chaves. Requer a permissão certificados/managecontacts.

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

Devoluções

Os contactos do certificado do cofre de chaves.

Tipo de retorno

list[CertificateContact]

Exceções

HttpResponseError

get_deleted_certificate

Obter um certificado eliminado. Só é possível num cofre com a eliminação recuperável ativada.

Requer certificados/obter permissão. Obtém as informações do certificado eliminado e os respetivos atributos, como o intervalo de retenção, a eliminação permanente agendada e o nível de recuperação de eliminação atual.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

Devoluções

O certificado eliminado

Tipo de retorno

DeletedCertificate

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

get_issuer

Obtém o emissor de certificados especificado. Requer a permissão certificados/manageissuers/getissuers.

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

Parâmetros

issuer_name

str

Necessário

O nome do emissor.

Devoluções

O emissor de certificados 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, que contém uma chave privada, para o Azure Key Vault. O certificado a importar pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o ficheiro PEM tem de conter a chave, bem como certificados x509, e tem de fornecer um policy com content_type de pem.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

certificate_bytes

bytes

Necessário

Bytes do objeto de certificado a importar. Este certificado tem de conter a chave privada.

enabled

bool

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

tags

dict[str, str]

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

password

str

Se a chave privada no certificado transmitido for encriptada, é a palavra-passe utilizada para encriptação.

policy

CertificatePolicy

A política de gestão do certificado. Necessário se importar um certificado em formato PEM, com content_type definido como pem.

Devoluções

O KeyVaultCertificate importado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

list_deleted_certificates

Lista os certificados eliminados atualmente recuperáveis. Só é possível se o cofre estiver ativado para eliminação recuperável.

Requer permissões de certificados/get/list. Obtém os certificados no cofre atual que estão num estado eliminado e estão prontos para recuperação ou remoção. Esta operação inclui informações específicas de eliminação.

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

Parâmetros

include_pending

bool

Especifica se pretende incluir certificados que não são completamente eliminados. Disponível apenas para versões de API v7.0 e up.

Devoluções

Uma instância semelhante a iterador de DeletedCertificate

Tipo de retorno

ItemPaged[DeletedCertificate]

Exceções

HttpResponseError

list_properties_of_certificate_versions

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

Requer permissões de certificados/lista.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado.

Devoluções

Uma instância semelhante a 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ões de certificados/lista.

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

Parâmetros

include_pending

bool

Especifica se deve incluir certificados que não estão completamente aprovisionados. Disponível apenas para versões de API v7.0 e up.

Devoluções

Uma instância semelhante a iterador de CertificateProperties

Tipo de retorno

ItemPaged[CertificateProperties]

Exceções

HttpResponseError

list_properties_of_issuers

Lista as propriedades dos emissores de certificados do cofre de chaves.

Requer a permissão certificados/manageissuers/getissuers.

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

Devoluções

Uma instância semelhante a iterador de Emissores

Tipo de retorno

ItemPaged[CertificateIssuer]

Exceções

HttpResponseError

merge_certificate

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

Requer os certificados/permissão de criação. Efetua a intercalação 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 para intercalar, begin_create_certificate defina o emissor como "Desconhecido". Desta forma, Key Vault sabe que o certificado não será assinado por um emissor conhecido pelo mesmo.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado

x509_certificates

list[bytes]

Necessário

O certificado ou a cadeia de certificados a intercalar.

enabled

bool ou None

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

tags

dict[str, str] ou None

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

Devoluções

O certificado intercalado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

purge_deleted_certificate

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

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

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

restore_certificate_backup

Restaure uma cópia de segurança de certificados para o cofre. Requer certificados/permissão de restauro.

Isto restaura todas as versões do certificado, com o respetivo nome, atributos e políticas de controlo de acesso. Se o nome do certificado já estiver a ser utilizado, o restauro falhará. Além disso, o cofre de destino tem de ser propriedade da mesma subscrição do Microsoft Azure que o cofre de origem.

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

Parâmetros

backup

bytes

Necessário

O blob de cópia de segurança associado a um pacote de certificados.

Devoluções

O KeyVaultCertificate restaurado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

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 é a mesma do cliente, salvo especificação em contrário. Este método não gera 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 da resposta será transmitido em fluxo. A predefinição é Falso.

Devoluções

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

Tipo de retorno

HttpResponse

Exceções

ResourceNotFoundError

se o certificado não existir,

HttpResponseError

para outros erros

set_contacts

Define os contactos do certificado para o cofre de chaves. Requer permissões de certificados/managecontacts.

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

Parâmetros

contacts

list[CertificateContact]

Necessário

A lista de contactos dos certificados do cofre.

Devoluções

A lista de contactos criada

Tipo de retorno

list[CertificateContact]

Exceções

HttpResponseError

update_certificate_policy

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

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

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado no cofre especificado.

policy

CertificatePolicy

Necessário

A política do certificado.

Devoluções

A política de certificados

Tipo de retorno

CertificatePolicy

Exceções

HttpResponseError

update_certificate_properties

Alterar as propriedades de um certificado. Requer permissões de certificados/atualização.

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

Parâmetros

certificate_name

str

Necessário

O nome do certificado no cofre de chaves especificado.

version

str

Necessário

A versão do certificado.

enabled

bool

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

tags

dict[str, str]

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

Devoluções

O KeyVaultCertificate atualizado

Tipo de retorno

KeyVaultCertificate

Exceções

HttpResponseError

update_issuer

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

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

Parâmetros

issuer_name

str

Necessário

O nome do emissor.

enabled

bool

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

provider

str

O fornecedor do emissor

account_id

str

O nome de utilizador/nome da conta/ID da conta.

password

str

A palavra-passe/segredo/chave de conta.

organization_id

str

ID da organização

admin_contacts

list[AdministratorContact]

Detalhes do contacto dos administradores da organização do emissor de certificados

Devoluções

O emissor atualizado

Tipo de retorno

CertificateIssuer

Exceções

HttpResponseError

Atributos

vault_url