Import Certificate - Import Certificate

Referens

Service:: Key Vault

API Version:: 7.4

Importerar ett certifikat till ett angivet nyckelvalv.
Importerar ett befintligt giltigt certifikat som innehåller en privat nyckel till Azure Key Vault. Den här åtgärden kräver certifikat-/importbehörighet. Certifikatet som ska importeras kan vara i antingen PFX- eller PEM-format. Om certifikatet är i PEM-format måste PEM-filen innehålla både nyckeln och x509-certifikaten. Key Vault accepterar bara en nyckel i PKCS#8-format.

POST {vaultBaseUrl}/certificates/{certificate-name}/import?api-version=7.4

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
certificate-name	path	True	string	Namnet på certifikatet. Det värde som du anger kan kopieras globalt i syfte att köra tjänsten. Det angivna värdet bör inte innehålla personligt identifierbar eller känslig information. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Valvnamnet, till exempel https://myvault.vault.azure.net.
api-version	query	True	string	Klient-API-version.

certificate-name

path

True

string

Namnet på certifikatet. Det värde som du anger kan kopieras globalt i syfte att köra tjänsten. Det angivna värdet bör inte innehålla personligt identifierbar eller känslig information.

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

Valvnamnet, till exempel https://myvault.vault.azure.net.

api-version

query

True

string

Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
value	True	string	Base64-kodad representation av certifikatobjektet som ska importeras. Det här certifikatet måste innehålla den privata nyckeln.
attributes		CertificateAttributes	Certifikatets attribut (valfritt).
policy		CertificatePolicy	Hanteringsprincipen för certifikatet.
pwd		string	Om den privata nyckeln i base64EncodedCertificate är krypterad används lösenordet för kryptering.
tags		object	Programspecifika metadata i form av nyckel/värde-par.

Svar

Name	Typ	Description
200 OK	CertificateBundle	Importerat certifikatpaket till valvet.
Other Status Codes	KeyVaultError	Key Vault felsvar som beskriver varför åtgärden misslyckades.

Exempel

ImportCertificate

Sample Request

HTTP

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

Status code:: 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": "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
    }
  }
}

Definitioner

Name	Description
Action	Den åtgärd som ska utföras.
CertificateAttributes	Certifikathanteringsattributen.
CertificateBundle	Ett certifikatpaket består av ett certifikat (X509) plus dess attribut.
CertificateImportParameters	Parametrarna för certifikatimport.
CertificatePolicy	Hanteringsprincip för ett certifikat.
CertificatePolicyAction	Typen av åtgärd.
DeletionRecoveryLevel	Visar den återställningsnivå för borttagning som för närvarande gäller för certifikat i det aktuella valvet. Om det innehåller "Rensningsbart" kan certifikatet tas bort permanent av en privilegierad användare. Annars kan endast systemet rensa certifikatet i slutet av kvarhållningsintervallet.
Error	Nyckelvalvsserverfelet.
IssuerParameters	Parametrar för utfärdaren av X509-komponenten för ett certifikat.
JsonWebKeyCurveName	Elliptiskt kurvnamn. Giltiga värden finns i JsonWebKeyCurveName.
JsonWebKeyType	Typ av nyckelpar som ska användas för certifikatet.
KeyProperties	Egenskaper för nyckelparet som stöder ett certifikat.
KeyUsageType	Definierar hur certifikatets nyckel kan användas.
KeyVaultError	Felfelet för nyckelvalvet.
LifetimeAction	Åtgärd och dess utlösare som ska utföras av Key Vault under ett certifikats livslängd.
SecretProperties	Egenskaper för nyckeln som säkerhetskopierar ett certifikat.
SubjectAlternativeNames	Alternativt namn på ett X509-objekt.
Trigger	Ett villkor som ska uppfyllas för att en åtgärd ska köras.
X509CertificateProperties	Egenskaper för X509-komponenten för ett certifikat.

Action

Den åtgärd som ska utföras.

Name	Typ	Description
action_type	CertificatePolicyAction	Typen av åtgärd.

CertificateAttributes

Certifikathanteringsattributen.

Name	Typ	Description
created	integer	Skapandetid i UTC.
enabled	boolean	Avgör om objektet är aktiverat.
exp	integer	Förfallodatum i UTC.
nbf	integer	Inte före datum i UTC.
recoverableDays	integer	softTa bort datakvarhållningsdagar. Värdet ska vara >=7 och <=90 när softDelete är aktiverat, annars 0.
recoveryLevel	DeletionRecoveryLevel	Visar den återställningsnivå för borttagning som för närvarande gäller för certifikat i det aktuella valvet. Om det innehåller "Rensningsbart" kan certifikatet tas bort permanent av en privilegierad användare. Annars kan endast systemet rensa certifikatet i slutet av kvarhållningsintervallet.
updated	integer	Senast uppdaterad tid i UTC.

CertificateBundle

Ett certifikatpaket består av ett certifikat (X509) plus dess attribut.

Name	Typ	Description
attributes	CertificateAttributes	Certifikatattributen.
cer	string	CER-innehåll i x509-certifikat.
contentType	string	Hemlighetens innehållstyp. t.ex. "application/x-pem-file" eller "application/x-pkcs12",
id	string	Certifikat-ID:t.
kid	string	Nyckel-ID:t.
policy	CertificatePolicy	Hanteringsprincipen.
sid	string	Det hemliga ID:t.
tags	object	Programspecifika metadata i form av nyckel/värde-par
x5t	string	Tumavtryck för certifikatet.

CertificateImportParameters

Parametrarna för certifikatimport.

Name	Typ	Description
attributes	CertificateAttributes	Certifikatets attribut (valfritt).
policy	CertificatePolicy	Hanteringsprincipen för certifikatet.
pwd	string	Om den privata nyckeln i base64EncodedCertificate är krypterad används lösenordet för kryptering.
tags	object	Programspecifika metadata i form av nyckel/värde-par.
value	string	Base64-kodad representation av certifikatobjektet som ska importeras. Det här certifikatet måste innehålla den privata nyckeln.

CertificatePolicy

Hanteringsprincip för ett certifikat.

Name	Typ	Description
attributes	CertificateAttributes	Certifikatattributen.
id	string	Certifikat-ID:t.
issuer	IssuerParameters	Parametrar för utfärdaren av X509-komponenten för ett certifikat.
key_props	KeyProperties	Egenskaper för nyckeln som säkerhetskopierar ett certifikat.
lifetime_actions	LifetimeAction[]	Åtgärder som ska utföras av Key Vault under ett certifikats livslängd.
secret_props	SecretProperties	Egenskaper för hemligheten som stöder ett certifikat.
x509_props	X509CertificateProperties	Egenskaper för X509-komponenten för ett certifikat.

CertificatePolicyAction

Typen av åtgärd.

Name	Typ	Description
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för certifikat i det aktuella valvet. Om det innehåller "Rensningsbart" kan certifikatet tas bort permanent av en privilegierad användare. Annars kan endast systemet rensa certifikatet i slutet av kvarhållningsintervallet.

Name	Typ	Description
CustomizedRecoverable	string	Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig.
CustomizedRecoverable+ProtectedSubscription	string	Anger ett valv- och prenumerationstillstånd där borttagning kan återställas, omedelbar och permanent borttagning (dvs. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent när 7<= SoftDeleteRetentionInDays < 90. Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och återspeglar även det faktum att själva prenumerationen inte kan avbrytas.
CustomizedRecoverable+Purgeable	string	Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts.
Purgeable	string	Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligen förlorade när en borttagningsåtgärd accepteras på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)
Recoverable	string	Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Recoverable+ProtectedSubscription	string	Anger ett valv- och prenumerationstillstånd där borttagning kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (dvs. rensning) är inte tillåtet och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Recoverable+Purgeable	string	Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (t.ex. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs

Error

Nyckelvalvsserverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Nyckelvalvsserverfelet.
message	string	Felmeddelandet.

IssuerParameters

Parametrar för utfärdaren av X509-komponenten för ett certifikat.

Name	Typ	Description
cert_transparency	boolean	Anger om de certifikat som genereras under den här principen ska publiceras i certifikattransparensloggar.
cty	string	Certifikattyp som stöds av providern (valfritt); till exempel "OV-SSL", "EV-SSL"
name	string	Namnet på det refererade utfärdarobjektet eller reserverade namn. till exempel "Self" eller "Unknown".

JsonWebKeyCurveName

Elliptiskt kurvnamn. Giltiga värden finns i JsonWebKeyCurveName.

Name	Typ	Description
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

Typ av nyckelpar som ska användas för certifikatet.

Name	Typ	Description
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Egenskaper för nyckelparet som stöder ett certifikat.

Name	Typ	Description
crv	JsonWebKeyCurveName	Elliptiskt kurvnamn. Giltiga värden finns i JsonWebKeyCurveName.
exportable	boolean	Anger om den privata nyckeln kan exporteras. Versionsprincip måste anges när du skapar den första versionen av en exporterbar nyckel.
key_size	integer	Nyckelstorleken i bitar. Exempel: 2048, 3072 eller 4096 för RSA.
kty	JsonWebKeyType	Typ av nyckelpar som ska användas för certifikatet.
reuse_key	boolean	Anger om samma nyckelpar ska användas vid certifikatförnyelse.

KeyUsageType

Definierar hur certifikatets nyckel kan användas.

Name	Typ	Description
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Nyckelvalvsserverfelet.

LifetimeAction

Åtgärd och dess utlösare som ska utföras av Key Vault under ett certifikats livslängd.

Name	Typ	Description
action	Action	Den åtgärd som ska utföras.
trigger	Trigger	Villkoret som ska köra åtgärden.

SecretProperties

Egenskaper för nyckeln som säkerhetskopierar ett certifikat.

Name	Typ	Description
contentType	string	Medietypen (MIME-typ).

SubjectAlternativeNames

Alternativt namn på ett X509-objekt.

Name	Typ	Description
dns_names	string[]	Domännamn.
emails	string[]	Email adresser.
upns	string[]	Användarens huvudnamn.

Trigger

Ett villkor som ska uppfyllas för att en åtgärd ska köras.

Name	Typ	Description
days_before_expiry	integer	Dagar före förfallodatum för att försöka förnya. Värdet ska vara mellan 1 och validity_in_months multiplicerat med 27. Om validity_in_months är 36 ska värdet vara mellan 1 och 972 (36 * 27).
lifetime_percentage	integer	Procentandel av livslängden som ska utlösas. Värdet ska vara mellan 1 och 99.

X509CertificateProperties

Egenskaper för X509-komponenten för ett certifikat.

Name	Typ	Description
ekus	string[]	Den förbättrade nyckelanvändningen.
key_usage	KeyUsageType[]	Definierar hur certifikatets nyckel kan användas.
sans	SubjectAlternativeNames	Alternativt namn på ämne.
subject	string	Ämnesnamnet. Bör vara ett giltigt X509-unikt namn.
validity_months	integer	Varaktigheten för certifikatet är giltigt i månader.

Share via

Import Certificate - Import Certificate

URI-parametrar

Begärandetext

Svar

Exempel

ImportCertificate

Sample Request

Sample Response

Definitioner

Action

CertificateAttributes

CertificateBundle

CertificateImportParameters

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Ytterligare resurser