Get Key Versions - Get Key Versions

Referensi

Service:: Key Vault

API Version:: 7.4

Mengambil daftar versi kunci individual dengan nama kunci yang sama.
Pengidentifikasi kunci lengkap, atribut, dan tag disediakan dalam respons. Operasi ini memerlukan izin kunci/daftar.

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

With optional parameters:

GET {vaultBaseUrl}/keys/{key-name}/versions?maxresults={maxresults}&api-version=7.4

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
key-name	path	True	string	Nama kunci.
vaultBaseUrl	path	True	string	Nama vault, misalnya https://myvault.vault.azure.net.
api-version	query	True	string	Versi API klien.
maxresults	query		integer int32	Jumlah hasil maksimum untuk dikembalikan dalam halaman. Jika tidak ditentukan, layanan akan mengembalikan hingga 25 hasil.

Respons

Nama	Jenis	Deskripsi
200 OK	KeyListResult	Pesan respons yang berisi daftar kunci bersama dengan tautan ke halaman kunci berikutnya.
Other Status Codes	KeyVaultError	Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

GetKeyVersions

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys/listkeyversionstest/versions?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/listkeyversionstest/7c9dc6775d0e4177827c4f98f482fc12",
      "attributes": {
        "enabled": true,
        "created": 1493937851,
        "updated": 1493937851,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys/listkeyversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUwwRXdPRUZDUVVVNE1UZ3pNalF5TVRsQ05EUXpPREZFTWpoRVJURkdSVEJESVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

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.
KeyAttributes	Atribut kunci yang dikelola oleh layanan brankas kunci.
KeyItem	Item kunci yang berisi metadata kunci.
KeyListResult	Hasil daftar 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.

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.

KeyItem

Item kunci yang berisi metadata kunci.

Nama	Jenis	Deskripsi
attributes	KeyAttributes	Atribut manajemen kunci.
kid	string	Pengidentifikasi kunci.
managed	boolean	True jika masa pakai kunci dikelola oleh brankas kunci. Jika ini adalah kunci yang mendukung sertifikat, maka terkelola akan benar.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

KeyListResult

Hasil daftar kunci.

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mendapatkan set kunci berikutnya.
value	KeyItem[]	Pesan respons yang berisi daftar kunci di brankas kunci bersama dengan tautan ke halaman kunci berikutnya.

KeyVaultError

Pengecualian kesalahan brankas kunci.

Nama	Jenis	Deskripsi
error	Error	Kesalahan server brankas kunci.

Share via