Import Certificate - Import Certificate

Importuje certyfikat do określonego magazynu kluczy.
Importuje istniejący prawidłowy certyfikat zawierający klucz prywatny do usługi Azure Key Vault. Ta operacja wymaga uprawnień do certyfikatów/importu. Certyfikat do zaimportowania może być w formacie PFX lub PEM. Jeśli certyfikat jest w formacie PEM, plik PEM musi zawierać klucz, a także certyfikaty x509. Key Vault będzie akceptować tylko klucz w formacie PKCS#8.

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

Parametry identyfikatora URI

Name In Required Type Description
certificate-name
path True
  • string

Nazwa certyfikatu. Wartość, którą podajesz, może zostać skopiowana globalnie na potrzeby uruchamiania usługi. Podana wartość nie powinna zawierać danych osobowych ani poufnych.

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

vaultBaseUrl
path True
  • string

Nazwa magazynu, na przykład https://myvault.vault.azure.net.

api-version
query True
  • string

Wersja interfejsu API klienta.

Treść żądania

Name Required Type Description
value True
  • string

Zakodowana w formacie Base64 reprezentacja obiektu certyfikatu do zaimportowania. Ten certyfikat musi zawierać klucz prywatny.

attributes

Atrybuty certyfikatu (opcjonalnie).

policy

Zasady zarządzania certyfikatu.

pwd
  • string

Jeśli klucz prywatny w metodzie base64EncodedCertificate jest szyfrowany, hasło używane do szyfrowania.

tags
  • object

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

Odpowiedzi

Name Type Description
200 OK

Zaimportowany pakiet certyfikatów do magazynu.

Other Status Codes

Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

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

Definicje

Action

Akcja, która zostanie wykonana.

ActionType

Typ akcji.

CertificateAttributes

Atrybuty zarządzania certyfikatami.

CertificateBundle

Pakiet certyfikatów składa się z certyfikatu (X509) oraz jego atrybutów.

CertificateImportParameters

Parametry importowania certyfikatu.

CertificatePolicy

Zasady zarządzania dla certyfikatu.

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.

Error

Błąd serwera magazynu kluczy.

IssuerParameters

Parametry wystawcy składnika X509 certyfikatu.

JsonWebKeyCurveName

Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.

JsonWebKeyType

Typ pary kluczy do użycia dla certyfikatu.

KeyProperties

Właściwości pary kluczy kopii zapasowej certyfikatu.

KeyVaultError

Wyjątek błędu magazynu kluczy.

LifetimeAction

Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.

SecretProperties

Właściwości klucza kopii zapasowej certyfikatu.

SubjectAlternativeNames

Alternatywne nazwy podmiotu obiektu X509.

Trigger

Warunek, który ma zostać spełniony, aby wykonać akcję.

X509CertificateProperties

Właściwości składnika X509 certyfikatu.

Action

Akcja, która zostanie wykonana.

Name Type Description
action_type

Typ akcji.

ActionType

Typ akcji.

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

Atrybuty zarządzania certyfikatami.

Name Type Description
created
  • integer

Czas tworzenia w formacie UTC.

enabled
  • boolean

Określa, czy obiekt jest włączony.

exp
  • integer

Data wygaśnięcia w formacie UTC.

nbf
  • integer

Nie wcześniej niż data w formacie UTC.

recoverableDays
  • integer

softDelete data retention days (dni przechowywania danych softDelete). Wartość powinna mieć wartość >=7 i <=90, gdy funkcja softDelete jest włączona, w przeciwnym razie wartość 0.

recoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.

updated
  • integer

Czas ostatniej aktualizacji w formacie UTC.

CertificateBundle

Pakiet certyfikatów składa się z certyfikatu (X509) oraz jego atrybutów.

Name Type Description
attributes

Atrybuty certyfikatu.

cer
  • string

Zawartość certyfikatu CER x509.

contentType
  • string

Typ zawartości wpisu tajnego. np. "application/x-pem-file" lub "application/x-pkcs12",

id
  • string

Identyfikator certyfikatu.

kid
  • string

Identyfikator klucza.

policy

Zasady zarządzania.

sid
  • string

Identyfikator wpisu tajnego.

tags
  • object

Metadane specyficzne dla aplikacji w postaci par klucz-wartość

x5t
  • string

Odcisk palca certyfikatu.

CertificateImportParameters

Parametry importowania certyfikatu.

Name Type Description
attributes

Atrybuty certyfikatu (opcjonalnie).

policy

Zasady zarządzania certyfikatu.

pwd
  • string

Jeśli klucz prywatny w formacie base64EncodedCertificate jest szyfrowany, hasło używane do szyfrowania.

tags
  • object

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

value
  • string

Zakodowana w formacie Base64 reprezentacja obiektu certyfikatu do zaimportowania. Ten certyfikat musi zawierać klucz prywatny.

CertificatePolicy

Zasady zarządzania dla certyfikatu.

Name Type Description
attributes

Atrybuty certyfikatu.

id
  • string

Identyfikator certyfikatu.

issuer

Parametry wystawcy składnika X509 certyfikatu.

key_props

Właściwości klucza kopii zapasowej certyfikatu.

lifetime_actions

Akcje, które będą wykonywane przez Key Vault w okresie istnienia certyfikatu.

secret_props

Właściwości wpisu tajnego do tworzenia kopii zapasowej certyfikatu.

x509_props

Właściwości składnika X509 certyfikatu.

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.

Name Type Description
CustomizedRecoverable
  • string

Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.

CustomizedRecoverable+ProtectedSubscription
  • string

Określa magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7<= SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.

CustomizedRecoverable+Purgeable
  • string

Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w przedziale czasu przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana.

Purgeable
  • string

Określa stan magazynu, w którym usunięcie jest nieodwracalną operacją bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuń na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)

Recoverable
  • string

Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane

Recoverable+ProtectedSubscription
  • string

Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w interwale przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane

Recoverable+Purgeable
  • string

Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane

Error

Błąd serwera magazynu kluczy.

Name Type Description
code
  • string

Kod błędu.

innererror

Błąd serwera magazynu kluczy.

message
  • string

Komunikat o błędzie.

IssuerParameters

Parametry wystawcy składnika X509 certyfikatu.

Name Type Description
cert_transparency
  • boolean

Wskazuje, czy certyfikaty wygenerowane w ramach tych zasad powinny być publikowane w dziennikach przejrzystości certyfikatów.

cty
  • string

Typ certyfikatu obsługiwany przez dostawcę (opcjonalnie); na przykład "OV-SSL", "EV-SSL"

name
  • string

Nazwa przywoływana nazwa obiektu wystawcy lub nazw zarezerwowanych; na przykład "Self" lub "Unknown".

JsonWebKeyCurveName

Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.

Name Type Description
P-256
  • string
P-256K
  • string
P-384
  • string
P-521
  • string

JsonWebKeyType

Typ pary kluczy do użycia dla certyfikatu.

Name Type Description
EC
  • string
EC-HSM
  • string
RSA
  • string
RSA-HSM
  • string
oct
  • string
oct-HSM
  • string

KeyProperties

Właściwości pary kluczy kopii zapasowej certyfikatu.

Name Type Description
crv

Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.

exportable
  • boolean

Wskazuje, czy klucz prywatny można wyeksportować. Zasady wydania należy podać podczas tworzenia 1. wersji klucza możliwego do wyeksportowania.

key_size
  • integer

Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA.

kty

Typ pary kluczy do użycia dla certyfikatu.

reuse_key
  • boolean

Wskazuje, czy ta sama para kluczy zostanie użyta podczas odnawiania certyfikatu.

KeyVaultError

Wyjątek błędu magazynu kluczy.

Name Type Description
error

Błąd serwera magazynu kluczy.

LifetimeAction

Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.

Name Type Description
action

Akcja, która zostanie wykonana.

trigger

Warunek, który wykona akcję.

SecretProperties

Właściwości klucza kopii zapasowej certyfikatu.

Name Type Description
contentType
  • string

Typ nośnika (typ MIME).

SubjectAlternativeNames

Alternatywne nazwy podmiotu obiektu X509.

Name Type Description
dns_names
  • string[]

Nazwy domen.

emails
  • string[]

Email adresy.

upns
  • string[]

Główne nazwy użytkownika.

Trigger

Warunek, który ma zostać spełniony, aby wykonać akcję.

Name Type Description
days_before_expiry
  • integer

Dni przed wygaśnięciem próby odnowienia. Wartość powinna należeć do przedziału od 1 do validity_in_months pomnożona przez 27. Jeśli validity_in_months wynosi 36, wartość powinna należeć do zakresu od 1 do 972 (36 * 27).

lifetime_percentage
  • integer

Procent okresu istnienia, w którym ma być wyzwalany. Wartość powinna należeć do zakresu od 1 do 99.

X509CertificateProperties

Właściwości składnika X509 certyfikatu.

Name Type Description
ekus
  • string[]

Rozszerzone użycie klucza.

key_usage
  • string[]

Lista użycia kluczy.

sans

Alternatywne nazwy podmiotu.

subject
  • string

Nazwa podmiotu. Powinna być prawidłową nazwą wyróżniającą X509.

validity_months
  • integer

Czas trwania certyfikatu jest ważny w miesiącach.