Update Certificate - Update Certificate

Service:: Key Vault

Version d'API:: 7.4

Met à jour les attributs spécifiés associés au certificat donné.
L’opération UpdateCertificate applique la mise à jour spécifiée sur le certificat donné ; les seuls éléments mis à jour sont les attributs du certificat. Cette opération nécessite l’autorisation certificats/mise à jour.

PATCH {vaultBaseUrl}/certificates/{certificate-name}/{certificate-version}?api-version=7.4

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
certificate-name	path	True	string	Nom du certificat dans le coffre de clés donné.
certificate-version	path	True	string	Version du certificat.
vaultBaseUrl	path	True	string	Nom du coffre, par exemple `https://myvault.vault.azure.net`.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
attributes	CertificateAttributes	Attributs du certificat (facultatif).
policy	CertificatePolicy	Stratégie de gestion du certificat.
tags	object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur.

Réponses

Nom	Type	Description
200 OK	CertificateBundle	Certificat mis à jour.
Other Status Codes	KeyVaultError	Réponse d’erreur Key Vault décrivant pourquoi l’opération a échoué.

Exemples

UpdateCertificate

Exemple de requête

HTTP

PATCH https://myvault.vault.azure.net//certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc?api-version=7.4

{
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "kid": "https://myvault.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "sid": "https://myvault.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1482188981,
    "updated": 1482188981
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Définitions

Nom	Description
Action	Action qui sera exécutée.
CertificateAttributes	Attributs de gestion des certificats.
CertificateBundle	Un ensemble de certificats se compose d’un certificat (X509) ainsi que de ses attributs.
CertificatePolicy	Stratégie de gestion pour un certificat.
CertificatePolicyAction	Type de l’action.
CertificateUpdateParameters	Paramètres de mise à jour du certificat.
DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à la fin de l’intervalle de rétention.
Error	Erreur du serveur key vault.
IssuerParameters	Paramètres de l’émetteur du composant X509 d’un certificat.
JsonWebKeyCurveName	Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.
JsonWebKeyType	Type de paire de clés à utiliser pour le certificat.
KeyProperties	Propriétés de la paire de clés qui sauvegardent un certificat.
KeyUsageType	Définit la façon dont la clé du certificat peut être utilisée.
KeyVaultError	Exception d’erreur du coffre de clés.
LifetimeAction	Action et son déclencheur qui seront effectués par Key Vault pendant la durée de vie d’un certificat.
SecretProperties	Propriétés de la clé qui sauvegarde un certificat.
SubjectAlternativeNames	Autres noms d’objet d’un objet X509.
Trigger	Condition à satisfaire pour qu’une action soit exécutée.
X509CertificateProperties	Propriétés du composant X509 d’un certificat.

Action

Object

Action qui sera exécutée.

Nom	Type	Description
action_type	CertificatePolicyAction	Type de l’action.

CertificateAttributes

Object

Attributs de gestion des certificats.

Nom	Type	Description
created	integer (unixtime)	Heure de création au format UTC.
enabled	boolean	Détermine si l’objet est activé.
exp	integer (unixtime)	Date d’expiration au format UTC.
nbf	integer (unixtime)	Pas avant la date UTC.
recoverableDays	integer (int32)	Jours de conservation des données softDelete. La valeur doit être >=7 et <=90 lorsque softDelete est activé, sinon 0.
recoveryLevel	DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à la fin de l’intervalle de rétention.
updated	integer (unixtime)	Heure de la dernière mise à jour au format UTC.

CertificateBundle

Object

Un ensemble de certificats se compose d’un certificat (X509) ainsi que de ses attributs.

Nom	Type	Description
attributes	CertificateAttributes	Attributs de certificat.
cer	string (byte)	Contenu CER du certificat x509.
contentType	string	Type de contenu du secret. Eg. 'application/x-pem-file' ou 'application/x-pkcs12',
id	string	ID de certificat.
kid	string	ID de clé.
policy	CertificatePolicy	Stratégie de gestion.
sid	string	ID de secret.
tags	object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur
x5t	string (base64url)	Empreinte numérique du certificat.

CertificatePolicy

Object

Stratégie de gestion pour un certificat.

Nom	Type	Description
attributes	CertificateAttributes	Attributs de certificat.
id	string	ID de certificat.
issuer	IssuerParameters	Paramètres de l’émetteur du composant X509 d’un certificat.
key_props	KeyProperties	Propriétés de la clé qui sauvegarde un certificat.
lifetime_actions	LifetimeAction[]	Actions qui seront effectuées par Key Vault pendant la durée de vie d’un certificat.
secret_props	SecretProperties	Propriétés du secret qui sauvegarde un certificat.
x509_props	X509CertificateProperties	Propriétés du composant X509 d’un certificat.

CertificatePolicyAction

Énumération

Type de l’action.

Valeur	Description
AutoRenew
EmailContacts

CertificateUpdateParameters

Object

Paramètres de mise à jour du certificat.

Nom	Type	Description
attributes	CertificateAttributes	Attributs du certificat (facultatif).
policy	CertificatePolicy	Stratégie de gestion du certificat.
tags	object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur.

DeletionRecoveryLevel

Énumération

Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à la fin de l’intervalle de rétention.

Valeur	Description
CustomizedRecoverable	Indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant la disponibilité de l’abonnement.
CustomizedRecoverable+ProtectedSubscription	Indique un coffre et un état d’abonnement dans lequel la suppression est récupérable, immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.
CustomizedRecoverable+Purgeable	Indique un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (c’est-à-dire purger lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de vidage est demandée ou si l’abonnement est annulé.
Purgeable	Indique un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à aucune protection disponible contre une opération De suppression ; les données sont irrécupérablement perdues lors de l’acceptation d’une opération Delete au niveau de l’entité ou supérieure (coffre, groupe de ressources, abonnement, etc.)
Recoverable	Indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+ProtectedSubscription	Indique un coffre et un état d’abonnement dans lequel la suppression est récupérable dans un intervalle de rétention (90 jours), une suppression immédiate et définitive (c’est-à-dire une suppression définitive) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+Purgeable	Indique un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (c’est-à-dire purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de vidage est demandée ou si l’abonnement est annulé. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré

Error

Object

Erreur du serveur key vault.

Nom	Type	Description
code	string	Code d’erreur.
innererror	Error	Erreur du serveur key vault.
message	string	Message d’erreur.

IssuerParameters

Object

Paramètres de l’émetteur du composant X509 d’un certificat.

Nom	Type	Description
cert_transparency	boolean	Indique si les certificats générés sous cette stratégie doivent être publiés dans les journaux de transparence des certificats.
cty	string	Type de certificat pris en charge par le fournisseur (facultatif) ; par exemple « OV-SSL », « EV-SSL »
name	string	Nom de l’objet émetteur référencé ou des noms réservés ; par exemple, « Self » ou « Unknown ».

JsonWebKeyCurveName

Énumération

Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.

Valeur	Description
P-256
P-256K
P-384
P-521

JsonWebKeyType

Énumération

Type de paire de clés à utiliser pour le certificat.

Valeur	Description
EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KeyProperties

Object

Propriétés de la paire de clés qui sauvegardent un certificat.

Nom	Type	Description
crv	JsonWebKeyCurveName	Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.
exportable	boolean	Indique si la clé privée peut être exportée. La stratégie de mise en production doit être fournie lors de la création de la première version d’une clé exportable.
key_size	integer (int32)	Taille de clé en bits. Par exemple : 2048, 3072 ou 4096 pour RSA.
kty	JsonWebKeyType	Type de paire de clés à utiliser pour le certificat.
reuse_key	boolean	Indique si la même paire de clés sera utilisée lors du renouvellement du certificat.

KeyUsageType

Énumération

Définit la façon dont la clé du certificat peut être utilisée.

Valeur	Description
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

KeyVaultError

Object

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur key vault.

LifetimeAction

Object

Action et son déclencheur qui seront effectués par Key Vault pendant la durée de vie d’un certificat.

Nom	Type	Description
action	Action	Action qui sera exécutée.
trigger	Trigger	Condition qui exécutera l’action.

SecretProperties

Object

Propriétés de la clé qui sauvegarde un certificat.

Nom	Type	Description
contentType	string	Type de média (type MIME).

SubjectAlternativeNames

Object

Autres noms d’objet d’un objet X509.

Nom	Type	Description
dns_names	string[]	Noms de domaine.
emails	string[]	Adresses e-mail.
upns	string[]	Noms d’utilisateur principaux.

Trigger

Object

Condition à satisfaire pour qu’une action soit exécutée.

Nom	Type	Description
days_before_expiry	integer (int32)	Jours avant l’expiration de la tentative de renouvellement. La valeur doit être comprise entre 1 et validity_in_months multipliée par 27. Si validity_in_months est 36, la valeur doit être comprise entre 1 et 972 (36 * 27).
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Pourcentage de durée de vie à laquelle déclencher. La valeur doit être comprise entre 1 et 99.

X509CertificateProperties

Object

Propriétés du composant X509 d’un certificat.

Nom	Type	Description
ekus	string[]	Utilisation améliorée de la clé.
key_usage	KeyUsageType[]	Définit la façon dont la clé du certificat peut être utilisée.
sans	SubjectAlternativeNames	Autres noms d’objet.
subject	string	Nom de l’objet. Doit être un nom unique X509 valide.
validity_months	integer (int32) minimum: 0	Durée pendant laquelle le certificat est valide en mois.

Partager via

Update Certificate - Update Certificate

Paramètres URI

Corps de la demande

Réponses

Exemples

UpdateCertificate

Exemple de requête

Exemple de réponse

Définitions

Action

CertificateAttributes

CertificateBundle

CertificatePolicy

CertificatePolicyAction

CertificateUpdateParameters

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties