Import Certificate - Import Certificate

Referensi

Service:: Key Vault

API Version:: 7.4

Mengimpor sertifikat ke dalam brankas kunci tertentu.
Mengimpor sertifikat valid yang sudah ada, yang berisi kunci privat, ke azure Key Vault. Operasi ini memerlukan izin sertifikat/impor. Sertifikat yang akan diimpor dapat berada dalam format PFX atau PEM. Jika sertifikat dalam format PEM, file PEM harus berisi kunci serta sertifikat x509. Key Vault hanya akan menerima kunci dalam format PKCS#8.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi

Nama	Dalam	Diperlukan	Jenis	Deskripsi
certificate-name	path	True	string	Nama sertifikat. Nilai yang Anda berikan dapat disalin secara global untuk tujuan menjalankan layanan. Nilai yang diberikan tidak boleh menyertakan informasi pribadi yang dapat diidentifikasi atau informasi yang sensitif. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Nama vault, misalnya https://myvault.vault.azure.net.
api-version	query	True	string	Versi API klien.

certificate-name

path

True

string

Nama sertifikat. Nilai yang Anda berikan dapat disalin secara global untuk tujuan menjalankan layanan. Nilai yang diberikan tidak boleh menyertakan informasi pribadi yang dapat diidentifikasi atau informasi yang sensitif.

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

vaultBaseUrl

path

True

string

Nama vault, misalnya https://myvault.vault.azure.net.

api-version

query

True

string

Versi API klien.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
value	True	string	Representasi objek sertifikat yang dikodekan Base64 untuk diimpor. Sertifikat ini perlu berisi kunci privat.
attributes		CertificateAttributes	Atribut sertifikat (opsional).
policy		CertificatePolicy	Kebijakan manajemen untuk sertifikat.
pwd		string	Jika kunci privat di base64EncodedCertificate dienkripsi, kata sandi yang digunakan untuk enkripsi.
tags		object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Respons

Nama	Jenis	Deskripsi
200 OK	CertificateBundle	Bundel sertifikat yang diimpor ke vault.
Other Status Codes	KeyVaultError	Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

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

Definisi

Nama	Deskripsi
Action	Tindakan yang akan dijalankan.
CertificateAttributes	Atribut manajemen sertifikat.
CertificateBundle	Bundel sertifikat terdiri dari sertifikat (X509) ditambah atributnya.
CertificateImportParameters	Parameter impor sertifikat.
CertificatePolicy	Kebijakan manajemen untuk sertifikat.
CertificatePolicyAction	Jenis tindakan.
DeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk sertifikat di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', sertifikat dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh sertifikat, di akhir interval retensi.
Error	Kesalahan server brankas kunci.
IssuerParameters	Parameter untuk penerbit komponen X509 sertifikat.
JsonWebKeyCurveName	Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
JsonWebKeyType	Jenis pasangan kunci yang akan digunakan untuk sertifikat.
KeyProperties	Properti pasangan kunci yang mendukung sertifikat.
KeyUsageType	Menentukan bagaimana kunci sertifikat dapat digunakan.
KeyVaultError	Pengecualian kesalahan brankas kunci.
LifetimeAction	Tindakan dan pemicunya yang akan dilakukan oleh Key Vault selama masa pakai sertifikat.
SecretProperties	Properti kunci yang mendukung sertifikat.
SubjectAlternativeNames	Nama alternatif subjek dari objek X509.
Trigger	Kondisi yang harus dipenuhi agar tindakan dijalankan.
X509CertificateProperties	Properti komponen X509 dari sertifikat.

Action

Tindakan yang akan dijalankan.

Nama	Jenis	Deskripsi
action_type	CertificatePolicyAction	Jenis tindakan.

CertificateAttributes

Atribut manajemen sertifikat.

Nama	Jenis	Deskripsi
created	integer	Waktu pembuatan di UTC.
enabled	boolean	Menentukan apakah objek diaktifkan.
exp	integer	Tanggal kedaluwarsa dalam UTC.
nbf	integer	Tidak sebelum tanggal dalam UTC.
recoverableDays	integer	softDelete hari retensi data. Nilai harus >=7 dan <=90 saat softDelete diaktifkan, jika tidak, 0.
recoveryLevel	DeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk sertifikat di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', sertifikat dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh sertifikat, di akhir interval retensi.
updated	integer	Waktu terakhir diperbarui di UTC.

CertificateBundle

Bundel sertifikat terdiri dari sertifikat (X509) ditambah atributnya.

Nama	Jenis	Deskripsi
attributes	CertificateAttributes	Atribut sertifikat.
cer	string	Konten CER sertifikat x509.
contentType	string	Jenis konten rahasia. misalnya. 'application/x-pem-file' atau 'application/x-pkcs12',
id	string	Id sertifikat.
kid	string	Id kunci.
policy	CertificatePolicy	Kebijakan manajemen.
sid	string	Id rahasia.
tags	object	Metadata spesifik aplikasi dalam bentuk pasangan kunci-nilai
x5t	string	Thumbprint sertifikat.

CertificateImportParameters

Parameter impor sertifikat.

Nama	Jenis	Deskripsi
attributes	CertificateAttributes	Atribut sertifikat (opsional).
policy	CertificatePolicy	Kebijakan manajemen untuk sertifikat.
pwd	string	Jika kunci privat di base64EncodedCertificate dienkripsi, kata sandi yang digunakan untuk enkripsi.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.
value	string	Representasi yang dikodekan Base64 dari objek sertifikat yang akan diimpor. Sertifikat ini perlu berisi kunci privat.

CertificatePolicy

Kebijakan manajemen untuk sertifikat.

Nama	Jenis	Deskripsi
attributes	CertificateAttributes	Atribut sertifikat.
id	string	Id sertifikat.
issuer	IssuerParameters	Parameter untuk penerbit komponen X509 sertifikat.
key_props	KeyProperties	Properti kunci yang mendukung sertifikat.
lifetime_actions	LifetimeAction[]	Tindakan yang akan dilakukan oleh Key Vault selama masa pakai sertifikat.
secret_props	SecretProperties	Properti rahasia yang mendukung sertifikat.
x509_props	X509CertificateProperties	Properti komponen X509 dari sertifikat.

CertificatePolicyAction

Jenis tindakan.

Nama	Jenis	Deskripsi
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk sertifikat di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', sertifikat dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh sertifikat, di akhir interval retensi.

Nama	Jenis	Deskripsi
CustomizedRecoverable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu hapus menyeluruh ketika 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi dan saat langganan masih tersedia.
CustomizedRecoverable+ProtectedSubscription	string	Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan, penghapusan langsung, dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen ketika 7<= SoftDeleteRetentionInDays < 90. Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, dan juga mencerminkan fakta bahwa langganan itu sendiri tidak dapat dibatalkan.
CustomizedRecoverable+Purgeable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan saat 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, kecuali operasi Pembersihan diminta, atau langganan dibatalkan.
Purgeable	string	Menunjukkan status vault di mana penghapusan adalah operasi yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Tingkat ini sesuai dengan tidak ada perlindungan yang tersedia terhadap operasi Hapus; data hilang secara tidak dapat diambil setelah menerima operasi Hapus di tingkat entitas atau yang lebih tinggi (vault, grup sumber daya, langganan, dll.)
Recoverable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu penghapusan menyeluruh). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari) dan saat langganan masih tersedia. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+ProtectedSubscription	string	Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan dalam interval retensi (90 hari), penghapusan segera dan permanen (yaitu penghapusan menyeluruh) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+Purgeable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari), kecuali jika operasi Pembersihan diminta, atau langganan dibatalkan. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan

Error

Kesalahan server brankas kunci.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
innererror	Error	Kesalahan server brankas kunci.
message	string	Pesan kesalahan.

IssuerParameters

Parameter untuk penerbit komponen X509 sertifikat.

Nama	Jenis	Deskripsi
cert_transparency	boolean	Menunjukkan apakah sertifikat yang dihasilkan berdasarkan kebijakan ini harus diterbitkan ke log transparansi sertifikat.
cty	string	Jenis sertifikat yang didukung oleh penyedia (opsional); misalnya 'OV-SSL', 'EV-SSL'
name	string	Nama objek penerbit yang dirujuk atau nama yang dipesan; misalnya, 'Mandiri' atau 'Tidak Diketahui'.

JsonWebKeyCurveName

Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.

Nama	Jenis	Deskripsi
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

Jenis pasangan kunci yang akan digunakan untuk sertifikat.

Nama	Jenis	Deskripsi
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Properti pasangan kunci yang mendukung sertifikat.

Nama	Jenis	Deskripsi
crv	JsonWebKeyCurveName	Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
exportable	boolean	Menunjukkan apakah kunci privat dapat diekspor. Kebijakan rilis harus disediakan saat membuat versi pertama kunci yang dapat diekspor.
key_size	integer	Ukuran kunci dalam bit. Misalnya: 2048, 3072, atau 4096 untuk RSA.
kty	JsonWebKeyType	Jenis pasangan kunci yang akan digunakan untuk sertifikat.
reuse_key	boolean	Menunjukkan apakah pasangan kunci yang sama akan digunakan pada perpanjangan sertifikat.

KeyUsageType

Menentukan bagaimana kunci sertifikat dapat digunakan.

Nama	Jenis	Deskripsi
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Pengecualian kesalahan brankas kunci.

Nama	Jenis	Deskripsi
error	Error	Kesalahan server brankas kunci.

LifetimeAction

Tindakan dan pemicunya yang akan dilakukan oleh Key Vault selama masa pakai sertifikat.

Nama	Jenis	Deskripsi
action	Action	Tindakan yang akan dijalankan.
trigger	Trigger	Kondisi yang akan menjalankan tindakan.

SecretProperties

Properti kunci yang mendukung sertifikat.

Nama	Jenis	Deskripsi
contentType	string	Jenis media (jenis MIME).

SubjectAlternativeNames

Nama alternatif subjek dari objek X509.

Nama	Jenis	Deskripsi
dns_names	string[]	Nama domain.
emails	string[]	Alamat email.
upns	string[]	Nama utama pengguna.

Trigger

Kondisi yang harus dipenuhi agar tindakan dijalankan.

Nama	Jenis	Deskripsi
days_before_expiry	integer	Hari sebelum kedaluwarsa untuk mencoba perpanjangan. Nilai harus antara 1 dan validity_in_months dikalikan dengan 27. Jika validity_in_months adalah 36, maka nilainya harus antara 1 dan 972 (36 * 27).
lifetime_percentage	integer	Persentase masa pakai untuk memicu. Nilai harus antara 1 dan 99.

X509CertificateProperties

Properti komponen X509 dari sertifikat.

Nama	Jenis	Deskripsi
ekus	string[]	Penggunaan kunci yang disempurnakan.
key_usage	KeyUsageType[]	Menentukan bagaimana kunci sertifikat dapat digunakan.
sans	SubjectAlternativeNames	Nama alternatif subjek.
subject	string	Nama subjek. Harus berupa Nama yang dibedakan X509 yang valid.
validity_months	integer	Durasi sertifikat berlaku dalam bulan.

Import Certificate - Import Certificate

Parameter URI

Isi Permintaan

Respons

Contoh

ImportCertificate

Sample Request

Sample Response

Definisi

Action

CertificateAttributes

CertificateBundle

CertificateImportParameters

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Sumber Daya Tambahan: