Import Certificate - Import Certificate
Hiermee importeert u een certificaat in een opgegeven sleutelkluis.
Hiermee importeert u een bestaand geldig certificaat met een persoonlijke sleutel in Azure Key Vault. Voor deze bewerking is de machtiging certificaten/importeren vereist. Het certificaat dat moet worden geïmporteerd, kan de PFX- of PEM-indeling hebben. Als het certificaat de PEM-indeling heeft, moet het PEM-bestand de sleutel en x509-certificaten bevatten. Key Vault accepteert alleen een sleutel in PKCS#8-indeling.
POST {vaultBaseUrl}/certificates/{certificate-name}/import?api-version=7.4
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
certificate-name
|
path | True |
string |
De naam van het certificaat. De waarde die u opgeeft, kan globaal worden gekopieerd om de service uit te voeren. De opgegeven waarde mag geen persoonsgegevens of gevoelige informatie bevatten. Regex pattern: |
vault
|
path | True |
string |
De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Client-API-versie. |
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 |
De kenmerken van het certificaat (optioneel). |
||
policy |
Het beheerbeleid voor het certificaat. |
||
pwd |
string |
Als de persoonlijke sleutel in base64EncodedCertificate is versleuteld, wordt het wachtwoord gebruikt voor versleuteling. |
|
tags |
object |
Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Geïmporteerde certificaatbundel in de kluis. |
|
Other Status Codes |
Key Vault foutbericht waarin wordt beschreven waarom de bewerking is mislukt. |
Voorbeelden
ImportCertificate
Sample Request
POST https://myvault.vault.azure.net//certificates/importCert01/import?api-version=7.4
{
"value": "MIIJ...",
"pwd": "123",
"policy": {
"key_props": {
"exportable": true,
"kty": "RSA",
"key_size": 2048,
"reuse_key": false
},
"secret_props": {
"contentType": "application/x-pkcs12"
}
}
}
Sample Response
{
"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": "MIIC...",
"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 wordt uitgevoerd. |
Certificate |
De certificaatbeheerkenmerken. |
Certificate |
Een certificaatbundel bestaat uit een certificaat (X509) plus de bijbehorende kenmerken. |
Certificate |
De parameters voor het importeren van certificaten. |
Certificate |
Beheerbeleid voor een certificaat. |
Certificate |
Het type actie. |
Deletion |
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 bevoegde gebruiker; Anders kan alleen het systeem het certificaat aan het einde van het retentie-interval leegmaken. |
Error |
De sleutelkluisserverfout. |
Issuer |
Parameters voor de verlener van het X509-onderdeel van een certificaat. |
Json |
Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. |
Json |
Het type sleutelpaar dat moet worden gebruikt voor het certificaat. |
Key |
Eigenschappen van het sleutelpaar dat achter een certificaat staat. |
Key |
Definieert hoe de sleutel van het certificaat mag worden gebruikt. |
Key |
De foutuitzondering voor de sleutelkluis. |
Lifetime |
De actie en de trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een certificaat. |
Secret |
Eigenschappen van de sleutel die een certificaat back-up. |
Subject |
De alternatieve onderwerpnamen van een X509-object. |
Trigger |
Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren. |
X509Certificate |
Eigenschappen van het X509-onderdeel van een certificaat. |
Action
De actie die wordt uitgevoerd.
Name | Type | Description |
---|---|---|
action_type |
Het type actie. |
CertificateAttributes
De certificaatbeheerkenmerken.
Name | Type | Description |
---|---|---|
created |
integer |
Aanmaaktijd in UTC. |
enabled |
boolean |
Bepaalt of het object is ingeschakeld. |
exp |
integer |
Vervaldatum in UTC. |
nbf |
integer |
Niet vóór datum in UTC. |
recoverableDays |
integer |
softDelete dagen voor gegevensretentie. De waarde moet =7 en <=90 zijn wanneer softDelete is >ingeschakeld, anders 0. |
recoveryLevel |
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 bevoegde gebruiker; Anders kan alleen het systeem het certificaat aan het einde van het retentie-interval leegmaken. |
|
updated |
integer |
Tijdstip laatst bijgewerkt in UTC. |
CertificateBundle
Een certificaatbundel bestaat uit een certificaat (X509) plus de bijbehorende kenmerken.
Name | Type | Description |
---|---|---|
attributes |
De certificaatkenmerken. |
|
cer |
string |
CER-inhoud van x509-certificaat. |
contentType |
string |
Het inhoudstype van het geheim. bijvoorbeeld 'application/x-pem-file' of 'application/x-pkcs12', |
id |
string |
De certificaat-id. |
kid |
string |
De sleutel-id. |
policy |
Het beheerbeleid. |
|
sid |
string |
De geheime id. |
tags |
object |
Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen |
x5t |
string |
Vingerafdruk van het certificaat. |
CertificateImportParameters
De parameters voor het importeren van certificaten.
Name | Type | Description |
---|---|---|
attributes |
De kenmerken van het certificaat (optioneel). |
|
policy |
Het beheerbeleid voor het certificaat. |
|
pwd |
string |
Als de persoonlijke sleutel in base64EncodedCertificate is versleuteld, wordt het wachtwoord gebruikt voor versleuteling. |
tags |
object |
Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen. |
value |
string |
Met Base64 gecodeerde weergave van het certificaatobject dat moet worden geïmporteerd. Dit certificaat moet de persoonlijke sleutel bevatten. |
CertificatePolicy
Beheerbeleid voor een certificaat.
Name | Type | Description |
---|---|---|
attributes |
De certificaatkenmerken. |
|
id |
string |
De certificaat-id. |
issuer |
Parameters voor de verlener van het X509-onderdeel van een certificaat. |
|
key_props |
Eigenschappen van de sleutel die een certificaat back-up. |
|
lifetime_actions |
Acties die worden uitgevoerd door Key Vault gedurende de levensduur van een certificaat. |
|
secret_props |
Eigenschappen van de geheime back-up van een certificaat. |
|
x509_props |
Eigenschappen van het X509-onderdeel van een certificaat. |
CertificatePolicyAction
Het type actie.
Name | Type | Description |
---|---|---|
AutoRenew |
string |
|
EmailContacts |
string |
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 bevoegde gebruiker; Anders kan alleen het systeem het certificaat aan het einde van het retentie-interval leegmaken.
Name | Type | Description |
---|---|---|
CustomizedRecoverable |
string |
Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is. |
CustomizedRecoverable+ProtectedSubscription |
string |
Geeft een kluis- en abonnementstatus aan waarin verwijdering kan worden hersteld, onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd. |
CustomizedRecoverable+Purgeable |
string |
Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. |
Purgeable |
string |
Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Verwijderbewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort) |
Recoverable |
string |
Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld |
Recoverable+ProtectedSubscription |
string |
Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een retentieperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld |
Recoverable+Purgeable |
string |
Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen leegmaken). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld |
Error
De sleutelkluisserverfout.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
innererror |
De sleutelkluisserverfout. |
|
message |
string |
Het foutbericht. |
IssuerParameters
Parameters voor de verlener van het X509-onderdeel van een certificaat.
Name | Type | Description |
---|---|---|
cert_transparency |
boolean |
Hiermee wordt aangegeven of de certificaten die onder dit beleid zijn gegenereerd, moeten worden gepubliceerd naar certificaattransparantielogboeken. |
cty |
string |
Certificaattype zoals ondersteund door de provider (optioneel); bijvoorbeeld 'OV-SSL', 'EV-SSL' |
name |
string |
Naam van het object of de gereserveerde namen van de verlener waarnaar wordt verwezen; bijvoorbeeld 'Zelf' of 'Onbekend'. |
JsonWebKeyCurveName
Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
Name | Type | Description |
---|---|---|
P-256 |
string |
|
P-256K |
string |
|
P-384 |
string |
|
P-521 |
string |
JsonWebKeyType
Het type sleutelpaar dat moet worden gebruikt voor het certificaat.
Name | Type | Description |
---|---|---|
EC |
string |
|
EC-HSM |
string |
|
RSA |
string |
|
RSA-HSM |
string |
|
oct |
string |
|
oct-HSM |
string |
KeyProperties
Eigenschappen van het sleutelpaar dat achter een certificaat staat.
Name | Type | Description |
---|---|---|
crv |
Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. |
|
exportable |
boolean |
Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. Releasebeleid moet worden opgegeven bij het maken van de eerste versie van een exporteerbare sleutel. |
key_size |
integer |
De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA. |
kty |
Het type sleutelpaar dat moet worden gebruikt voor het certificaat. |
|
reuse_key |
boolean |
Geeft aan of hetzelfde sleutelpaar wordt gebruikt bij het vernieuwen van certificaten. |
KeyUsageType
Definieert hoe de sleutel van het certificaat mag worden gebruikt.
Name | Type | Description |
---|---|---|
cRLSign |
string |
|
dataEncipherment |
string |
|
decipherOnly |
string |
|
digitalSignature |
string |
|
encipherOnly |
string |
|
keyAgreement |
string |
|
keyCertSign |
string |
|
keyEncipherment |
string |
|
nonRepudiation |
string |
KeyVaultError
De foutuitzondering voor de sleutelkluis.
Name | Type | Description |
---|---|---|
error |
De sleutelkluisserverfout. |
LifetimeAction
De actie en de trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een certificaat.
Name | Type | Description |
---|---|---|
action |
De actie die wordt uitgevoerd. |
|
trigger |
De voorwaarde waarmee de actie wordt uitgevoerd. |
SecretProperties
Eigenschappen van de sleutel die een certificaat back-up.
Name | Type | Description |
---|---|---|
contentType |
string |
Het mediatype (MIME-type). |
SubjectAlternativeNames
De alternatieve onderwerpnamen van een X509-object.
Name | Type | Description |
---|---|---|
dns_names |
string[] |
Domeinnamen. |
emails |
string[] |
Email adressen. |
upns |
string[] |
Principal-namen van gebruikers. |
Trigger
Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.
Name | Type | Description |
---|---|---|
days_before_expiry |
integer |
Dagen voor het verlopen om te proberen te verlengen. De waarde moet tussen 1 en validity_in_months vermenigvuldigd met 27. Als validity_in_months 36 is, moet de waarde tussen 1 en 972 (36 * 27) zijn. |
lifetime_percentage |
integer |
Percentage van de levensduur waarvoor moet worden geactiveerd. De waarde moet tussen 1 en 99 zijn. |
X509CertificateProperties
Eigenschappen van het X509-onderdeel van een certificaat.
Name | Type | Description |
---|---|---|
ekus |
string[] |
Het verbeterde sleutelgebruik. |
key_usage |
Definieert hoe de sleutel van het certificaat mag worden gebruikt. |
|
sans |
De alternatieve onderwerpnamen. |
|
subject |
string |
De onderwerpnaam. Moet een geldige X509 DN-naam zijn. |
validity_months |
integer |
De duur van het certificaat is in maanden geldig. |