Update Key - Update Key

  • Referensi
Service:
Key Vault
API Version:
7.4

Operasi kunci pembaruan mengubah atribut tertentu dari kunci yang disimpan dan dapat diterapkan ke jenis kunci dan versi kunci apa pun yang disimpan di Azure Key Vault.
Untuk melakukan operasi ini, kunci harus sudah ada di Key Vault. Catatan: Materi kriptografi kunci itu sendiri tidak dapat diubah. Operasi ini memerlukan izin kunci/pembaruan.

PATCH {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
key-name
 path True

string

Nama kunci yang akan diperbarui.
key-version
 path True

string

Versi kunci yang akan diperbarui.
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

KeyAttributes

Atribut kunci yang dikelola oleh layanan brankas kunci.
key_ops

JsonWebKeyOperation[]

Operasi kunci web Json. Untuk informasi selengkapnya tentang kemungkinan operasi kunci, lihat JsonWebKeyOperation.
release_policy

KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.
tags

object

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Respons

Nama Jenis Deskripsi
200 OK

KeyBundle

Kunci yang diperbarui.
Other Status Codes

KeyVaultError

Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

Update key

Sample Request

PATCH https://myvault.vault.azure.net//keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088?api-version=7.4

{
  "key_ops": [
    "decrypt",
    "encrypt"
  ],
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800
  }
}

Sample Response

Status code:
200 
{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088",
    "kty": "RSA",
    "key_ops": [
      "decrypt",
      "encrypt"
    ],
    "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800,
    "created": 1493860275,
    "updated": 1493860277,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definisi

Nama Deskripsi
DeletionRecoveryLevel

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

Kesalahan server brankas kunci.
JsonWebKey

Pada http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

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

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Atribut kunci yang dikelola oleh layanan brankas kunci.
KeyBundle

KeyBundle yang terdiri dari WebKey ditambah atributnya.
KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.
KeyUpdateParameters

Parameter pembaruan kunci.
KeyVaultError

Pengecualian kesalahan brankas kunci.

DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk kunci di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh' kunci dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh kunci, 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.

JsonWebKey

Pada http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Nama Jenis Deskripsi
crv

JsonWebKeyCurveName

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

string

Eksponen privat RSA, atau komponen D dari kunci privat EC.
dp

string

Parameter kunci privat RSA.
dq

string

Parameter kunci privat RSA.
e

string

Eksponen publik RSA.
k

string

Kunci simetris.
key_hsm

string

Kunci yang Dilindungi, digunakan dengan 'Bring Your Own Key'.
key_ops

string[]

Operasi kunci yang didukung.
kid

string

Pengidentifikasi kunci.
kty

JsonWebKeyType

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n

string

Modul RSA.
p

string

Rahasia RSA prima.
q

string

Prime rahasia RSA, dengan p < q.
qi

string

Parameter kunci privat RSA.
x

string

Komponen X dari kunci umum EC.
y

string

Komponen Y dari kunci umum EC.

JsonWebKeyCurveName

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

Nama Jenis Deskripsi
P-256

string

Kurva elips NIST P-256, kurva AKA SECG SECP256R1.
P-256K

string

SECG SECP256K1 kurva elips.
P-384

string

Kurva elips NIST P-384, kurva AKA SECG SECP384R1.
P-521

string

Kurva elips NIST P-521, kurva AKA SECG SECP521R1.

JsonWebKeyOperation

Nama Jenis Deskripsi
decrypt

string

encrypt

string

export

string

import

string

sign

string

unwrapKey

string

verify

string

wrapKey

string

JsonWebKeyType

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Nama Jenis Deskripsi
EC

string

Kurva Elips.
EC-HSM

string

Kurva Elips dengan kunci privat yang disimpan di HSM.
RSA

string

RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM

string

RSA dengan kunci privat yang disimpan di HSM.
oct

string

Urutan oktet (digunakan untuk mewakili kunci konten)
oct-HSM

string

Urutan oktet (digunakan untuk mewakili kunci konten) yang disimpan HSM.

KeyAttributes

Atribut kunci yang dikelola oleh layanan brankas kunci.

Nama Jenis Deskripsi
created

integer

Waktu pembuatan di UTC.
enabled

boolean

Menentukan apakah objek diaktifkan.
exp

integer

Tanggal kedaluwarsa dalam UTC.
exportable

boolean

Menunjukkan apakah kunci privat dapat diekspor. Kebijakan rilis harus disediakan saat membuat versi pertama kunci yang dapat diekspor.
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 kunci di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh' kunci dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh kunci, di akhir interval retensi.
updated

integer

Waktu terakhir diperbarui di UTC.

KeyBundle

KeyBundle yang terdiri dari WebKey ditambah atributnya.

Nama Jenis Deskripsi
attributes

KeyAttributes

Atribut manajemen kunci.
key

JsonWebKey

Kunci web Json.
managed

boolean

True jika masa pakai kunci dikelola oleh brankas kunci. Jika ini adalah kunci yang mendukung sertifikat, maka terkelola akan benar.
release_policy

KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.
tags

object

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.

Nama Jenis Nilai Default Deskripsi
contentType

string

application/json; charset=utf-8

Jenis konten dan versi kebijakan rilis kunci
data

string

Pengodean blob aturan kebijakan tempat kunci dapat dirilis. Blob harus dikodekan URL base64.
immutable

boolean

Menentukan status mutabilitas kebijakan. Setelah ditandai tidak dapat diubah, bendera ini tidak dapat diatur ulang dan kebijakan tidak dapat diubah dalam keadaan apa pun.

KeyUpdateParameters

Parameter pembaruan kunci.

Nama Jenis Deskripsi
attributes

KeyAttributes

Atribut kunci yang dikelola oleh layanan brankas kunci.
key_ops

JsonWebKeyOperation[]

Operasi kunci web Json. Untuk informasi selengkapnya tentang kemungkinan operasi kunci, lihat JsonWebKeyOperation.
release_policy

KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.
tags

object

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

KeyVaultError

Pengecualian kesalahan brankas kunci.

Nama Jenis Deskripsi
error

Error

Kesalahan server brankas kunci.