CertificateClient Classe

Interface de haut niveau pour la gestion des certificats d’un coffre.

Héritage

azure.keyvault.certificates._shared.client_base.KeyVaultClientBase

CertificateClient

Constructeur

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

Paramètres

vault_url

str

Obligatoire

URL du coffre accessible par le client. Il s’agit également du « nom DNS » du coffre. Vous devez vérifier que cette URL fait référence à une ressource Key Vault valide. Pour plus d'informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Obligatoire

Objet qui peut fournir un jeton d’accès pour le coffre, par exemple des informations d’identification provenant de identity

api_version

ApiVersion

Version de l’API de service à utiliser. La valeur par défaut est la plus récente.

verify_challenge_resource

bool

Vérifiez si la ressource de défi d’authentification correspond au domaine Key Vault. La valeur par défaut est True.

Méthodes

backup_certificate	Sauvegardez un certificat dans un formulaire protégé utilisable uniquement par Azure Key Vault. Nécessite des certificats/autorisation de sauvegarde. Cela est destiné à permettre la copie d’un certificat d’un coffre vers un autre. Les deux coffres doivent appartenir au même abonnement Azure. En outre, la sauvegarde/restauration ne peut pas être effectuée au-delà des limites géopolitiques. Par exemple, une sauvegarde à partir d’un coffre dans une région USA ne peut pas être restaurée dans un coffre dans une région de l’UE.
begin_create_certificate	Crée un certificat. S’il s’agit de la première version, la ressource de certificat est créée. Cette opération nécessite l’autorisation certificates/create. L’attente sur l’polleur retourné nécessite l’autorisation certificats/obtenir et vous donne le certificat si la création réussit, ou l’opération CertificateOperation si ce n’est pas le cas. Sinon, elle déclenche un HttpResponseError.
begin_delete_certificate	Supprimez toutes les versions d’un certificat. Nécessite des certificats/autorisation de suppression. Lorsque cette méthode retourne Key Vault a commencé à supprimer le certificat. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la suppression.
begin_recover_deleted_certificate	Récupérez un certificat supprimé dans sa dernière version. Possible uniquement dans un coffre avec la suppression réversible activée. Nécessite des certificats/une autorisation de récupération. Lorsque cette méthode retourne Key Vault a commencé à récupérer le certificat. La récupération peut prendre plusieurs secondes. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la récupération. L’attente n’est nécessaire que lorsque vous souhaitez utiliser immédiatement le certificat récupéré dans une autre opération.
cancel_certificate_operation	Annule une opération de certificat en cours. Nécessite l’autorisation certificats/mise à jour.
close	Fermez les sockets ouverts par le client. L’appel de cette méthode n’est pas nécessaire lors de l’utilisation du client comme gestionnaire de contexte.
create_issuer	Définit l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/setissuers.
delete_certificate_operation	Supprime et arrête l’opération de création d’un certificat spécifique. Nécessite l’autorisation certificats/mise à jour.
delete_contacts	Supprime les contacts de certificat pour le coffre de clés. Nécessite l’autorisation certificats/managecontacts.
delete_issuer	Supprime l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/manageissuers/deleteissuers.
get_certificate	Obtient un certificat avec sa stratégie de gestion attachée. Nécessite des certificats/obtenir l’autorisation. N’accepte pas la version du certificat en tant que paramètre. Pour obtenir une version spécifique du certificat, appelez get_certificate_version.
get_certificate_operation	Obtient l’opération de création d’un certificat. Nécessite l’autorisation certificats/obtenir.
get_certificate_policy	Obtient la stratégie d’un certificat. Nécessite des certificats/obtenir l’autorisation. Retourne les ressources de stratégie de certificat spécifiées dans le coffre de clés.
get_certificate_version	Obtient une version spécifique d’un certificat sans retourner sa stratégie de gestion. Nécessite des certificats/obtenir l’autorisation. Pour obtenir la dernière version du certificat ou pour obtenir la stratégie du certificat, appelez get_certificate.
get_contacts	Obtient les contacts de certificat pour le coffre de clés. Nécessite l’autorisation certificats/managecontacts.
get_deleted_certificate	Obtenir un certificat supprimé. Possible uniquement dans un coffre avec la suppression réversible activée. Nécessite des certificats/obtenir l’autorisation. Récupère les informations sur le certificat supprimé ainsi que ses attributs, tels que l’intervalle de rétention, la suppression permanente planifiée et le niveau de récupération de suppression actuel.
get_issuer	Obtient l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/manageissuers/getissuers.
import_certificate	Importez un certificat créé en externe. Nécessite des certificats/autorisation d’importation. Importe un certificat valide existant, contenant une clé privée, dans Azure Key Vault. Le certificat à importer peut être au format PFX ou PEM. Si le certificat est au format PEM, le fichier PEM doit contenir la clé ainsi que les certificats x509, et vous devez fournir un policy avec content_type .pem
list_deleted_certificates	Répertorie les certificats supprimés actuellement récupérables. Possible uniquement si la suppression réversible du coffre est activée. Nécessite l’autorisation certificats/get/list. Récupère les certificats du coffre actuel qui sont dans un état supprimé et prêts pour la récupération ou la purge. Cette opération inclut des informations spécifiques à la suppression.
list_properties_of_certificate_versions	Répertoriez les identificateurs et les propriétés des versions d’un certificat. Nécessite des certificats/une autorisation de liste.
list_properties_of_certificates	Répertoriez les identificateurs et les propriétés de tous les certificats dans le coffre. Nécessite des certificats/une autorisation de liste.
list_properties_of_issuers	Répertorie les propriétés des émetteurs de certificats pour le coffre de clés. Nécessite l’autorisation certificats/manageissuers/getissuers.
merge_certificate	Fusionne un certificat ou une chaîne de certificats avec une paire de clés existante sur le serveur. nécessite l’autorisation de création/certificats. Effectue la fusion d’un certificat ou d’une chaîne de certificats avec une paire de clés actuellement disponible dans le service. Assurez-vous que lors de la création du certificat à fusionner à l’aide begin_create_certificate de que vous définissez son émetteur sur « Inconnu ». De cette façon, Key Vault sait que le certificat ne sera pas signé par un émetteur qui lui est connu.
purge_deleted_certificate	Supprime définitivement un certificat supprimé. Possible uniquement dans les coffres avec la suppression réversible activée. Nécessite des certificats/une autorisation de purge. Effectue une suppression irréversible du certificat spécifié, sans possibilité de récupération. L’opération n’est pas disponible si le recovery_level ne spécifie pas « Purgeable ». Cette méthode n’est nécessaire que pour purger un certificat avant son scheduled_purge_date.
restore_certificate_backup	Restaurez une sauvegarde de certificat dans le coffre. Nécessite des certificats/autorisation de restauration. Cela restaure toutes les versions du certificat, avec son nom, ses attributs et ses stratégies de contrôle d’accès. Si le nom du certificat est déjà utilisé, sa restauration échoue. En outre, le coffre cible doit appartenir au même abonnement Microsoft Azure que le coffre source.
send_request	Exécute une requête réseau à l’aide du pipeline existant du client. L’URL de requête peut être relative à l’URL du coffre. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Cette méthode ne déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de requêtes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.
set_contacts	Définit les contacts de certificat pour le coffre de clés. Nécessite l’autorisation certificats/managecontacts.
update_certificate_policy	Mises à jour la stratégie d’un certificat. Nécessite des certificats/autorisation de mise à jour. Définissez les membres spécifiés dans la stratégie de certificat. Laisse d’autres comme null.
update_certificate_properties	Modifier les propriétés d’un certificat. Nécessite des certificats/autorisation de mise à jour.
update_issuer	Mises à jour l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/setissuers.

backup_certificate

Sauvegardez un certificat dans un formulaire protégé utilisable uniquement par Azure Key Vault.

Nécessite des certificats/autorisation de sauvegarde. Cela est destiné à permettre la copie d’un certificat d’un coffre vers un autre. Les deux coffres doivent appartenir au même abonnement Azure. En outre, la sauvegarde/restauration ne peut pas être effectuée au-delà des limites géopolitiques. Par exemple, une sauvegarde à partir d’un coffre dans une région USA ne peut pas être restaurée dans un coffre dans une région de l’UE.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

Retours

Objet blob de sauvegarde contenant le certificat sauvegardé.

Type de retour

bytes

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

begin_create_certificate

Crée un certificat.

S’il s’agit de la première version, la ressource de certificat est créée. Cette opération nécessite l’autorisation certificates/create. L’attente sur l’polleur retourné nécessite l’autorisation certificats/obtenir et vous donne le certificat si la création réussit, ou l’opération CertificateOperation si ce n’est pas le cas. Sinon, elle déclenche un HttpResponseError.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

policy

CertificatePolicy

Obligatoire

Stratégie de gestion du certificat. L’objet ou l’une des autres propriétés de nom d’objet sont requises.

enabled

bool

Indique si le certificat est activé pour l’utilisation.

tags

dict[str, str]

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

Retours

LROPoller pour l’opération de création de certificat. En attente de l’polleur, vous obtenez le certificat si la création réussit, ou l’opération CertificateOperation si ce n’est pas le cas.

Type de retour

LROPoller[KeyVaultCertificate,

CertificateOperation]

Exceptions

ValueError

si la stratégie de certificat n’est pas valide,

HttpResponseError

pour d’autres erreurs.

begin_delete_certificate

Supprimez toutes les versions d’un certificat. Nécessite des certificats/autorisation de suppression.

Lorsque cette méthode retourne Key Vault a commencé à supprimer le certificat. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la suppression.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat à supprimer.

Retours

Polleur pour l’opération de suppression de certificat. La méthode de résultat de l’polleur retourne le DeletedCertificate sans attendre la fin de la suppression. Si la suppression réversible est activée dans le coffre et que vous souhaitez immédiatement supprimer le certificat avec purge_deleted_certificate, appelez d’abord la méthode d’attente de l’pollueur. Il se bloque jusqu’à ce que la suppression soit terminée. La méthode wait nécessite des certificats/obtenir l’autorisation.

Type de retour

LROPoller[DeletedCertificate]

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

begin_recover_deleted_certificate

Récupérez un certificat supprimé dans sa dernière version. Possible uniquement dans un coffre avec la suppression réversible activée.

Nécessite des certificats/une autorisation de récupération. Lorsque cette méthode retourne Key Vault a commencé à récupérer le certificat. La récupération peut prendre plusieurs secondes. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la récupération. L’attente n’est nécessaire que lorsque vous souhaitez utiliser immédiatement le certificat récupéré dans une autre opération.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat supprimé à récupérer

Retours

Polleur pour l’opération de récupération. La méthode de résultat de l’polleur retourne le récupéré KeyVaultCertificate sans attendre la fin de la récupération. Si vous souhaitez utiliser le certificat récupéré immédiatement, appelez la méthode d’attente de l’polleur, qui bloque jusqu’à ce que le certificat soit prêt à être utilisé. La méthode wait nécessite l’autorisation certificat/get.

Type de retour

LROPoller[KeyVaultCertificate]

Exceptions

HttpResponseError

cancel_certificate_operation

Annule une opération de certificat en cours. Nécessite l’autorisation certificats/mise à jour.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

Retours

Opération de certificat annulée

Type de retour

CertificateOperation

Exceptions

HttpResponseError

close

Fermez les sockets ouverts par le client.

L’appel de cette méthode n’est pas nécessaire lors de l’utilisation du client comme gestionnaire de contexte.

close() -> None

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

create_issuer

Définit l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/setissuers.

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

Paramètres

issuer_name

str

Obligatoire

Nom de l'émetteur.

provider

str

Obligatoire

Fournisseur de l’émetteur.

enabled

bool

Indique si l’émetteur est activé pour l’utilisation.

account_id

str

Nom d’utilisateur/nom de compte/ID de compte.

password

str

Mot de passe/secret/clé de compte.

organization_id

str

ID du organization

admin_contacts

list[AdministratorContact]

Coordonnées des administrateurs organization de l’émetteur du certificat.

Retours

CertificateIssuer créé

Type de retour

CertificateIssuer

Exceptions

HttpResponseError

delete_certificate_operation

Supprime et arrête l’opération de création d’un certificat spécifique.

Nécessite l’autorisation certificats/mise à jour.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

Retours

CertificatOperation supprimé

Type de retour

CertificateOperation

Exceptions

HttpResponseError

delete_contacts

Supprime les contacts de certificat pour le coffre de clés. Nécessite l’autorisation certificats/managecontacts.

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

Retours

Contacts supprimés pour le coffre de clés.

Type de retour

list[CertificateContact]

Exceptions

HttpResponseError

delete_issuer

Supprime l’émetteur de certificat spécifié.

Nécessite l’autorisation certificats/manageissuers/deleteissuers.

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

Paramètres

issuer_name

str

Obligatoire

Nom de l'émetteur.

Retours

CertificateIssuer

Type de retour

CertificateIssuer

Exceptions

HttpResponseError

get_certificate

Obtient un certificat avec sa stratégie de gestion attachée. Nécessite des certificats/obtenir l’autorisation.

N’accepte pas la version du certificat en tant que paramètre. Pour obtenir une version spécifique du certificat, appelez get_certificate_version.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat dans le coffre donné.

Retours

Une instance de KeyVaultCertificate

Type de retour

KeyVaultCertificate

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

get_certificate_operation

Obtient l’opération de création d’un certificat. Nécessite l’autorisation certificats/obtenir.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

Retours

CertificateOperation créé

Type de retour

CertificateOperation

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

get_certificate_policy

Obtient la stratégie d’un certificat. Nécessite des certificats/obtenir l’autorisation.

Retourne les ressources de stratégie de certificat spécifiées dans le coffre de clés.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat dans un coffre de clés donné.

Retours

Stratégie de certificat

Type de retour

CertificatePolicy

Exceptions

HttpResponseError

get_certificate_version

Obtient une version spécifique d’un certificat sans retourner sa stratégie de gestion.

Nécessite des certificats/obtenir l’autorisation. Pour obtenir la dernière version du certificat ou pour obtenir la stratégie du certificat, appelez get_certificate.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat dans le coffre donné.

version

str

Obligatoire

Version du certificat.

Retours

Une instance de KeyVaultCertificate

Type de retour

KeyVaultCertificate

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

get_contacts

Obtient les contacts de certificat pour le coffre de clés. Nécessite l’autorisation certificats/managecontacts.

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

Retours

Contacts de certificat pour le coffre de clés.

Type de retour

list[CertificateContact]

Exceptions

HttpResponseError

get_deleted_certificate

Obtenir un certificat supprimé. Possible uniquement dans un coffre avec la suppression réversible activée.

Nécessite des certificats/obtenir l’autorisation. Récupère les informations sur le certificat supprimé ainsi que ses attributs, tels que l’intervalle de rétention, la suppression permanente planifiée et le niveau de récupération de suppression actuel.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

Retours

Certificat supprimé

Type de retour

DeletedCertificate

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

get_issuer

Obtient l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/manageissuers/getissuers.

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

Paramètres

issuer_name

str

Obligatoire

Nom de l'émetteur.

Retours

Émetteur de certificat spécifié.

Type de retour

CertificateIssuer

Exceptions

ResourceNotFoundError

si l’émetteur n’existe pas,

HttpResponseError

pour d’autres erreurs

import_certificate

Importez un certificat créé en externe. Nécessite des certificats/autorisation d’importation.

Importe un certificat valide existant, contenant une clé privée, dans Azure Key Vault. Le certificat à importer peut être au format PFX ou PEM. Si le certificat est au format PEM, le fichier PEM doit contenir la clé ainsi que les certificats x509, et vous devez fournir un policy avec content_type .pem

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

certificate_bytes

bytes

Obligatoire

Octets de l’objet de certificat à importer. Ce certificat doit contenir la clé privée.

enabled

bool

Indique si le certificat est activé pour l’utilisation.

tags

dict[str, str]

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

password

str

Si la clé privée dans le certificat transmis est chiffrée, il s’agit du mot de passe utilisé pour le chiffrement.

policy

CertificatePolicy

Stratégie de gestion du certificat. Obligatoire si vous importez un certificat au format PEM, avec content_type la valeur définie sur pem.

Retours

KeyVaultCertificate importé

Type de retour

KeyVaultCertificate

Exceptions

HttpResponseError

list_deleted_certificates

Répertorie les certificats supprimés actuellement récupérables. Possible uniquement si la suppression réversible du coffre est activée.

Nécessite l’autorisation certificats/get/list. Récupère les certificats du coffre actuel qui sont dans un état supprimé et prêts pour la récupération ou la purge. Cette opération inclut des informations spécifiques à la suppression.

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

Paramètres

include_pending

bool

Spécifie s’il faut inclure des certificats qui ne sont pas complètement supprimés. Disponible uniquement pour les versions d’API v7.0 et ultérieures.

Retours

Un instance de type itérateur de DeletedCertificate

Type de retour

ItemPaged[DeletedCertificate]

Exceptions

HttpResponseError

list_properties_of_certificate_versions

Répertoriez les identificateurs et les propriétés des versions d’un certificat.

Nécessite des certificats/une autorisation de liste.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat.

Retours

Un instance de type itérateur de CertificateProperties

Type de retour

ItemPaged[CertificateProperties]

Exceptions

HttpResponseError

list_properties_of_certificates

Répertoriez les identificateurs et les propriétés de tous les certificats dans le coffre.

Nécessite des certificats/une autorisation de liste.

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

Paramètres

include_pending

bool

Spécifie s’il faut inclure des certificats qui ne sont pas entièrement provisionnés. Disponible uniquement pour les versions d’API v7.0 et ultérieures.

Retours

Un instance de type itérateur de CertificateProperties

Type de retour

ItemPaged[CertificateProperties]

Exceptions

HttpResponseError

list_properties_of_issuers

Répertorie les propriétés des émetteurs de certificats pour le coffre de clés.

Nécessite l’autorisation certificats/manageissuers/getissuers.

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

Retours

Une instance d’émetteurs de type itérateur

Type de retour

ItemPaged[CertificateIssuer]

Exceptions

HttpResponseError

merge_certificate

Fusionne un certificat ou une chaîne de certificats avec une paire de clés existante sur le serveur.

nécessite l’autorisation de création/certificats. Effectue la fusion d’un certificat ou d’une chaîne de certificats avec une paire de clés actuellement disponible dans le service. Assurez-vous que lors de la création du certificat à fusionner à l’aide begin_create_certificate de que vous définissez son émetteur sur « Inconnu ». De cette façon, Key Vault sait que le certificat ne sera pas signé par un émetteur qui lui est connu.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat

x509_certificates

list[bytes]

Obligatoire

Certificat ou chaîne de certificats à fusionner.

enabled

bool ou None

Indique si le certificat est activé pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

Retours

Certificat fusionné

Type de retour

KeyVaultCertificate

Exceptions

HttpResponseError

purge_deleted_certificate

Supprime définitivement un certificat supprimé. Possible uniquement dans les coffres avec la suppression réversible activée.

Nécessite des certificats/une autorisation de purge. Effectue une suppression irréversible du certificat spécifié, sans possibilité de récupération. L’opération n’est pas disponible si le recovery_level ne spécifie pas « Purgeable ». Cette méthode n’est nécessaire que pour purger un certificat avant son scheduled_purge_date.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat

Retours

None

Type de retour

None

Exceptions

HttpResponseError

restore_certificate_backup

Restaurez une sauvegarde de certificat dans le coffre. Nécessite des certificats/autorisation de restauration.

Cela restaure toutes les versions du certificat, avec son nom, ses attributs et ses stratégies de contrôle d’accès. Si le nom du certificat est déjà utilisé, sa restauration échoue. En outre, le coffre cible doit appartenir au même abonnement Microsoft Azure que le coffre source.

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

Paramètres

backup

bytes

Obligatoire

Objet blob de sauvegarde associé à un ensemble de certificats.

Retours

KeyVaultCertificate restauré

Type de retour

KeyVaultCertificate

Exceptions

HttpResponseError

send_request

Exécute une requête réseau à l’aide du pipeline existant du client.

L’URL de requête peut être relative à l’URL du coffre. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Cette méthode ne déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de requêtes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Paramètres

request

HttpRequest

Obligatoire

Demande réseau que vous souhaitez effectuer.

stream

bool

Indique si la charge utile de réponse sera diffusée en continu. Valeur par défaut False.

Retours

Réponse de votre appel réseau. Ne gère pas les erreurs sur votre réponse.

Type de retour

HttpResponse

Exceptions

ResourceNotFoundError

si le certificat n’existe pas,

HttpResponseError

pour d’autres erreurs

set_contacts

Définit les contacts de certificat pour le coffre de clés. Nécessite l’autorisation certificats/managecontacts.

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

Paramètres

contacts

list[CertificateContact]

Obligatoire

Liste de contacts pour les certificats de coffre.

Retours

Liste de contacts créée

Type de retour

list[CertificateContact]

Exceptions

HttpResponseError

update_certificate_policy

Mises à jour la stratégie d’un certificat. Nécessite des certificats/autorisation de mise à jour.

Définissez les membres spécifiés dans la stratégie de certificat. Laisse d’autres comme null.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat dans le coffre donné.

policy

CertificatePolicy

Obligatoire

Stratégie du certificat.

Retours

Stratégie de certificat

Type de retour

CertificatePolicy

Exceptions

HttpResponseError

update_certificate_properties

Modifier les propriétés d’un certificat. Nécessite des certificats/autorisation de mise à jour.

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

Paramètres

certificate_name

str

Obligatoire

Nom du certificat dans le coffre de clés donné.

version

str

Obligatoire

Version du certificat.

enabled

bool

Indique si le certificat est activé pour l’utilisation.

tags

dict[str, str]

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

Retours

KeyVaultCertificate mis à jour

Type de retour

KeyVaultCertificate

Exceptions

HttpResponseError

update_issuer

Mises à jour l’émetteur de certificat spécifié. Nécessite l’autorisation certificats/setissuers.

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

Paramètres

issuer_name

str

Obligatoire

Nom de l'émetteur.

enabled

bool

Indique si l’émetteur est activé pour l’utilisation.

provider

str

Fournisseur d’émetteurs

account_id

str

Nom d’utilisateur/nom de compte/ID de compte.

password

str

Mot de passe/secret/clé de compte.

organization_id

str

ID du organization

admin_contacts

list[AdministratorContact]

Coordonnées des administrateurs organization de l’émetteur de certificat

Retours

Émetteur mis à jour

Type de retour

CertificateIssuer

Exceptions

HttpResponseError

Attributs

vault_url