Delete Key - Delete Key

Layanan:: Key Vault

Versi API:: 7.4

Menghapus kunci jenis apa pun dari penyimpanan di Azure Key Vault.
Operasi hapus kunci tidak dapat digunakan untuk menghapus versi individual kunci. Operasi ini menghapus materi kriptografi yang terkait dengan kunci, yang berarti kunci tidak dapat digunakan untuk operasi Sign/Verify, Wrap/Unwrap atau Encrypt/Decrypt. Operasi ini memerlukan izin kunci/hapus.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
key-name	path	True	string	Nama kunci yang akan dihapus.
vaultBaseUrl	path	True	string	Nama vault, misalnya `https://myvault.vault.azure.net`.
api-version	query	True	string	Versi API Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	DeletedKeyBundle	Bagian publik dari kunci yang dihapus dan informasi penghapusan tentang kapan kunci akan dihapus menyeluruh.
Other Status Codes	KeyVaultError	Respons kesalahan Key Vault yang menjelaskan mengapa operasi gagal.

Contoh

Delete key

Permintaan sampel

HTTP

DELETE https://myvault.vault.azure.net//keys/CreateSoftKeyTest?api-version=7.4

Respon sampel

Kode status:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedkeys/CreateSoftKeyTest",
  "deletedDate": 1493942452,
  "scheduledPurgeDate": 1501718452,
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Definisi

Nama	Deskripsi
DeletedKeyBundle	DeletedKeyBundle yang terdiri dari WebKey ditambah Atribut dan info penghapusannya
DeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk kunci di vault saat ini. Jika berisi 'Dapat Dibersihkan', 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.
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.
KeyReleasePolicy	Aturan kebijakan tempat kunci dapat diekspor.
KeyVaultError	Pengecualian kesalahan brankas kunci.

DeletedKeyBundle

Objek

DeletedKeyBundle yang terdiri dari WebKey ditambah Atribut dan info penghapusannya

Nama	Jenis	Deskripsi
attributes	KeyAttributes	Atribut manajemen kunci.
deletedDate	integer (unixtime)	Waktu ketika kunci dihapus, dalam UTC
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.
recoveryId	string	Url objek pemulihan, digunakan untuk mengidentifikasi dan memulihkan kunci yang dihapus.
release_policy	KeyReleasePolicy	Aturan kebijakan tempat kunci dapat diekspor.
scheduledPurgeDate	integer (unixtime)	Waktu ketika kunci dijadwalkan untuk dihapus menyeluruh, dalam UTC
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

DeletionRecoveryLevel

Enumeration

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

Nilai	Deskripsi
CustomizedRecoverable	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	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	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 jika operasi Pembersihan diminta, atau langganan dibatalkan.
Purgeable	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	Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari) dan saat langganan masih tersedia. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+ProtectedSubscription	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 menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+Purgeable	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 menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan

Error

Objek

Kesalahan server brankas kunci.

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

JsonWebKey

Objek

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 (base64url)	Eksponen privat RSA, atau komponen D dari kunci privat EC.
dp	string (base64url)	Parameter kunci privat RSA.
dq	string (base64url)	Parameter kunci privat RSA.
e	string (base64url)	Eksponen publik RSA.
k	string (base64url)	Kunci konten.
key_hsm	string (base64url)	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 (base64url)	Modulus RSA.
p	string (base64url)	Rahasia RSA utama.
q	string (base64url)	Prime rahasia RSA, dengan p < q.
qi	string (base64url)	Parameter kunci privat RSA.
x	string (base64url)	Komponen X dari kunci publik EC.
y	string (base64url)	Komponen Y dari kunci umum EC.

JsonWebKeyCurveName

Enumeration

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

Nilai	Deskripsi
P-256	Kurva elips NIST P-256, kurva AKA SECG SECP256R1.
P-256K	SECG SECP256K1 kurva elips.
P-384	Kurva elips NIST P-384, kurva AKA SECG SECP384R1.
P-521	Kurva elips NIST P-521, kurva AKA SECG SECP521R1.

JsonWebKeyType

Enumeration

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

Nilai	Deskripsi
EC	Kurva Elips.
EC-HSM	Kurva Elips dengan kunci privat yang disimpan di HSM.
RSA	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	RSA dengan kunci privat yang disimpan di HSM.
oct	Urutan oktet (digunakan untuk mewakili kunci konten)
oct-HSM	Urutan oktet (digunakan untuk mewakili kunci konten) yang disimpan HSM.

KeyAttributes

Objek

Atribut kunci yang dikelola oleh layanan brankas kunci.

Nama	Jenis	Deskripsi
created	integer (unixtime)	Waktu pembuatan dalam UTC.
enabled	boolean	Menentukan apakah objek diaktifkan.
exp	integer (unixtime)	Tanggal kedaluwarsa dalam UTC.
exportable	boolean	Menunjukkan apakah kunci privat dapat diekspor. Kebijakan rilis harus diberikan saat membuat versi pertama kunci yang dapat diekspor.
nbf	integer (unixtime)	Tidak sebelum tanggal dalam UTC.
recoverableDays	integer (int32)	softHapus 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 Dibersihkan', kunci dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh kunci, di akhir interval retensi.
updated	integer (unixtime)	Waktu terakhir diperbarui di UTC.

KeyReleasePolicy

Objek

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 (base64url)		Blob yang mengodekan 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.

KeyVaultError

Objek

Pengecualian kesalahan brankas kunci.

Nama	Jenis	Deskripsi
error	Error	Kesalahan server brankas kunci.

Bagikan melalui

Delete Key - Delete Key

Parameter URI

Respons

Contoh

Delete key

Permintaan sampel

Respon sampel

Definisi

DeletedKeyBundle

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyReleasePolicy

KeyVaultError