Import Certificate - Import Certificate

Service:

Key Vault

API-versie:

2025-07-01

Importeert een certificaat in een opgegeven sleutelkluis.
Importeert een bestaand geldig certificaat, dat een persoonlijke sleutel bevat, in Azure Key Vault. Voor deze bewerking is toestemming voor certificaten/importeren vereist. Het te importeren certificaat kan in PFX- of PEM-formaat zijn. Als het certificaat in PEM-formaat is, moet het PEM-bestand zowel de sleutel als x509-certificaten bevatten. Key Vault accepteert alleen een sleutel in PKCS#8-formaat.

POST {vaultBaseUrl}/certificates/{certificate-name}/import?api-version=2025-07-01

URI-parameters

Name	In	Vereist	Type	Description
certificate-name	path	True	string pattern: ^[0-9a-zA-Z-]+$	De naam van het certificaat. De waarde die u levert, kan wereldwijd worden gekopieerd met het oog op het uitvoeren van de service. De verstrekte waarde mag geen persoonlijk identificeerbare of gevoelige informatie bevatten.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
value	True	string	Base64 gecodeerde weergave van het certificaatobject dat moet worden geïmporteerd. Dit certificaat moet de persoonlijke sleutel bevatten.
attributes		CertificateAttributes	De attributen van het certificaat (optioneel).
policy		CertificatePolicy	Het beheerbeleid voor het certificaat.
preserveCertOrder		boolean	Hiermee geeft u op of de certificaatketen de oorspronkelijke volgorde behoudt. De standaardwaarde is false, waardoor het leaf-certificaat op index 0 wordt gezet.
pwd		string	Als de persoonlijke sleutel in base64EncodedCertificate is versleuteld, is het wachtwoord dat is gebruikt voor de versleuteling.
tags		object	Applicatiespecifieke metadata in de vorm van sleutel-waardeparen.

Antwoorden

Name	Type	Description
200 OK	CertificateBundle	De aanvraag is voltooid.
Other Status Codes	KeyVaultError	Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://vault.azure.net/.default

Voorbeelden

ImportCertificate

Voorbeeldaanvraag

HTTP

POST https://myvault.vault.azure.net//certificates/importCert01/import?api-version=2025-07-01

{
  "value": "MIIJ...",
  "pwd": "123",
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    }
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "id": "https://myvault.vault.azure.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "kid": "https://myvault.vault.azure.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "sid": "https://myvault.vault.azure.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MII++cut+for+brevity++EPAQj8",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938557,
    "updated": 1493938557,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/importCert01/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": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938557,
      "updated": 1493938557
    }
  }
}

Definities

Name	Description
Action	De actie die zal worden uitgevoerd.
CertificateAttributes	De kenmerken van certificaatbeheer.
CertificateBundle	Een certificaatbundel bestaat uit een certificaat (X509) plus de attributen.
CertificateImportParameters	De parameters voor het importeren van certificaten.
CertificatePolicy	Beheersbeleid voor een certificaat.
CertificatePolicyAction	Het type actie.
DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Purgeable' bevat, kan het geheim permanent worden verwijderd door een geprivilegieerde gebruiker; Anders kan alleen het systeem het geheim opschonen, aan het einde van het bewaarinterval.
Error
IssuerParameters	Parameters voor de uitgever van het X509-onderdeel van een certificaat.
JsonWebKeyCurveName	Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
JsonWebKeyType	Het type sleutelpaar dat voor het certificaat moet worden gebruikt.
KeyProperties	Eigenschappen van het sleutelpaar dat een certificaat ondersteunt.
KeyUsageType	Ondersteund gebruik van een certificaatsleutel.
KeyVaultError	De uitzondering voor de sleutelkluisfout.
LifetimeAction	Actie en de bijbehorende trigger die door Key Vault wordt uitgevoerd gedurende de levensduur van een certificaat.
SecretProperties	Eigenschappen van de sleutel die een certificaat ondersteunt.
SubjectAlternativeNames	Het onderwerp Alternatieve namen van een X509-object.
Trigger	Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.
X509CertificateProperties	Eigenschappen van het X509-onderdeel van een certificaat.

Action

Object

De actie die zal worden uitgevoerd.

Name	Type	Description
action_type	CertificatePolicyAction	Het type actie.

CertificateAttributes

Object

De kenmerken van certificaatbeheer.

Name	Type	Description
created	integer (unixtime)	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer (unixtime)	Vervaldatum in UTC.
nbf	integer (unixtime)	Niet voor datum in UTC.
recoverableDays	integer (int32)	softDelete-gegevensretentiedagen. De waarde moet =7 en >=90 zijn <wanneer softDelete is ingeschakeld, anders 0.
recoveryLevel	DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Purgeable' bevat, kan het certificaat permanent worden verwijderd door een geprivilegieerde gebruiker; Anders kan alleen het systeem het certificaat opschonen aan het einde van het bewaarinterval.
updated	integer (unixtime)	Laatst bijgewerkte tijd in UTC.

CertificateBundle

Object

Een certificaatbundel bestaat uit een certificaat (X509) plus de attributen.

Name	Type	Description
attributes	CertificateAttributes	De kenmerken van het certificaat.
cer	string (byte)	CER inhoud van x509 certificaat.
contentType	string	Het inhoudstype van het geheim. eg. 'application/x-pem-file' of 'application/x-pkcs12'.
id	string	De certificaat-id.
kid	string	De sleutel-id.
policy	CertificatePolicy	Het beheerbeleid.
preserveCertOrder	boolean	Hiermee geeft u op of de certificaatketen de oorspronkelijke volgorde behoudt. De standaardwaarde is false, waardoor het leaf-certificaat op index 0 wordt gezet.
sid	string	De geheime id.
tags	object	Applicatiespecifieke metadata in de vorm van sleutel-waardeparen.
x5t	string (base64url)	Vingerafdruk van het certificaat.

CertificateImportParameters

Object

De parameters voor het importeren van certificaten.

Name	Type	Description
attributes	CertificateAttributes	De attributen van het certificaat (optioneel).
policy	CertificatePolicy	Het beheerbeleid voor het certificaat.
preserveCertOrder	boolean	Hiermee geeft u op of de certificaatketen de oorspronkelijke volgorde behoudt. De standaardwaarde is false, waardoor het leaf-certificaat op index 0 wordt gezet.
pwd	string	Als de persoonlijke sleutel in base64EncodedCertificate is versleuteld, is het wachtwoord dat is gebruikt voor de versleuteling.
tags	object	Applicatiespecifieke metadata in de vorm van sleutel-waardeparen.
value	string	Base64 gecodeerde weergave van het certificaatobject dat moet worden geïmporteerd. Dit certificaat moet de persoonlijke sleutel bevatten.

CertificatePolicy

Object

Beheersbeleid voor een certificaat.

Name	Type	Description
attributes	CertificateAttributes	De kenmerken van het certificaat.
id	string	De certificaat-id.
issuer	IssuerParameters	Parameters voor de uitgever van het X509-onderdeel van een certificaat.
key_props	KeyProperties	Eigenschappen van de sleutel die een certificaat ondersteunt.
lifetime_actions	LifetimeAction[]	Acties die door Key Vault worden uitgevoerd gedurende de levensduur van een certificaat.
secret_props	SecretProperties	Eigenschappen van het geheim dat een certificaat ondersteunt.
x509_props	X509CertificateProperties	Eigenschappen van het X509-onderdeel van een certificaat.

CertificatePolicyAction

Inventarisatie

Het type actie.

Waarde	Description
EmailContacts	Een certificaatbeleid waarmee certificaatcontactpersonen worden gemaild.
AutoRenew	Een certificaatbeleid waarmee een certificaat automatisch wordt vernieuwd.

DeletionRecoveryLevel

Inventarisatie

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Purgeable' bevat, kan het geheim permanent worden verwijderd door een geprivilegieerde gebruiker; Anders kan alleen het systeem het geheim opschonen, aan het einde van het bewaarinterval.

Waarde	Description
Purgeable	Geeft een kluisstatus aan waarin verwijdering een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen beveiliging beschikbaar is tegen een Delete-bewerking; de gegevens zijn onherstelbaar verloren gegaan bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement enz.)
Recoverable+Purgeable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering (d.w.z. opschonen) toestaat. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen), tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, als het niet wordt hersteld
Recoverable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid van onmiddellijke en permanente verwijdering (d.w.z. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en terwijl het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, als het niet wordt hersteld
Recoverable+ProtectedSubscription	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen het bewaarinterval (90 dagen), onmiddellijke en permanente verwijdering (d.w.z. opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, als het niet wordt hersteld
CustomizedRecoverable+Purgeable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.z. opschonen wanneer 7 <= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
CustomizedRecoverable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid van onmiddellijke en permanente verwijdering (d.w.z. opschonen wanneer 7 <= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval en terwijl het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld, onmiddellijke en permanente verwijdering (d.w.z. opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd wanneer 7 <= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.

Error

Object

Name	Type	Description
code	string	De foutcode.
innererror	Error	De fout van de sleutelkluisserver.
message	string	Het foutbericht.

IssuerParameters

Object

Parameters voor de uitgever van het X509-onderdeel van een certificaat.

Name	Type	Description
cert_transparency	boolean	Geeft aan of de certificaten die op grond van dit beleid zijn gegenereerd, moeten worden gepubliceerd in de logboeken voor certificaattransparantie.
cty	string	Certificaattype zoals ondersteund door de provider (optioneel); bijvoorbeeld 'OV-SSL', 'EV-SSL'
name	string	Naam van het emittentobject waarnaar wordt verwezen of gereserveerde namen; bijvoorbeeld 'Zelf' of 'Onbekend'.

JsonWebKeyCurveName

Inventarisatie

Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.

Waarde	Description
P-256	De NIST P-256 elliptische curve, ook bekend als SECG-curve SECP256R1.
P-384	De NIST P-384 elliptische curve, ook bekend als SECG-curve SECP384R1.
P-521	De NIST P-521 elliptische curve, ook bekend als SECG-curve SECP521R1.
P-256K	De SECG SECP256K1 elliptische curve.

JsonWebKeyType

Inventarisatie

Het type sleutelpaar dat voor het certificaat moet worden gebruikt.

Waarde	Description
EC	Elliptische curve.
EC-HSM	Elliptische curve met een privésleutel die niet kan worden geëxporteerd vanuit de HSM.
RSA	RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM	RSA met een private sleutel die niet exporteerbaar is vanuit de HSM.
oct	Octetreeks (gebruikt om symmetrische toetsen weer te geven).
oct-HSM	Octet-sequentie met een privésleutel die niet kan worden geëxporteerd vanuit de HSM.

KeyProperties

Object

Eigenschappen van het sleutelpaar dat een certificaat ondersteunt.

Name	Type	Description
crv	JsonWebKeyCurveName	Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
exportable	boolean	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. Er moet een releasebeleid worden opgegeven bij het maken van de eerste versie van een exporteerbare sleutel.
key_size	integer (int32)	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.
kty	JsonWebKeyType	Het type sleutelpaar dat voor het certificaat moet worden gebruikt.
reuse_key	boolean	Geeft aan of hetzelfde sleutelpaar wordt gebruikt bij de vernieuwing van het certificaat.

KeyUsageType

Inventarisatie

Ondersteund gebruik van een certificaatsleutel.

Waarde	Description
digitalSignature	Geeft aan dat de certificaatsleutel kan worden gebruikt als digitale handtekening.
nonRepudiation	Geeft aan dat de certificaatsleutel kan worden gebruikt voor verificatie.
keyEncipherment	Geeft aan dat de certificaatsleutel kan worden gebruikt voor sleutelversleuteling.
dataEncipherment	Geeft aan dat de certificaatsleutel kan worden gebruikt voor gegevensversleuteling.
keyAgreement	Geeft aan dat de certificaatsleutel kan worden gebruikt om de sleutelovereenkomst te bepalen, zoals een sleutel die is gemaakt met behulp van het algoritme voor de Diffie-Hellman sleutelovereenkomst.
keyCertSign	Geeft aan dat de certificaatsleutel kan worden gebruikt om certificaten te ondertekenen.
cRLSign	Geeft aan dat de certificaatsleutel kan worden gebruikt om een certificaatintrekkingslijst te ondertekenen.
encipherOnly	Geeft aan dat de certificaatsleutel alleen voor versleuteling kan worden gebruikt.
decipherOnly	Geeft aan dat de certificaatsleutel alleen kan worden gebruikt voor ontsleuteling.

KeyVaultError

Object

De uitzondering voor de sleutelkluisfout.

Name	Type	Description
error	Error	De fout van de sleutelkluisserver.

LifetimeAction

Object

Actie en de bijbehorende trigger die door Key Vault wordt uitgevoerd gedurende de levensduur van een certificaat.

Name	Type	Description
action	Action	De actie die zal worden uitgevoerd.
trigger	Trigger	De voorwaarde waarmee de actie wordt uitgevoerd.

SecretProperties

Object

Eigenschappen van de sleutel die een certificaat ondersteunt.

Name	Type	Description
contentType	string	Het mediatype (MIME-type).

SubjectAlternativeNames

Object

Het onderwerp Alternatieve namen van een X509-object.

Name	Type	Description
dns_names	string[]	Domeinnamen.
emails	string[]	E-mailadressen.
ipAddresses	string[]	IP-adressen; ondersteunt IPv4 en IPv6.
upns	string[]	Namen van gebruikers-principals.
uris	string[]	Uniforme resource-ID's.

Trigger

Object

Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.

Name	Type	Description
days_before_expiry	integer (int32)	Dagen voor de vervaldatum om te proberen te verlengen. De waarde moet tussen 1 en validity_in_months vermenigvuldigd met 27 liggen. Als validity_in_months 36 is, moet de waarde tussen 1 en 972 liggen (36 * 27).
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Percentage van de levensduur waarop moet worden geactiveerd. De waarde moet tussen 1 en 99 liggen.

X509CertificateProperties

Object

Eigenschappen van het X509-onderdeel van een certificaat.

Name	Type	Description
ekus	string[]	Het verbeterde sleutelgebruik.
key_usage	KeyUsageType[]	Definieert hoe de sleutel van het certificaat kan worden gebruikt.
sans	SubjectAlternativeNames	Het onderwerp alternatieve namen.
subject	string	De naam van het onderwerp. Moet een geldige X509 voorname naam zijn.
validity_months	integer (int32) minimum: 0	De geldigheidsduur van het certificaat in maanden.