Update Certificate Policy - Update Certificate Policy

Service:

Key Vault

API Version:

7.4

Mises à jour la stratégie d’un certificat.
Définissez les membres spécifiés dans la stratégie de certificat. Laissez les autres comme null. Cette opération nécessite l’autorisation certificats/mise à jour.

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

Paramètres URI

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

Corps de la demande

Nom	Type	Description
attributes	CertificateAttributes	Attributs de certificat.
issuer	IssuerParameters	Paramètres pour 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.

Réponses

Nom	Type	Description
200 OK	CertificatePolicy	Stratégie de certificat
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

UpdateCertificatePolicy

Sample Request

HTTP

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

{
  "key_props": {
    "exportable": true,
    "kty": "RSA",
    "key_size": 2048,
    "reuse_key": false
  },
  "secret_props": {
    "contentType": "application/x-pkcs12"
  },
  "x509_props": {
    "subject": "CN=KeyVaultTest",
    "ekus": [],
    "key_usage": [],
    "validity_months": 297
  },
  "lifetime_actions": [
    {
      "trigger": {
        "lifetime_percentage": 80
      },
      "action": {
        "action_type": "EmailContacts"
      }
    }
  ],
  "issuer": {
    "name": "Self"
  },
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:

200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/policy",
  "key_props": {
    "exportable": true,
    "kty": "RSA",
    "key_size": 2048,
    "reuse_key": false
  },
  "secret_props": {
    "contentType": "application/x-pkcs12"
  },
  "x509_props": {
    "subject": "CN=KeyVaultTest",
    "ekus": [],
    "key_usage": [],
    "validity_months": 297
  },
  "lifetime_actions": [
    {
      "trigger": {
        "lifetime_percentage": 80
      },
      "action": {
        "action_type": "EmailContacts"
      }
    }
  ],
  "issuer": {
    "name": "Self"
  },
  "attributes": {
    "enabled": true,
    "created": 1482188947,
    "updated": 1482188948
  }
}

Définitions

Nom	Description
Action	Action qui sera exécutée.
CertificateAttributes	Attributs de gestion des certificats.
CertificatePolicy	Stratégie de gestion pour un certificat.
CertificatePolicyAction	Type de l'action.
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 du coffre de clés.
IssuerParameters	Paramètres pour l’émetteur du composant X509 d’un certificat.
JsonWebKeyCurveName	Nom de la courbe elliptique. Pour connaître les 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 sauvegarde 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 sera effectué 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

Action qui sera exécutée.

Nom	Type	Description
action_type	CertificatePolicyAction	Type de l'action.

CertificateAttributes

Attributs de gestion des certificats.

Nom	Type	Description
created	integer	Heure de création en UTC.
enabled	boolean	Détermine si l’objet est activé.
exp	integer	Date d’expiration en UTC.
nbf	integer	Date non antérieure en UTC.
recoverableDays	integer	softDelete data retention days. 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	Heure de la dernière mise à jour en UTC.

CertificatePolicy

Stratégie de gestion pour un certificat.

Nom	Type	Description
attributes	CertificateAttributes	Attributs de certificat.
id	string	ID de certificat.
issuer	IssuerParameters	Paramètres pour 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

Type de l'action.

Nom	Type	Description
AutoRenew	string
EmailContacts	string

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.

Nom	Type	Description
CustomizedRecoverable	string	Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription	string	Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et permanente (c’est-à-dire la purge) 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	string	Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (par exemple, purge 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 purge est demandée ou si l’abonnement est annulé.
Purgeable	string	Désigne un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération de suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération de suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Recoverable	string	Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+ProtectedSubscription	string	Désigne un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la purge) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+Purgeable	string	Désigne 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 une purge). 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 purge est demandée ou si l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

IssuerParameters

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

Nom	Type	Description
cert_transparency	boolean	Indique si les certificats générés dans le cadre de 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

Nom de la courbe elliptique. Pour connaître les valeurs valides, consultez JsonWebKeyCurveName.

Nom	Type	Description
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

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

Nom	Type	Description
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

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

Nom	Type	Description
crv	JsonWebKeyCurveName	Nom de la courbe elliptique. Pour connaître les 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	Taille de la 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 de certificat.

KeyUsageType

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

Nom	Type	Description
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.

LifetimeAction

Action et son déclencheur qui sera effectué 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

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

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

SubjectAlternativeNames

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

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

Nom	Type	Description
days_before_expiry	integer	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	Pourcentage de durée de vie à déclencher. La valeur doit être comprise entre 1 et 99.

X509CertificateProperties

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 du sujet. Doit être un nom unique X509 valide.
validity_months	integer	Durée de validité du certificat en mois.