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.3

URI-Parameter

Name In Required Type Description
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: ^[0-9a-zA-Z-]+$

vaultBaseUrl
path True
  • string

Der Tresorname, z. B https://myvault.vault.azure.net. .

api-version
query True
  • string

Client-API-Version.

Anforderungstext

Name Required Type Description
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 Type Description
200 OK

Importiertes Zertifikatbündel 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.3

{
  "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

Action

Die Aktion, die ausgeführt wird.

ActionType

Der Typ der Aktion.

CertificateAttributes

Die Zertifikatverwaltungsattribute.

CertificateBundle

Ein Zertifikatbündel besteht aus einem Zertifikat (X509) und seinen Attributen.

CertificateImportParameters

Die Parameter für den Zertifikatimport.

CertificatePolicy

Verwaltungsrichtlinie für ein Zertifikat.

DeletionRecoveryLevel

Spiegelt die Löschwiederherstellungsstufe wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden; andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen.

Error

Fehler des Schlüsseltresorservers.

IssuerParameters

Parameter für den Aussteller der X509-Komponente eines Zertifikats.

JsonWebKeyCurveName

Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName.

JsonWebKeyType

Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.

KeyProperties

Eigenschaften des Schlüsselpaars, das ein Zertifikat gesichert.

KeyVaultError

Ausnahme des Schlüsseltresorfehlers.

LifetimeAction

Aktion und dessen Auslöser, die von Key Vault über die Lebensdauer eines Zertifikats ausgeführt werden.

SecretProperties

Eigenschaften des Schlüssels, der ein Zertifikat gesichert.

SubjectAlternativeNames

Der Betreff alternative Namen eines X509-Objekts.

Trigger

Eine Bedingung, die erfüllt werden soll, damit eine Aktion ausgeführt werden kann.

X509CertificateProperties

Eigenschaften der X509-Komponente eines Zertifikats.

Action

Die Aktion, die ausgeführt wird.

Name Type Description
action_type

Der Typ der Aktion.

ActionType

Der Typ der Aktion.

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

Die Zertifikatverwaltungsattribute.

Name Type Description
created
  • integer

Erstellungszeit in UTC.

enabled
  • boolean

Bestimmt, ob das Objekt aktiviert ist.

exp
  • integer

Ablaufdatum in UTC.

nbf
  • integer

Nicht vor dem Datum in UTC.

recoverableDays
  • integer

softDelete Datenaufbewahrungstage. Der Wert sollte =7 und <=90 sein>, wenn softDelete aktiviert ist, andernfalls 0.

recoveryLevel

Spiegelt die Löschwiederherstellungsstufe wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden; andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen.

updated
  • integer

Letzte Aktualisierungszeit in UTC.

CertificateBundle

Ein Zertifikatbündel besteht aus einem Zertifikat (X509) und seinen Attributen.

Name Type Description
attributes

Die Zertifikatattribute.

cer
  • string

CER-Inhalt des x509-Zertifikats.

contentType
  • string

Der Inhaltstyp des geheimen Schlüssels. 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 geheime ID.

tags
  • object

Anwendungsspezifische Metadaten in Form von Schlüsselwertpaaren

x5t
  • string

Fingerabdruck des Zertifikats

CertificateImportParameters

Die Parameter für den Zertifikatimport.

Name Type Description
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 Type Description
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 gesichert.

lifetime_actions

Aktionen, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden.

secret_props

Eigenschaften des geheimen Schlüssels, der ein Zertifikat gesichert.

x509_props

Eigenschaften der X509-Komponente eines Zertifikats.

DeletionRecoveryLevel

Spiegelt die Löschwiederherstellungsstufe wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden; andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen.

Name Type Description
CustomizedRecoverable
  • string

Gibt einen Tresorstatus an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (d. h. löschen, wenn 7<= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und während der Verfügbarkeit des Abonnements.

CustomizedRecoverable+ProtectedSubscription
  • string

Gibt einen Tresor und einen Abonnementstatus an, in dem löschungsfähig, sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft abgebrochen werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht storniert werden kann.

CustomizedRecoverable+Purgeable
  • string

Gibt einen Tresorstatus an, in dem das Löschen wiederherstellbar ist und auch sofortiges und dauerhaftes Löschen ermöglicht (d. h. löschen, wenn 7<= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, ein Bereinigungsvorgang wird angefordert, oder das Abonnement wird abgebrochen.

Purgeable
  • string

Gibt einen Tresorstatus an, in dem das Löschen ein unumkehrbarer Vorgang ist, ohne dass die Wiederherstellung möglich ist. Diese Stufe entspricht keinem Schutz, der gegen einen Löschvorgang verfügbar ist; die Daten verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher annehmen (Tresor, Ressourcengruppe, Abonnement usw.)

Recoverable
  • string

Gibt einen Tresorstatus an, in dem die Löschung ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (z. B. Löschvorgang). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und während das Abonnement noch verfügbar ist. Das System wird es nach 90 Tagen endgültig löschen, falls nicht wiederhergestellt

Recoverable+ProtectedSubscription
  • string

Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb des Aufbewahrungsintervalls (90 Tage), sofortiges und dauerhaftes Löschen (z. B. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft abgebrochen werden kann. Das System wird es nach 90 Tagen endgültig löschen, falls nicht wiederhergestellt

Recoverable+Purgeable
  • string

Gibt einen Tresorstatus an, in dem löschungsfähig ist und die auch sofortige und permanente Löschung (z. B. Löschvorgang) ermöglicht. Diese Stufe 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 abgebrochen. Das System wird es nach 90 Tagen endgültig löschen, falls nicht wiederhergestellt

Error

Fehler des Schlüsseltresorservers.

Name Type Description
code
  • string

Der Fehlercode.

innererror

Fehler des Schlüsseltresorservers.

message
  • string

Die Fehlermeldung.

IssuerParameters

Parameter für den Aussteller der X509-Komponente eines Zertifikats.

Name Type Description
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); Beispiel: "OV-SSL", "EV-SSL"

name
  • string

Name des referenzierten Ausstellerobjekts oder reservierter Namen; Beispiel: "Self" oder "Unknown".

JsonWebKeyCurveName

Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName.

Name Type Description
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 Type Description
EC
  • string
EC-HSM
  • string
RSA
  • string
RSA-HSM
  • string
oct
  • string
oct-HSM
  • string

KeyProperties

Eigenschaften des Schlüsselpaars, das ein Zertifikat gesichert.

Name Type Description
crv

Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName.

exportable
  • boolean

Gibt an, ob der private Schlüssel exportiert werden kann. Die Releaserichtlinie muss bereitgestellt werden, wenn Sie die 1. Version eines exportierbaren Schlüssels erstellen.

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.

KeyVaultError

Ausnahme des Schlüsseltresorfehlers.

Name Type Description
error

Fehler des Schlüsseltresorservers.

LifetimeAction

Aktion und dessen Auslöser, die von Key Vault über die Lebensdauer eines Zertifikats ausgeführt werden.

Name Type Description
action

Die Aktion, die ausgeführt wird.

trigger

Die Bedingung, die die Aktion ausführt.

SecretProperties

Eigenschaften des Schlüssels, der ein Zertifikat gesichert.

Name Type Description
contentType
  • string

Der Medientyp (MIME-Typ).

SubjectAlternativeNames

Der Betreff alternative Namen eines X509-Objekts.

Name Type Description
dns_names
  • string[]

Domänennamen.

emails
  • string[]

E-Mail-Adressen

upns
  • string[]

Benutzerprinzipalnamen.

Trigger

Eine Bedingung, die erfüllt werden soll, damit eine Aktion ausgeführt werden kann.

Name Type Description
days_before_expiry
  • integer

Tage vor Ablauf, um die Verlängerung zu versuchen. Der Wert sollte zwischen 1 und validity_in_months mit 27 multipliziert sein. Wenn validity_in_months 36 ist, sollte der Wert zwischen 1 und 972 (36 * 27) betragen.

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 Type Description
ekus
  • string[]

Die erweiterte Schlüsselverwendung.

key_usage
  • string[]

Liste der Schlüsselverwendungen.

sans

Die Alternativen Namen des Betreffs.

subject
  • string

Der Name des Subjekts. Sollte ein gültiger X509-Eindeutiger Name sein.

validity_months
  • integer

Die Dauer, für die das Zertifikat in Monaten gültig ist.