Import Certificate - Import Certificate
Importiert ein Zertifikat in einen angegebenen Schlüsseltresor.
Importiert ein vorhandenes gültiges Zertifikat mit einem privaten Schlüssel in Azure Key Vault. Für diesen Vorgang ist die Berechtigung für Zertifikate bzw. den Import erforderlich. Das zu importierende Zertifikat kann im PFX- oder PEM-Format vorliegen. Wenn das Zertifikat im PEM-Format vorliegt, muss die PEM-Datei sowohl den Schlüssel als auch x509-Zertifikate enthalten. Key Vault akzeptiert nur einen Schlüssel im PKCS#8-Format.
POST {vaultBaseUrl}/certificates/{certificate-name}/import?api-version=7.4
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
certificate-name
|
path | True |
string |
Der Name des Zertifikats. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der bereitgestellte Wert sollte keine persönlich identifizierbaren oder sensiblen Informationen enthalten. Regex pattern: |
vault
|
path | True |
string |
Der Tresorname, z. B https://myvault.vault.azure.net. . |
api-version
|
query | True |
string |
Client-API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
value | True |
string |
Base64-codierte Darstellung des zu importierenden Zertifikatobjekts. Dieses Zertifikat muss den privaten Schlüssel enthalten. |
attributes |
Die Attribute des Zertifikats (optional). |
||
policy |
Die Verwaltungsrichtlinie für das Zertifikat. |
||
pwd |
string |
Wenn der private Schlüssel in base64EncodedCertificate verschlüsselt ist, wird das kennwort für die Verschlüsselung verwendet. |
|
tags |
object |
Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Importiertes Zertifikatpaket in den Tresor. |
|
Other Status Codes |
Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Beispiele
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
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Action |
Die Aktion, die ausgeführt wird. |
Certificate |
Die Zertifikatverwaltungsattribute. |
Certificate |
Ein Zertifikatpaket besteht aus einem Zertifikat (X509) und seinen Attributen. |
Certificate |
Die Parameter für den Zertifikatimport. |
Certificate |
Verwaltungsrichtlinie für ein Zertifikat. |
Certificate |
Der Typ der Aktion. |
Deletion |
Gibt die Löschwiederherstellungsebene an, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer dauerhaft gelöscht werden. Andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls bereinigen. |
Error |
Der Schlüsseltresorserverfehler. |
Issuer |
Parameter für den Aussteller der X509-Komponente eines Zertifikats. |
Json |
Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
Json |
Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll. |
Key |
Eigenschaften des Schlüsselpaars, das ein Zertifikat sichert. |
Key |
Definiert, wie der Schlüssel des Zertifikats verwendet werden kann. |
Key |
Die Schlüsseltresorfehler-Ausnahme. |
Lifetime |
Aktion und der zugehörige Trigger, der von Key Vault während der Lebensdauer eines Zertifikats ausgeführt wird. |
Secret |
Eigenschaften des Schlüssels, der ein Zertifikat sichert. |
Subject |
Die alternativen Antragstellernamen eines X509-Objekts. |
Trigger |
Eine Bedingung, die erfüllt werden muss, damit eine Aktion ausgeführt wird. |
X509Certificate |
Eigenschaften der X509-Komponente eines Zertifikats. |
Action
Die Aktion, die ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
action_type |
Der Typ der Aktion. |
CertificateAttributes
Die Zertifikatverwaltungsattribute.
Name | Typ | Beschreibung |
---|---|---|
created |
integer |
Erstellungszeit in UTC. |
enabled |
boolean |
Bestimmt, ob das Objekt aktiviert ist. |
exp |
integer |
Ablaufdatum in UTC. |
nbf |
integer |
Nicht vor Datum in UTC. |
recoverableDays |
integer |
softDelete Datenaufbewahrungstage. Der Wert sollte =7 und <=90 sein>, wenn softDelete aktiviert ist, andernfalls 0. |
recoveryLevel |
Gibt die Löschwiederherstellungsebene an, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer dauerhaft gelöscht werden. Andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls bereinigen. |
|
updated |
integer |
Uhrzeit der letzten Aktualisierung in UTC. |
CertificateBundle
Ein Zertifikatpaket besteht aus einem Zertifikat (X509) und seinen Attributen.
Name | Typ | Beschreibung |
---|---|---|
attributes |
Die Zertifikatattribute. |
|
cer |
string |
CER-Inhalt des x509-Zertifikats. |
contentType |
string |
Der Inhaltstyp des Geheimnisses. Beispiel: "application/x-pem-file" oder "application/x-pkcs12", |
id |
string |
Die Zertifikat-ID. |
kid |
string |
Die Schlüssel-ID. |
policy |
Die Verwaltungsrichtlinie. |
|
sid |
string |
Die Geheimnis-ID. |
tags |
object |
Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren |
x5t |
string |
Fingerabdruck des Zertifikats |
CertificateImportParameters
Die Parameter für den Zertifikatimport.
Name | Typ | Beschreibung |
---|---|---|
attributes |
Die Attribute des Zertifikats (optional). |
|
policy |
Die Verwaltungsrichtlinie für das Zertifikat. |
|
pwd |
string |
Wenn der private Schlüssel in base64EncodedCertificate verschlüsselt ist, wird das Kennwort für die Verschlüsselung verwendet. |
tags |
object |
Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren. |
value |
string |
Base64-codierte Darstellung des zu importierenden Zertifikatobjekts. Dieses Zertifikat muss den privaten Schlüssel enthalten. |
CertificatePolicy
Verwaltungsrichtlinie für ein Zertifikat.
Name | Typ | Beschreibung |
---|---|---|
attributes |
Die Zertifikatattribute. |
|
id |
string |
Die Zertifikat-ID. |
issuer |
Parameter für den Aussteller der X509-Komponente eines Zertifikats. |
|
key_props |
Eigenschaften des Schlüssels, der ein Zertifikat sichert. |
|
lifetime_actions |
Aktionen, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden. |
|
secret_props |
Eigenschaften des Geheimnisses, das ein Zertifikat sichert. |
|
x509_props |
Eigenschaften der X509-Komponente eines Zertifikats. |
CertificatePolicyAction
Der Typ der Aktion.
Name | Typ | Beschreibung |
---|---|---|
AutoRenew |
string |
|
EmailContacts |
string |
DeletionRecoveryLevel
Gibt die Löschwiederherstellungsebene an, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer dauerhaft gelöscht werden. Andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls bereinigen.
Name | Typ | Beschreibung |
---|---|---|
CustomizedRecoverable |
string |
Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, ohne die Möglichkeit einer sofortigen und dauerhaften Löschung zu haben (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist. |
CustomizedRecoverable+ProtectedSubscription |
string |
Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht gekündigt werden kann. |
CustomizedRecoverable+Purgeable |
string |
Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, und der auch das sofortige und dauerhafte Löschen zulässt (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, es wird ein Bereinigungsvorgang angefordert oder das Abonnement gekündigt. |
Purgeable |
string |
Gibt einen Tresorzustand an, bei dem das Löschen ein irreversibler Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Ebene entspricht keinem Schutz vor einem Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn Sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren. |
Recoverable |
string |
Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, ohne die Möglichkeit einer sofortigen und dauerhaften Löschung (d. h. Löschen) zu haben. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und solange das Abonnement noch verfügbar ist. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird |
Recoverable+ProtectedSubscription |
string |
Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb eines Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird |
Recoverable+Purgeable |
string |
Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, und der auch das sofortige und dauerhafte Löschen (d. h. Löschen) zulässt. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, ein Bereinigungsvorgang wird angefordert oder das Abonnement wird gekündigt. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird |
Error
Der Schlüsseltresorserverfehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
innererror |
Der Schlüsseltresorserverfehler. |
|
message |
string |
Die Fehlermeldung. |
IssuerParameters
Parameter für den Aussteller der X509-Komponente eines Zertifikats.
Name | Typ | Beschreibung |
---|---|---|
cert_transparency |
boolean |
Gibt an, ob die unter dieser Richtlinie generierten Zertifikate in Zertifikattransparenzprotokollen veröffentlicht werden sollen. |
cty |
string |
Zertifikattyp, der vom Anbieter unterstützt wird (optional); z. B. "OV-SSL", "EV-SSL" |
name |
string |
Name des referenzierten Ausstellerobjekts oder reservierter Namen; z. B. "Selbst" oder "Unbekannt". |
JsonWebKeyCurveName
Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
Name | Typ | Beschreibung |
---|---|---|
P-256 |
string |
|
P-256K |
string |
|
P-384 |
string |
|
P-521 |
string |
JsonWebKeyType
Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
EC |
string |
|
EC-HSM |
string |
|
RSA |
string |
|
RSA-HSM |
string |
|
oct |
string |
|
oct-HSM |
string |
KeyProperties
Eigenschaften des Schlüsselpaars, das ein Zertifikat sichert.
Name | Typ | Beschreibung |
---|---|---|
crv |
Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
|
exportable |
boolean |
Gibt an, ob der private Schlüssel exportiert werden kann. Die Releaserichtlinie muss beim Erstellen der ersten Version eines exportierbaren Schlüssels bereitgestellt werden. |
key_size |
integer |
Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA. |
kty |
Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll. |
|
reuse_key |
boolean |
Gibt an, ob dasselbe Schlüsselpaar bei der Zertifikatverlängerung verwendet wird. |
KeyUsageType
Definiert, wie der Schlüssel des Zertifikats verwendet werden kann.
Name | Typ | Beschreibung |
---|---|---|
cRLSign |
string |
|
dataEncipherment |
string |
|
decipherOnly |
string |
|
digitalSignature |
string |
|
encipherOnly |
string |
|
keyAgreement |
string |
|
keyCertSign |
string |
|
keyEncipherment |
string |
|
nonRepudiation |
string |
KeyVaultError
Die Schlüsseltresorfehler-Ausnahme.
Name | Typ | Beschreibung |
---|---|---|
error |
Der Schlüsseltresorserverfehler. |
LifetimeAction
Aktion und der zugehörige Trigger, der von Key Vault während der Lebensdauer eines Zertifikats ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
action |
Die Aktion, die ausgeführt wird. |
|
trigger |
Die Bedingung, die die Aktion ausführt. |
SecretProperties
Eigenschaften des Schlüssels, der ein Zertifikat sichert.
Name | Typ | Beschreibung |
---|---|---|
contentType |
string |
Der Medientyp (MIME-Typ). |
SubjectAlternativeNames
Die alternativen Antragstellernamen eines X509-Objekts.
Name | Typ | Beschreibung |
---|---|---|
dns_names |
string[] |
Domänennamen. |
emails |
string[] |
E-Mail-Adressen |
upns |
string[] |
Benutzerprinzipalnamen. |
Trigger
Eine Bedingung, die erfüllt werden muss, damit eine Aktion ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
days_before_expiry |
integer |
Tage vor Ablauf des Verlängerungsversuchs. Der Wert sollte zwischen 1 und validity_in_months multipliziert mit 27 sein. Wenn validity_in_months 36 ist, sollte der Wert zwischen 1 und 972 (36 * 27) sein. |
lifetime_percentage |
integer |
Prozentsatz der Lebensdauer, bei der ausgelöst werden soll. Der Wert sollte zwischen 1 und 99 sein. |
X509CertificateProperties
Eigenschaften der X509-Komponente eines Zertifikats.
Name | Typ | Beschreibung |
---|---|---|
ekus |
string[] |
Die erweiterte Schlüsselverwendung. |
key_usage |
Definiert, wie der Schlüssel des Zertifikats verwendet werden kann. |
|
sans |
Die alternativen Antragstellernamen. |
|
subject |
string |
Der Name des Subjekts. Sollte ein gültiger distinguished X509-Name sein. |
validity_months |
integer |
Die Gültigkeitsdauer des Zertifikats in Monaten. |