CertificateClient Classe

Riferimento

Interfaccia generale per la gestione dei certificati di un insieme di credenziali.

Ereditarietà: azure.keyvault.certificates._shared.client_base.KeyVaultClientBase

CertificateClient

Costruttore

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

Parametri

vault_url: str

Necessario

URL dell'insieme di credenziali a cui il client accederà. Viene chiamato anche "Nome DNS" dell'insieme di credenziali. È necessario verificare che questo URL faccia riferimento a una risorsa Key Vault valida. Per informazioni dettagliate, vedere https://aka.ms/azsdk/blog/vault-uri.

credential: TokenCredential

Necessario

Oggetto che può fornire un token di accesso per l'insieme di credenziali, ad esempio una credenziale da identity

api_version: ApiVersion

Versione dell'API del servizio da usare. Il valore predefinito è quello più recente.

verify_challenge_resource: bool

Se verificare che la risorsa di verifica dell'autenticazione corrisponda al dominio di Key Vault. Impostazione predefinita su True.

Metodi

backup_certificate	Eseguire il backup di un certificato in un modulo protetto utilizzabile solo da Azure Key Vault. Richiede l'autorizzazione certificati/backup. Ciò consente di copiare un certificato da un insieme di credenziali a un altro. Entrambi gli insiemi di credenziali devono essere di proprietà della stessa sottoscrizione di Azure. Inoltre, non è possibile eseguire backup/ripristino tra limiti geopolitici. Ad esempio, un backup da un insieme di credenziali in un'area USA non può essere ripristinato in un insieme di credenziali in un'area dell'UE.
begin_create_certificate	Crea un nuovo certificato. Se si tratta della prima versione, viene creata la risorsa del certificato. Questa operazione richiede l'autorizzazione di creazione certificati. L'attesa sul poller restituito richiede l'autorizzazione certificati/recupero e fornisce il certificato se la creazione ha esito positivo o CertificateOperation, in caso contrario, genera un HttpResponseErroroggetto .
begin_delete_certificate	Eliminare tutte le versioni di un certificato. Richiede l'autorizzazione certificati/eliminazione. Quando questo metodo restituisce Key Vault ha iniziato a eliminare il certificato. L'eliminazione può richiedere diversi secondi in un insieme di credenziali con eliminazione temporanea abilitata. Questo metodo restituisce quindi un poller che consente di attendere il completamento dell'eliminazione.
begin_recover_deleted_certificate	Ripristinare un certificato eliminato nella versione più recente. Possibile solo in un insieme di credenziali con eliminazione temporanea abilitata. Richiede l'autorizzazione certificati/ripristino. Quando questo metodo restituisce Key Vault ha iniziato a ripristinare il certificato. Il ripristino può richiedere diversi secondi. Questo metodo restituisce quindi un poller che consente di attendere il completamento del ripristino. L'attesa è necessaria solo quando si vuole usare immediatamente il certificato ripristinato in un'altra operazione.
cancel_certificate_operation	Annulla un'operazione di certificato in corso. Richiede l'autorizzazione certificati/aggiornamento.
close	Chiudere i socket aperti dal client. La chiamata a questo metodo non è necessaria quando si usa il client come gestione contesto.
create_issuer	Imposta l'autorità di certificazione specificata. Richiede l'autorizzazione certificati/setissuers.
delete_certificate_operation	Elimina e arresta l'operazione di creazione per un certificato specifico. Richiede l'autorizzazione certificati/aggiornamento.
delete_contacts	Elimina i contatti del certificato per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificati/managecontacts.
delete_issuer	Elimina l'autorità di certificazione del certificato specificata. Richiede l'autorizzazione certificati/manageissuers/deleteissuers.
get_certificate	Ottiene un certificato con i criteri di gestione collegati. Richiede i certificati/ottenere l'autorizzazione. Non accetta la versione del certificato come parametro. Per ottenere una versione specifica del certificato, chiamare get_certificate_version.
get_certificate_operation	Ottiene l'operazione di creazione di un certificato. Richiede l'autorizzazione certificates/get.
get_certificate_policy	Ottiene i criteri per un certificato. Richiede certificati/ottenere l'autorizzazione. Restituisce le risorse dei criteri di certificato specificate nell'insieme di credenziali delle chiavi.
get_certificate_version	Ottiene una versione specifica di un certificato senza restituire i criteri di gestione. Richiede certificati/ottenere l'autorizzazione. Per ottenere la versione più recente del certificato o per ottenere anche i criteri del certificato, chiamare get_certificate.
get_contacts	Ottiene i contatti del certificato per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificates/managecontacts.
get_deleted_certificate	Ottenere un certificato eliminato. Possibile solo in un insieme di credenziali con eliminazione temporanea abilitata. Richiede certificati/ottenere l'autorizzazione. Recupera le informazioni sul certificato eliminate e i relativi attributi, ad esempio l'intervallo di conservazione, l'eliminazione permanente pianificata e il livello di ripristino di eliminazione corrente.
get_issuer	Ottiene l'autorità emittente del certificato specificata. Richiede l'autorizzazione certificates/manageissuers/getissuers.
import_certificate	Importare un certificato creato esternamente. Richiede l'autorizzazione di importazione/certificati. Importa un certificato valido esistente, contenente una chiave privata, in Azure Key Vault. Il certificato da importare può essere in formato PFX o PEM. Se il certificato è in formato PEM, il file PEM deve contenere la chiave e i certificati x509 ed è necessario specificare un `policy` con content_type .pem
list_deleted_certificates	Elenca i certificati eliminati attualmente recuperabili. Possibile solo se l'insieme di credenziali è abilitato per l'eliminazione temporanea. Richiede l'autorizzazione certificates/get/list. Recupera i certificati nell'insieme di credenziali corrente che si trovano in uno stato eliminato e pronti per il ripristino o l'eliminazione. Questa operazione include informazioni specifiche per l'eliminazione.
list_properties_of_certificate_versions	Elencare gli identificatori e le proprietà delle versioni di un certificato. Richiede l'autorizzazione certificati/elenco.
list_properties_of_certificates	Elencare gli identificatori e le proprietà di tutti i certificati nell'insieme di credenziali. Richiede l'autorizzazione certificati/elenco.
list_properties_of_issuers	Elenca le proprietà delle autorità emittenti di certificati per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificates/manageissuers/getissuers.
merge_certificate	Unisce un certificato o una catena di certificati con una coppia di chiavi esistente nel server. è necessaria l'autorizzazione a creare certificati. Esegue l'unione di un certificato o di una catena di certificati con una coppia di chiavi attualmente disponibile nel servizio. Assicurarsi che durante la creazione del certificato da unire usando begin_create_certificate l'autorità emittente sia impostata su "Sconosciuto". In questo modo Key Vault sa che il certificato non verrà firmato da un emittente noto.
purge_deleted_certificate	Elimina definitivamente un certificato eliminato. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata. Richiede l'autorizzazione certificati/eliminazione. Esegue un'eliminazione irreversibile del certificato specificato, senza possibilità di ripristino. L'operazione non è disponibile se non recovery_level specifica "Purgeable". Questo metodo è necessario solo per eliminare un certificato prima del relativo scheduled_purge_date.
restore_certificate_backup	Ripristinare un backup del certificato nell'insieme di credenziali. Richiede l'autorizzazione per certificati/ripristino. In questo modo vengono ripristinate tutte le versioni del certificato, con il nome, gli attributi e i criteri di controllo di accesso. Se il nome del certificato è già in uso, il ripristino avrà esito negativo. Inoltre, l'insieme di credenziali di destinazione deve essere di proprietà della stessa sottoscrizione di Microsoft Azure dell'insieme di credenziali di origine.
send_request	Esegue una richiesta di rete usando la pipeline esistente del client. L'URL della richiesta può essere relativo all'URL dell'insieme di credenziali. La versione dell'API del servizio usata per la richiesta è uguale a quella del client, se non diversamente specificato. Questo metodo non genera se la risposta è un errore; per generare un'eccezione, chiamare raise_for_status() sull'oggetto risposta restituito. Per altre informazioni su come inviare richieste personalizzate con questo metodo, vedere https://aka.ms/azsdk/dpcodegen/python/send_request.
set_contacts	Imposta i contatti del certificato per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificates/managecontacts.
update_certificate_policy	Aggiornamenti i criteri per un certificato. Richiede l'autorizzazione certificati/aggiornamento. Impostare i membri specificati nei criteri del certificato. Lascia gli altri come Null.
update_certificate_properties	Modificare le proprietà di un certificato. Richiede l'autorizzazione certificati/aggiornamento.
update_issuer	Aggiornamenti l'autorità emittente del certificato specificata. Richiede l'autorizzazione certificates/setissuers.

backup_certificate

Eseguire il backup di un certificato in un modulo protetto utilizzabile solo da Azure Key Vault.

Richiede l'autorizzazione certificati/backup. Ciò consente di copiare un certificato da un insieme di credenziali a un altro. Entrambi gli insiemi di credenziali devono essere di proprietà della stessa sottoscrizione di Azure. Inoltre, non è possibile eseguire backup/ripristino tra limiti geopolitici. Ad esempio, un backup da un insieme di credenziali in un'area USA non può essere ripristinato in un insieme di credenziali in un'area dell'UE.

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

Restituisce

BLOB di backup contenente il certificato di backup.

Tipo restituito

bytes

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

begin_create_certificate

Crea un nuovo certificato.

Se si tratta della prima versione, viene creata la risorsa del certificato. Questa operazione richiede l'autorizzazione di creazione certificati. L'attesa sul poller restituito richiede l'autorizzazione certificati/recupero e fornisce il certificato se la creazione ha esito positivo o CertificateOperation, in caso contrario, genera un HttpResponseErroroggetto .

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

policy: CertificatePolicy

Necessario

Criteri di gestione per il certificato. È necessario un oggetto o una delle proprietà del nome alternativo del soggetto.

enabled: bool

Indica se il certificato è abilitato per l'uso.

tags: dict[str, str]

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

Restituisce

Oggetto LROPoller per l'operazione di creazione del certificato. L'attesa sul poller fornisce il certificato se la creazione ha esito positivo o CertificateOperation se non lo è.

Tipo restituito

LROPoller[KeyVaultCertificate,

CertificateOperation]

Eccezioni

ValueError

se il criterio del certificato non è valido,

HttpResponseError

per altri errori.

begin_delete_certificate

Eliminare tutte le versioni di un certificato. Richiede l'autorizzazione certificati/eliminazione.

Quando questo metodo restituisce Key Vault ha iniziato a eliminare il certificato. L'eliminazione può richiedere diversi secondi in un insieme di credenziali con eliminazione temporanea abilitata. Questo metodo restituisce quindi un poller che consente di attendere il completamento dell'eliminazione.

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

Parametri

certificate_name: str

Necessario

Nome del certificato da eliminare.

Restituisce

Un poller per l'operazione di eliminazione del certificato. Il metodo risultato del poller restituisce l'oggetto senza attendere il DeletedCertificate completamento dell'eliminazione. Se l'insieme di credenziali ha abilitato l'eliminazione temporanea e si vuole eliminare immediatamente il certificato con purge_deleted_certificate, chiamare prima il metodo di attesa del poller. Verrà bloccato fino al completamento dell'eliminazione. Il metodo wait richiede certificati/ottenere l'autorizzazione.

Tipo restituito

LROPoller[DeletedCertificate]

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

begin_recover_deleted_certificate

Ripristinare un certificato eliminato nella versione più recente. Possibile solo in un insieme di credenziali con eliminazione temporanea abilitata.

Richiede l'autorizzazione certificati/ripristino. Quando questo metodo restituisce Key Vault ha iniziato a ripristinare il certificato. Il ripristino può richiedere diversi secondi. Questo metodo restituisce quindi un poller che consente di attendere il completamento del ripristino. L'attesa è necessaria solo quando si vuole usare immediatamente il certificato ripristinato in un'altra operazione.

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

Parametri

certificate_name: str

Necessario

Nome del certificato eliminato da ripristinare

Restituisce

Un poller per l'operazione di ripristino. Il metodo risultato del poller restituisce il ripristino KeyVaultCertificate senza attendere il completamento del ripristino. Se si vuole usare immediatamente il certificato ripristinato, chiamare il metodo di attesa del poller, che blocca fino a quando il certificato non è pronto per l'uso. Il metodo wait richiede l'autorizzazione certificate/get.

Tipo restituito

LROPoller[KeyVaultCertificate]

Eccezioni

HttpResponseError

cancel_certificate_operation

Annulla un'operazione di certificato in corso. Richiede l'autorizzazione certificati/aggiornamento.

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

Restituisce

Operazione di certificato annullata

Tipo restituito

CertificateOperation

Eccezioni

HttpResponseError

close

Chiudere i socket aperti dal client.

La chiamata a questo metodo non è necessaria quando si usa il client come gestione contesto.

close() -> None

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

create_issuer

Imposta l'autorità di certificazione specificata. Richiede l'autorizzazione certificati/setissuers.

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

Parametri

issuer_name: str

Necessario

Nome dell'autorità emittente.

provider: str

Necessario

Provider di autorità di certificazione.

enabled: bool

Indica se l'autorità emittente è abilitata per l'uso.

account_id: str

Nome utente/nome account/ID account.

password: str

Chiave password/segreto/account.

organization_id: str

ID dell'organizzazione

admin_contacts: list[AdministratorContact]

Informazioni di contatto sugli amministratori dell'organizzazione dell'autorità di certificazione.

Restituisce

Certificato creatoIssuer

Tipo restituito

CertificateIssuer

Eccezioni

HttpResponseError

delete_certificate_operation

Elimina e arresta l'operazione di creazione per un certificato specifico.

Richiede l'autorizzazione certificati/aggiornamento.

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

Restituisce

Certificato eliminatoOperation

Tipo restituito

CertificateOperation

Eccezioni

HttpResponseError

delete_contacts

Elimina i contatti del certificato per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificati/managecontacts.

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

Restituisce

Contatti eliminati per l'insieme di credenziali delle chiavi.

Tipo restituito

list[CertificateContact]

Eccezioni

HttpResponseError

delete_issuer

Elimina l'autorità di certificazione del certificato specificata.

Richiede l'autorizzazione certificati/manageissuers/deleteissuers.

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

Parametri

issuer_name: str

Necessario

Nome dell'autorità emittente.

Restituisce

CertificateIssuer

Tipo restituito

CertificateIssuer

Eccezioni

HttpResponseError

get_certificate

Ottiene un certificato con i criteri di gestione collegati. Richiede i certificati/ottenere l'autorizzazione.

Non accetta la versione del certificato come parametro. Per ottenere una versione specifica del certificato, chiamare get_certificate_version.

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

Parametri

certificate_name: str

Necessario

Nome del certificato nell'insieme di credenziali specificato.

Restituisce

Istanza di KeyVaultCertificate

Tipo restituito

KeyVaultCertificate

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

get_certificate_operation

Ottiene l'operazione di creazione di un certificato. Richiede l'autorizzazione certificates/get.

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

Restituisce

CertificatoOperation creato

Tipo restituito

CertificateOperation

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

get_certificate_policy

Ottiene i criteri per un certificato. Richiede certificati/ottenere l'autorizzazione.

Restituisce le risorse dei criteri di certificato specificate nell'insieme di credenziali delle chiavi.

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

Parametri

certificate_name: str

Necessario

Nome del certificato in un determinato insieme di credenziali delle chiavi.

Restituisce

Criteri del certificato

Tipo restituito

CertificatePolicy

Eccezioni

HttpResponseError

get_certificate_version

Ottiene una versione specifica di un certificato senza restituire i criteri di gestione.

Richiede certificati/ottenere l'autorizzazione. Per ottenere la versione più recente del certificato o per ottenere anche i criteri del certificato, chiamare get_certificate.

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

Parametri

certificate_name: str

Necessario

Nome del certificato nell'insieme di credenziali specificato.

version: str

Necessario

Versione del certificato.

Restituisce

Istanza di KeyVaultCertificate

Tipo restituito

KeyVaultCertificate

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

get_contacts

Ottiene i contatti del certificato per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificates/managecontacts.

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

Restituisce

Contatti del certificato per l'insieme di credenziali delle chiavi.

Tipo restituito

list[CertificateContact]

Eccezioni

HttpResponseError

get_deleted_certificate

Ottenere un certificato eliminato. Possibile solo in un insieme di credenziali con eliminazione temporanea abilitata.

Richiede certificati/ottenere l'autorizzazione. Recupera le informazioni sul certificato eliminate e i relativi attributi, ad esempio l'intervallo di conservazione, l'eliminazione permanente pianificata e il livello di ripristino di eliminazione corrente.

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

Restituisce

Certificato eliminato

Tipo restituito

DeletedCertificate

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

get_issuer

Ottiene l'autorità emittente del certificato specificata. Richiede l'autorizzazione certificates/manageissuers/getissuers.

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

Parametri

issuer_name: str

Necessario

Nome dell'autorità emittente.

Restituisce

Autorità emittente del certificato specificata.

Tipo restituito

CertificateIssuer

Eccezioni

ResourceNotFoundError

se l'autorità emittente non esiste,

HttpResponseError

per altri errori

import_certificate

Importare un certificato creato esternamente. Richiede l'autorizzazione di importazione/certificati.

Importa un certificato valido esistente, contenente una chiave privata, in Azure Key Vault. Il certificato da importare può essere in formato PFX o PEM. Se il certificato è in formato PEM, il file PEM deve contenere la chiave e i certificati x509 ed è necessario specificare un policy con content_type .pem

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

certificate_bytes: bytes

Necessario

Byte dell'oggetto certificato da importare. Questo certificato deve contenere la chiave privata.

enabled: bool

Indica se il certificato è abilitato per l'uso.

tags: dict[str, str]

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

password: str

Se la chiave privata nel certificato passato è crittografata, è la password usata per la crittografia.

policy: CertificatePolicy

Criteri di gestione per il certificato. Obbligatorio se si importa un certificato in formato PEM, con content_type impostato su pem.

Restituisce

KeyVaultCertificate importato

Tipo restituito

KeyVaultCertificate

Eccezioni

HttpResponseError

list_deleted_certificates

Elenca i certificati eliminati attualmente recuperabili. Possibile solo se l'insieme di credenziali è abilitato per l'eliminazione temporanea.

Richiede l'autorizzazione certificates/get/list. Recupera i certificati nell'insieme di credenziali corrente che si trovano in uno stato eliminato e pronti per il ripristino o l'eliminazione. Questa operazione include informazioni specifiche per l'eliminazione.

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

Parametri

include_pending: bool

Specifica se includere certificati che non vengono eliminati completamente. Disponibile solo per le versioni api v7.0 e successive.

Restituisce

Istanza simile a iteratore di DeletedCertificate

Tipo restituito

ItemPaged[DeletedCertificate]

Eccezioni

HttpResponseError

list_properties_of_certificate_versions

Elencare gli identificatori e le proprietà delle versioni di un certificato.

Richiede l'autorizzazione certificati/elenco.

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

Parametri

certificate_name: str

Necessario

Nome del certificato.

Restituisce

Istanza simile a iteratore di CertificateProperties

Tipo restituito

ItemPaged[CertificateProperties]

Eccezioni

HttpResponseError

list_properties_of_certificates

Elencare gli identificatori e le proprietà di tutti i certificati nell'insieme di credenziali.

Richiede l'autorizzazione certificati/elenco.

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

Parametri

include_pending: bool

Specifica se includere certificati di cui non è stato eseguito il provisioning completo. Disponibile solo per le versioni api v7.0 e successive.

Restituisce

Istanza simile a iteratore di CertificateProperties

Tipo restituito

ItemPaged[CertificateProperties]

Eccezioni

HttpResponseError

list_properties_of_issuers

Elenca le proprietà delle autorità emittenti di certificati per l'insieme di credenziali delle chiavi.

Richiede l'autorizzazione certificates/manageissuers/getissuers.

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

Restituisce

Istanza simile a iteratore di autorità emittenti

Tipo restituito

ItemPaged[CertificateIssuer]

Eccezioni

HttpResponseError

merge_certificate

Unisce un certificato o una catena di certificati con una coppia di chiavi esistente nel server.

è necessaria l'autorizzazione a creare certificati. Esegue l'unione di un certificato o di una catena di certificati con una coppia di chiavi attualmente disponibile nel servizio. Assicurarsi che durante la creazione del certificato da unire usando begin_create_certificate l'autorità emittente sia impostata su "Sconosciuto". In questo modo Key Vault sa che il certificato non verrà firmato da un emittente noto.

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

Parametri

certificate_name: str

Necessario

Nome del certificato

x509_certificates: list[bytes]

Necessario

Certificato o catena di certificati da unire.

enabled: bool oppure None

Indica se il certificato è abilitato per l'uso.

tags: dict[str, str] oppure None

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

Restituisce

Certificato unito

Tipo restituito

KeyVaultCertificate

Eccezioni

HttpResponseError

purge_deleted_certificate

Elimina definitivamente un certificato eliminato. Possibile solo negli insiemi di credenziali con l'eliminazione temporanea abilitata.

Richiede l'autorizzazione certificati/eliminazione. Esegue un'eliminazione irreversibile del certificato specificato, senza possibilità di ripristino. L'operazione non è disponibile se non recovery_level specifica "Purgeable". Questo metodo è necessario solo per eliminare un certificato prima del relativo scheduled_purge_date.

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

Parametri

certificate_name: str

Necessario

Nome del certificato

Restituisce

Nessuno

Tipo restituito

None

Eccezioni

HttpResponseError

restore_certificate_backup

Ripristinare un backup del certificato nell'insieme di credenziali. Richiede l'autorizzazione per certificati/ripristino.

In questo modo vengono ripristinate tutte le versioni del certificato, con il nome, gli attributi e i criteri di controllo di accesso. Se il nome del certificato è già in uso, il ripristino avrà esito negativo. Inoltre, l'insieme di credenziali di destinazione deve essere di proprietà della stessa sottoscrizione di Microsoft Azure dell'insieme di credenziali di origine.

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

Parametri

backup: bytes

Necessario

BLOB di backup associato a un bundle di certificati.

Restituisce

KeyVaultCertificate ripristinato

Tipo restituito

KeyVaultCertificate

Eccezioni

HttpResponseError

send_request

Esegue una richiesta di rete usando la pipeline esistente del client.

L'URL della richiesta può essere relativo all'URL dell'insieme di credenziali. La versione dell'API del servizio usata per la richiesta è uguale a quella del client, se non diversamente specificato. Questo metodo non genera se la risposta è un errore; per generare un'eccezione, chiamare raise_for_status() sull'oggetto risposta restituito. Per altre informazioni su come inviare richieste personalizzate con questo metodo, vedere https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametri

request: HttpRequest

Necessario

Richiesta di rete da effettuare.

stream: bool

Indica se il payload della risposta verrà trasmesso. Il valore predefinito è False.

Restituisce

Risposta della chiamata di rete. Non esegue la gestione degli errori nella risposta.

Tipo restituito

HttpResponse

Eccezioni

ResourceNotFoundError

se il certificato non esiste,

HttpResponseError

per altri errori

set_contacts

Imposta i contatti del certificato per l'insieme di credenziali delle chiavi. Richiede l'autorizzazione certificates/managecontacts.

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

Parametri

contacts: list[CertificateContact]

Necessario

Elenco contatti per i certificati dell'insieme di credenziali.

Restituisce

Elenco di contatti creato

Tipo restituito

list[CertificateContact]

Eccezioni

HttpResponseError

update_certificate_policy

Aggiornamenti i criteri per un certificato. Richiede l'autorizzazione certificati/aggiornamento.

Impostare i membri specificati nei criteri del certificato. Lascia gli altri come Null.

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

Parametri

certificate_name: str

Necessario

Nome del certificato nell'insieme di credenziali specificato.

policy: CertificatePolicy

Necessario

Criteri per il certificato.

Restituisce

Criteri del certificato

Tipo restituito

CertificatePolicy

Eccezioni

HttpResponseError

update_certificate_properties

Modificare le proprietà di un certificato. Richiede l'autorizzazione certificati/aggiornamento.

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

Parametri

certificate_name: str

Necessario

Nome del certificato nell'insieme di credenziali delle chiavi specificato.

version: str

Necessario

Versione del certificato.

enabled: bool

Indica se il certificato è abilitato per l'uso.

tags: dict[str, str]

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

Restituisce

KeyVaultCertificate aggiornato

Tipo restituito

KeyVaultCertificate

Eccezioni

HttpResponseError

update_issuer

Aggiornamenti l'autorità emittente del certificato specificata. Richiede l'autorizzazione certificates/setissuers.

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

Parametri

issuer_name: str

Necessario

Nome dell'autorità emittente.

enabled: bool

Indica se l'autorità emittente è abilitata per l'uso.

provider: str

Provider dell'autorità di certificazione

account_id: str

Nome utente/nome account/ID account.

password: str

Password/segreto/chiave dell'account.

organization_id: str

ID dell'organizzazione

admin_contacts: list[AdministratorContact]

Dettagli di contatto degli amministratori dell'organizzazione dell'autorità emittente del certificato