Update Certificate Policy - Update Certificate Policy

  • Referensi
Service:
Key Vault
API Version:
7.3

Memperbarui kebijakan untuk sertifikat.
Atur anggota tertentu dalam kebijakan sertifikat. Biarkan orang lain sebagai null. Operasi ini memerlukan izin sertifikat/pembaruan.

PATCH {vaultBaseUrl}/certificates/{certificate-name}/policy?api-version=7.3

Parameter URI

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

Nama sertifikat dalam vault yang diberikan.
vaultBaseUrl
 path True
  • string

Nama vault, misalnya https://myvault.vault.azure.net.
api-version
 query True
  • string

Versi API klien.

Isi Permintaan

Name Type Description
attributes

Atribut sertifikat.
issuer

Parameter untuk penerbit komponen X509 sertifikat.
key_props

Properti kunci yang mendukung sertifikat.
lifetime_actions

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

Properti rahasia yang mendukung sertifikat.
x509_props

Properti komponen X509 dari sertifikat.

Respons

Name Type Description
200 OK

Kebijakan sertifikat
Other Status Codes

Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

UpdateCertificatePolicy

Sample Request

PATCH https://myvault.vault.azure.net//certificates/updateCert01/policy?api-version=7.3

{
  "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": "Self"
  },
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:
200 
{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/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": "Self"
  },
  "attributes": {
    "enabled": true,
    "created": 1482188947,
    "updated": 1482188948
  }
}

Definisi

Action

Tindakan yang akan dijalankan.
ActionType

Jenis tindakan.
CertificateAttributes

Atribut manajemen sertifikat.
CertificatePolicy

Kebijakan manajemen untuk sertifikat.
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.
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.

Name Type Description
action_type

Jenis tindakan.

ActionType

Jenis tindakan.

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

Atribut manajemen sertifikat.

Name Type Description
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

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.

CertificatePolicy

Kebijakan manajemen untuk sertifikat.

Name Type Description
attributes

Atribut sertifikat.
id
  • string

Id sertifikat.
issuer

Parameter untuk penerbit komponen X509 sertifikat.
key_props

Properti kunci yang mendukung sertifikat.
lifetime_actions

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

Properti rahasia yang mendukung sertifikat.
x509_props

Properti komponen X509 dari sertifikat.

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.

Name Type Description
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 operasi Pembersihan diminta, atau langganan dibatalkan. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan

Error

Kesalahan server brankas kunci.

Name Type Description
code
  • string

Kode kesalahan.
innererror

Kesalahan server brankas kunci.
message
  • string

Pesan kesalahan.

IssuerParameters

Parameter untuk penerbit komponen X509 sertifikat.

Name Type Description
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.

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

JsonWebKeyType

Jenis pasangan kunci yang akan digunakan untuk sertifikat.

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

KeyProperties

Properti pasangan kunci yang mendukung sertifikat.

Name Type Description
crv

Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
exportable
  • boolean

Menunjukkan apakah kunci privat dapat diekspor.
key_size
  • integer

Ukuran kunci dalam bit. Misalnya: 2048, 3072, atau 4096 untuk RSA.
kty

Jenis pasangan kunci yang akan digunakan untuk sertifikat.
reuse_key
  • boolean

Menunjukkan apakah pasangan kunci yang sama akan digunakan pada perpanjangan sertifikat.

KeyVaultError

Pengecualian kesalahan brankas kunci.

Name Type Description
error

Kesalahan server brankas kunci.

LifetimeAction

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

Name Type Description
action

Tindakan yang akan dijalankan.
trigger

Kondisi yang akan menjalankan tindakan.

SecretProperties

Properti kunci yang mendukung sertifikat.

Name Type Description
contentType
  • string

Jenis media (jenis MIME).

SubjectAlternativeNames

Nama alternatif subjek dari objek X509.

Name Type Description
dns_names
  • string[]

Nama domain.
emails
  • string[]

Alamat email.
upns
  • string[]

Nama utama pengguna.

Trigger

Kondisi yang harus dipenuhi agar tindakan dijalankan.

Name Type Description
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.

Name Type Description
ekus
  • string[]

Penggunaan kunci yang disempurnakan.
key_usage
  • string[]

Daftar penggunaan kunci.
sans

Nama alternatif subjek.
subject
  • string

Nama subjek. Harus berupa Nama yang dibedakan X509 yang valid.
validity_months
  • integer

Durasi sertifikat berlaku dalam bulan.