Create Certificate - Create Certificate

Referensi

Service:: Key Vault

API Version:: 7.4

Membuat sertifikat baru.
Jika ini adalah versi pertama, sumber daya sertifikat dibuat. Operasi ini memerlukan izin sertifikat/pembuatan.

POST {vaultBaseUrl}/certificates/{certificate-name}/create?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	Jenis	Deskripsi
attributes	CertificateAttributes	Atribut sertifikat (opsional).
policy	CertificatePolicy	Kebijakan manajemen untuk sertifikat.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Respons

Nama	Jenis	Deskripsi
202 Accepted	CertificateOperation	Bundel sertifikat yang dibuat.
Other Status Codes	KeyVaultError	Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

CreateCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.4

{
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=*.microsoft.com",
      "sans": {
        "dns_names": [
          "onedrive.microsoft.com",
          "xbox.microsoft.com"
        ]
      }
    },
    "issuer": {
      "name": "Self"
    }
  }
}

Sample Response

Status code:: 202

{
  "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
  "issuer": {
    "name": "Self"
  },
  "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
  "cancellation_requested": false,
  "status": "inProgress",
  "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
  "request_id": "6faacd568ab049a2803861e8dd3ae21f"
}

Definisi

Nama	Deskripsi
Action	Tindakan yang akan dijalankan.
CertificateAttributes	Atribut manajemen sertifikat.
CertificateCreateParameters	Sertifikat membuat parameter.
CertificateOperation	Operasi sertifikat dikembalikan jika terjadi permintaan asinkron.
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.

CertificateCreateParameters

Sertifikat membuat parameter.

Nama	Jenis	Deskripsi
attributes	CertificateAttributes	Atribut sertifikat (opsional).
policy	CertificatePolicy	Kebijakan manajemen untuk sertifikat.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

CertificateOperation

Operasi sertifikat dikembalikan jika terjadi permintaan asinkron.

Nama	Jenis	Deskripsi
cancellation_requested	boolean	Menunjukkan apakah pembatalan diminta pada operasi sertifikat.
csr	string	Permintaan penandatanganan sertifikat (CSR) yang sedang digunakan dalam operasi sertifikat.
error	Error	Terjadi kesalahan, jika ada, selama operasi sertifikat.
id	string	Id sertifikat.
issuer	IssuerParameters	Parameter untuk penerbit komponen X509 sertifikat.
request_id	string	Pengidentifikasi untuk operasi sertifikat.
status	string	Status operasi sertifikat.
status_details	string	Detail status operasi sertifikat.
target	string	Lokasi yang berisi hasil operasi sertifikat.

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

Create Certificate - Create Certificate

Parameter URI

Isi Permintaan

Respons

Contoh

CreateCertificate

Sample Request

Sample Response

Definisi

Action

CertificateAttributes

CertificateCreateParameters

CertificateOperation

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Sumber Daya Tambahan: