Create Certificate - 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.
POST {vaultBaseUrl}/certificates/{certificate-name}/create?api-version=7.4
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
certificate-name
|
path | True |
string |
Nom du certificat. La valeur que vous fournissez peut être copiée globalement dans le but d’exécuter le service. La valeur fournie ne doit pas inclure d’informations d’identification personnelle ou sensibles. Regex pattern: |
vault
|
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 |
Attributs du certificat (facultatif). |
|
policy |
Stratégie de gestion du certificat. |
|
tags |
object |
Métadonnées spécifiques d’application sous la forme de paires clé/valeur. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
Création d’une offre groupée de certificats. |
|
Other Status Codes |
Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération. |
Exemples
CreateCertificate
Sample Request
POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.4
{
"policy": {
"key_props": {
"exportable": true,
"kty": "RSA",
"key_size": 2048,
"reuse_key": false
},
"secret_props": {
"contentType": "application/x-pkcs12"
},
"x509_props": {
"subject": "CN=*.microsoft.com",
"sans": {
"dns_names": [
"onedrive.microsoft.com",
"xbox.microsoft.com"
]
}
},
"issuer": {
"name": "Self"
}
}
}
Sample Response
{
"id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
"issuer": {
"name": "Self"
},
"csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
"cancellation_requested": false,
"status": "inProgress",
"status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
"request_id": "6faacd568ab049a2803861e8dd3ae21f"
}
Définitions
Nom | Description |
---|---|
Action |
Action qui sera exécutée. |
Certificate |
Attributs de gestion des certificats. |
Certificate |
Paramètres de création de certificat. |
Certificate |
Une opération de certificat est retournée en cas de demandes asynchrones. |
Certificate |
Stratégie de gestion pour un certificat. |
Certificate |
Type de l'action. |
Deletion |
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. |
Issuer |
Paramètres de l’émetteur du composant X509 d’un certificat. |
Json |
Nom de la courbe elliptique. Pour connaître les valeurs valides, consultez JsonWebKeyCurveName. |
Json |
Type de paire de clés à utiliser pour le certificat. |
Key |
Propriétés de la paire de clés qui sauvegardent un certificat. |
Key |
Définit la façon dont la clé du certificat peut être utilisée. |
Key |
Exception d’erreur du coffre de clés. |
Lifetime |
Action et son déclencheur qui seront exécutés par Key Vault sur la durée de vie d’un certificat. |
Secret |
Propriétés de la clé qui soutient un certificat. |
Subject |
Autres noms d’objet d’un objet X509. |
Trigger |
Condition à satisfaire pour qu’une action soit exécutée. |
X509Certificate |
Propriétés du composant X509 d’un certificat. |
Action
Action qui sera exécutée.
Nom | Type | Description |
---|---|---|
action_type |
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 |
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 au format UTC. |
CertificateCreateParameters
Paramètres de création de certificat.
Nom | Type | Description |
---|---|---|
attributes |
Attributs du certificat (facultatif). |
|
policy |
Stratégie de gestion du certificat. |
|
tags |
object |
Métadonnées spécifiques d’application sous la forme de paires clé/valeur. |
CertificateOperation
Une opération de certificat est retournée en cas de demandes asynchrones.
Nom | Type | Description |
---|---|---|
cancellation_requested |
boolean |
Indique si l’annulation a été demandée sur l’opération de certificat. |
csr |
string |
Demande de signature de certificat (CSR) utilisée dans l’opération de certificat. |
error |
Une erreur s’est produite, le cas échéant, pendant l’opération de certificat. |
|
id |
string |
ID de certificat. |
issuer |
Paramètres de l’émetteur du composant X509 d’un certificat. |
|
request_id |
string |
Identificateur de l’opération de certificat. |
status |
string |
État de l’opération de certificat. |
status_details |
string |
Le status détails de l’opération de certificat. |
target |
string |
Emplacement qui contient le résultat de l’opération de certificat. |
CertificatePolicy
Stratégie de gestion pour un certificat.
Nom | Type | Description |
---|---|---|
attributes |
Attributs de certificat. |
|
id |
string |
ID de certificat. |
issuer |
Paramètres de l’émetteur du composant X509 d’un certificat. |
|
key_props |
Propriétés de la clé qui soutient un certificat. |
|
lifetime_actions |
Actions qui seront effectuées par Key Vault sur la durée de vie d’un certificat. |
|
secret_props |
Propriétés du secret qui soutient un certificat. |
|
x509_props |
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, vidage lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant 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 définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel 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, la suppression 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 que l’abonnement est annulé. |
Purgeable |
string |
Indique 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 (par exemple, vidage). 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 supprimera définitivement après 90 jours, s’il n’est pas récupéré |
Recoverable+ProtectedSubscription |
string |
Indique 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 le vidage) 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 la suppression immédiate et définitive (c’est-à-dire le vidage). 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 que 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 |
Erreur du serveur du coffre de clés. |
|
message |
string |
Message d’erreur. |
IssuerParameters
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 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 sauvegardent un certificat.
Nom | Type | Description |
---|---|---|
crv |
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. Une 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 |
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
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 |
Erreur du serveur du coffre de clés. |
LifetimeAction
Action et son déclencheur qui seront exécutés par Key Vault sur la durée de vie d’un certificat.
Nom | Type | Description |
---|---|---|
action |
Action qui sera exécutée. |
|
trigger |
Condition qui exécutera l’action. |
SecretProperties
Propriétés de la clé qui soutient 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 |
Définit la façon dont la clé du certificat peut être utilisée. |
|
sans |
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. |