Import Certificate - Import Certificate

Reference

Service:: Key Vault

API Version:: 7.4

Importuje certifikát do zadaného trezoru klíčů.
Importuje existující platný certifikát obsahující privátní klíč do Azure Key Vault. Tato operace vyžaduje oprávnění k importu certifikátů. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, soubor PEM musí obsahovat klíč i certifikáty x509. Key Vault přijme pouze klíč ve formátu PKCS#8.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
certificate-name	path	True	string	Název certifikátu. Zadaná hodnota se může globálně zkopírovat za účelem spuštění služby. Zadaná hodnota by neměla zahrnovat identifikovatelné osobní údaje ani citlivé informace. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze klientského rozhraní API

certificate-name

path

True

string

Název certifikátu. Zadaná hodnota se může globálně zkopírovat za účelem spuštění služby. Zadaná hodnota by neměla zahrnovat identifikovatelné osobní údaje ani citlivé informace.

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

vaultBaseUrl

path

True

string

Název trezoru, například https://myvault.vault.azure.net.

api-version

query

True

string

Verze klientského rozhraní API

Text požadavku

Name	Vyžadováno	Typ	Description
value	True	string	Base64 kódovaná reprezentace objektu certifikátu, který se má importovat. Tento certifikát musí obsahovat privátní klíč.
attributes		CertificateAttributes	Atributy certifikátu (volitelné).
policy		CertificatePolicy	Zásady správy pro certifikát.
pwd		string	Pokud je privátní klíč v base64EncodedCertificate šifrovaný, heslo použité k šifrování.
tags		object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

Odpovědi

Name	Typ	Description
200 OK	CertificateBundle	Importovaná sada certifikátů do trezoru
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující příčinu selhání operace.

Příklady

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
    }
  }
}

Definice

Name	Description
Action	Akce, která se provede.
CertificateAttributes	Atributy správy certifikátů.
CertificateBundle	Sada certifikátů se skládá z certifikátu (X509) a jeho atributů.
CertificateImportParameters	Parametry importu certifikátu.
CertificatePolicy	Zásady správy pro certifikát
CertificatePolicyAction	Typ akce.
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Purgeable", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.
Error	Chyba serveru trezoru klíčů.
IssuerParameters	Parametry pro vystavitele součásti X509 certifikátu.
JsonWebKeyCurveName	Název elliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
JsonWebKeyType	Typ páru klíčů, který se má použít pro certifikát.
KeyProperties	Vlastnosti páru klíčů, který je záložním certifikátem.
KeyUsageType	Definuje způsob použití klíče certifikátu.
KeyVaultError	Výjimka chyby trezoru klíčů
LifetimeAction	Akce a její aktivační událost, kterou budou provádět Key Vault po celou dobu životnosti certifikátu.
SecretProperties	Vlastnosti klíče, který je záložním certifikátem.
SubjectAlternativeNames	Alternativní názvy subjektu objektu X509.
Trigger	Podmínka, která musí být splněna pro provedení akce.
X509CertificateProperties	Vlastnosti součásti X509 certifikátu.

Action

Akce, která se provede.

Name	Typ	Description
action_type	CertificatePolicyAction	Typ akce.

CertificateAttributes

Atributy správy certifikátů.

Name	Typ	Description
created	integer	Čas vytvoření ve standardu UTC
enabled	boolean	Určuje, zda je objekt povolen.
exp	integer	Datum vypršení platnosti v UTC.
nbf	integer	Není před datem ve standardu UTC.
recoverableDays	integer	softDelete data retention days. Pokud je povolená funkce softDelete, hodnota by měla být >=7 a <=90, jinak 0.
recoveryLevel	DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Purgeable", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.
updated	integer	Čas poslední aktualizace v UTC.

CertificateBundle

Sada certifikátů se skládá z certifikátu (X509) a jeho atributů.

Name	Typ	Description
attributes	CertificateAttributes	Atributy certifikátu.
cer	string	Obsah certifikátu x509.
contentType	string	Typ obsahu tajného kódu. např. 'application/x-pem-file' nebo 'application/x-pkcs12',
id	string	ID certifikátu.
kid	string	ID klíče.
policy	CertificatePolicy	Zásady správy.
sid	string	ID tajného kódu
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota
x5t	string	Kryptografický otisk certifikátu

CertificateImportParameters

Parametry importu certifikátu.

Name	Typ	Description
attributes	CertificateAttributes	Atributy certifikátu (volitelné).
policy	CertificatePolicy	Zásady správy pro certifikát.
pwd	string	Pokud je privátní klíč v base64EncodedCertificate zašifrovaný, heslo použité k šifrování.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.
value	string	Kódování Base64 reprezentace objektu certifikátu k importu. Tento certifikát musí obsahovat privátní klíč.

CertificatePolicy

Zásady správy pro certifikát

Name	Typ	Description
attributes	CertificateAttributes	Atributy certifikátu.
id	string	ID certifikátu.
issuer	IssuerParameters	Parametry pro vystavitele součásti X509 certifikátu.
key_props	KeyProperties	Vlastnosti klíče, který je záložním certifikátem.
lifetime_actions	LifetimeAction[]	Akce, které budou provádět Key Vault po celou dobu životnosti certifikátu.
secret_props	SecretProperties	Vlastnosti tajného klíče, který je záložním certifikátem.
x509_props	X509CertificateProperties	Vlastnosti součásti X509 certifikátu.

CertificatePolicyAction

Typ akce.

Name	Typ	Description
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Purgeable", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.

Name	Typ	Description
CustomizedRecoverable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription	string	Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, když 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.
CustomizedRecoverable+Purgeable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není vyžadována operace vyprázdnění nebo se nezruší předplatné.
Purgeable	string	Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá žádné ochraně není k dispozici proti operaci Odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde k nenávratné ztrátě dat.
Recoverable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a po dobu, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Recoverable+ProtectedSubscription	string	Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vyprázdnění) není povoleno a ve kterém nelze trvale zrušit samotné předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Recoverable+Purgeable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud se nevyžádá operace vyprázdnění nebo se nezruší předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví

Error

Chyba serveru trezoru klíčů.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva

IssuerParameters

Parametry pro vystavitele součásti X509 certifikátu.

Name	Typ	Description
cert_transparency	boolean	Určuje, jestli se mají certifikáty vygenerované v rámci této zásady publikovat v protokolech transparentnosti certifikátů.
cty	string	Typ certifikátu podporovaný poskytovatelem (volitelné); například 'OV-SSL', 'EV-SSL'
name	string	Název objektu odkazovaného vystavitele nebo rezervovaných názvů; Například "Já" nebo "Neznámý".

JsonWebKeyCurveName

Název elliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.

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

JsonWebKeyType

Typ páru klíčů, který se má použít pro certifikát.

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

KeyProperties

Vlastnosti páru klíčů, který je záložním certifikátem.

Name	Typ	Description
crv	JsonWebKeyCurveName	Název elliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
exportable	boolean	Určuje, jestli je možné privátní klíč exportovat. Při vytváření první verze exportovatelného klíče je potřeba zadat zásady vydané verze.
key_size	integer	Velikost klíče v bitech. Příklad: 2048, 3072 nebo 4096 pro RSA.
kty	JsonWebKeyType	Typ páru klíčů, který se má použít pro certifikát.
reuse_key	boolean	Určuje, jestli se při prodloužení platnosti certifikátu použije stejný pár klíčů.

KeyUsageType

Definuje způsob použití klíče certifikátu.

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

KeyVaultError

Výjimka chyby trezoru klíčů

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

LifetimeAction

Akce a její aktivační událost, kterou budou provádět Key Vault po celou dobu životnosti certifikátu.

Name	Typ	Description
action	Action	Akce, která se provede.
trigger	Trigger	Podmínka, která provede akci.

SecretProperties

Vlastnosti klíče, který je záložním certifikátem.

Name	Typ	Description
contentType	string	Typ média (typ MIME).

SubjectAlternativeNames

Alternativní názvy subjektu objektu X509.

Name	Typ	Description
dns_names	string[]	Názvy domén.
emails	string[]	Email adresy.
upns	string[]	Hlavní názvy uživatelů.

Trigger

Podmínka, která musí být splněna pro provedení akce.

Name	Typ	Description
days_before_expiry	integer	Počet dní před vypršením platnosti k pokusu o prodloužení. Hodnota by měla být v rozsahu od 1 do validity_in_months vynásobená 27. Pokud je validity_in_months 36, měla by být hodnota mezi 1 a 972 (36 × 27).
lifetime_percentage	integer	Procento doby života, po kterou se má aktivovat. Hodnota by měla být mezi 1 a 99.

X509CertificateProperties

Vlastnosti součásti X509 certifikátu.

Name	Typ	Description
ekus	string[]	Rozšířené použití klíče.
key_usage	KeyUsageType[]	Definuje způsob použití klíče certifikátu.
sans	SubjectAlternativeNames	Alternativní názvy podmětů
subject	string	Název subjektu. Měl by být platný rozlišující název X509.
validity_months	integer	Doba platnosti certifikátu v měsících.

Sdílet prostřednictvím

Import Certificate - Import Certificate

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

ImportCertificate

Sample Request

Sample Response

Definice

Action

CertificateAttributes

CertificateBundle

CertificateImportParameters

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Další materiály