Referensi API REST Azure Key Vault

  • Artikel

Gunakan Key Vault untuk melindungi dan mengelola kunci kriptografi, sertifikat, dan rahasia yang digunakan oleh aplikasi dan layanan cloud.

Operasi Key Vault

Operasi Deskripsi
Periksa Ketersediaan Nama Memeriksa apakah nama vault valid dan belum digunakan.
Buat atau Perbarui Membuat atau memperbarui brankas kunci dalam langganan yang ditentukan.
Memperbarui Kebijakan Akses Perbarui kebijakan akses dalam brankas kunci dalam langganan yang ditentukan.
Dapatkan Mendapatkan brankas kunci Azure yang ditentukan.
Daftar Operasi Daftar mendapatkan informasi tentang vault yang terkait dengan langganan.
List By Resource Group Operasi Daftar mendapatkan informasi tentang vault yang terkait dengan langganan dan dalam grup sumber daya yang ditentukan.
List By Subscription Operasi Daftar mendapatkan informasi tentang vault yang terkait dengan langganan.
Pembaruan Perbarui brankas kunci dalam langganan yang ditentukan.
Hapus Menghapus brankas kunci Azure yang ditentukan.
Dihapus Mendapatkan brankas kunci Azure yang dihapus.
Daftar Dihapus Mendapatkan informasi tentang vault yang dihapus dalam langganan.
Purge Menghapus vault yang ditentukan secara permanen.
Operasi Deskripsi
Daftar Menurut Vault Mendapatkan sumber daya tautan privat yang didukung untuk brankas kunci.

Operasi koneksi titik akhir privat

Operasi Deskripsi
Dapatkan Mendapatkan koneksi titik akhir privat yang ditentukan yang terkait dengan brankas kunci.
Daftar Menurut Sumber Daya Operasi Daftar mendapatkan informasi tentang koneksi titik akhir privat yang terkait dengan vault.
Menempatkan Updates koneksi titik akhir privat yang ditentukan yang terkait dengan brankas kunci.
Hapus Menghapus koneksi titik akhir privat yang ditentukan yang terkait dengan brankas kunci.

Operasi HSM terkelola

Operasi Deskripsi
Buat atau Perbarui Membuat atau memperbarui Kumpulan HSM terkelola dalam langganan yang ditentukan.
Dapatkan Mendapatkan Kumpulan HSM terkelola yang ditentukan.
List By Resource Group Operasi Daftar mendapatkan informasi tentang Kumpulan HSM terkelola yang terkait dengan langganan dan dalam grup sumber daya yang ditentukan.
List By Subscription Operasi Daftar mendapatkan informasi tentang Kumpulan HSM terkelola yang terkait dengan langganan.
Pembaruan Perbarui Kumpulan HSM terkelola dalam langganan yang ditentukan.
Dihapus Mendapatkan HSM terkelola yang dihapus yang ditentukan.
Daftar Dihapus Operasi Daftar mendapatkan informasi tentang HSM terkelola yang dihapus yang terkait dengan langganan.
Hapus Menghapus Kumpulan HSM terkelola yang ditentukan.
Hapus Menyeluruh Dihapus Menghapus HSM terkelola yang ditentukan secara permanen.
Operasi Deskripsi
Daftar menurut Sumber Daya MHSM Mendapatkan sumber daya tautan privat yang didukung untuk kumpulan HSM terkelola.

Operasi koneksi titik akhir privat

Operasi Deskripsi
Dapatkan Mendapatkan koneksi titik akhir privat yang ditentukan yang terkait dengan Kumpulan HSM terkelola.
Daftar Menurut Sumber Daya Operasi Daftar mendapatkan informasi tentang koneksi titik akhir privat yang terkait dengan Kumpulan HSM terkelola.
Menempatkan Updates koneksi titik akhir privat yang ditentukan yang terkait dengan Kumpulan HSM terkelola.
Hapus Menghapus koneksi titik akhir privat yang ditentukan yang terkait dengan Kumpulan HSM terkelola.

Operasi Domain Keamanan HSM

Operasi Deskripsi
Unduh Mengambil Domain Keamanan dari HSM terkelola. Memanggil titik akhir ini dapat digunakan untuk mengaktifkan sumber daya HSM terkelola yang disediakan.
Pengunduhan Tertunda Mengambil status operasi pengunduhan Domain Keamanan.
Unggah Pulihkan Domain Keamanan yang disediakan.
Unggah Tertunda Dapatkan status operasi unggahan Domain Keamanan.

Operasi Pengaturan HSM Terkelola

Operasi Deskripsi
Dapatkan Pengaturan Dapatkan objek pengaturan akun tertentu. Mengambil objek pengaturan dari nama pengaturan yang ditentukan.
Dapatkan Pengaturan Mencantumkan pengaturan akun. Mengambil daftar semua pengaturan akun yang tersedia yang dapat dikonfigurasi.
Pengaturan Pembaruan Updates pengaturan akun brankas kunci, menyimpannya, lalu mengembalikan nama dan nilai pengaturan ke klien. Deskripsi pengaturan kumpulan yang akan diperbarui

Operasi kontrol akses berbasis peran

Operasi penetapan peran

Operasi Deskripsi
Dapatkan Dapatkan penetapan peran yang ditentukan.
Daftar Mendapatkan penetapan peran untuk cakupan.
Buat Membuat penetapan peran.
Hapus Menghapus penetapan peran.

Operasi definisi peran

Operasi Deskripsi
Dapatkan Dapatkan definisi peran yang ditentukan.
Daftar Dapatkan semua definisi peran yang berlaku pada cakupan dan di atasnya.
Buat atau Perbarui Membuat atau memperbarui definisi peran kustom.
Hapus Menghapus definisi peran kustom.

Operasi pencadangan/pemulihan

Operasi Deskripsi
Pencadangan Penuh Membuat pencadangan penuh menggunakan token SAS yang disediakan pengguna ke kontainer penyimpanan blob Azure. Operasi ini hanya didukung oleh layanan HSM Terkelola.
Status Pencadangan Mengembalikan status operasi pencadangan penuh.
Pemulihan Penuh Memulihkan semua materi utama menggunakan token SAS yang menunjuk ke folder cadangan penyimpanan Azure Blob yang disimpan sebelumnya.
Pemulihan Selektif Memulihkan semua versi kunci tertentu menggunakan token SAS yang disediakan pengguna yang menunjuk ke folder cadangan penyimpanan Azure Blob yang disimpan sebelumnya.
Pulihkan Status Mengembalikan status operasi pemulihan.

Operasi utama (Key Vault/HSM Terkelola)

Operasi Deskripsi
Dapatkan Kunci Mendapatkan bagian publik dari kunci yang disimpan.
Dapatkan Kunci Mencantumkan kunci dalam vault yang ditentukan.
Dapatkan Versi Kunci Mengambil daftar versi kunci individual dengan nama kunci yang sama.
Buat Kunci Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan atribut utama ke klien.
Impor Kunci Mengimpor kunci yang dibuat secara eksternal, menyimpannya, dan mengembalikan parameter dan atribut utama ke klien.
Perbarui Kunci 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.
Hapus Kunci Menghapus kunci jenis apa pun dari penyimpanan di Azure Key Vault.
Dapatkan Kunci yang Dihapus Mendapatkan bagian publik dari kunci yang dihapus.
Dapatkan Kunci yang Dihapus Mencantumkan kunci yang dihapus dalam vault yang ditentukan.
Hapus Menyeluruh Kunci yang Dihapus Menghapus kunci yang ditentukan secara permanen.
Pulihkan Kunci yang Dihapus Memulihkan kunci yang dihapus ke versi terbarunya.
Cadangkan Kunci Meminta agar cadangan kunci yang ditentukan diunduh ke klien.
Pulihkan kunci Memulihkan kunci yang dicadangkan ke vault.
Kunci Rilis Merilis kunci. Operasi kunci rilis berlaku untuk semua jenis kunci. Kunci target harus ditandai dapat diekspor. Operasi ini memerlukan izin kunci/rilis.
Putar Kunci Membuat versi kunci baru, menyimpannya, lalu mengembalikan parameter kunci, atribut, dan kebijakan ke klien. Operasi akan memutar kunci berdasarkan kebijakan kunci. Ini memerlukan izin kunci/putar.
Dapatkan Kebijakan Rotasi Kunci Mencantumkan kebijakan untuk kunci. Operasi GetKeyRotationPolicy mengembalikan sumber daya kebijakan kunci yang ditentukan dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin kunci/dapatkan.
Memperbarui Kebijakan Rotasi Kunci Updates kebijakan rotasi untuk kunci. Atur anggota tertentu dalam kebijakan kunci. Biarkan orang lain sebagai tidak terdefinis. Operasi ini memerlukan izin kunci/pembaruan.

Operasi utama (hanya HSM Terkelola)

Operasi Deskripsi
Dapatkan Byte Acak Dapatkan jumlah byte yang diminta yang berisi nilai acak dari HSM terkelola.

Operasi kriptografi (Key Vault/HSM Terkelola)

Operasi Deskripsi
Decrypt Mendekripsi satu blok data terenkripsi.
Encrypt Mengenkripsi urutan byte arbitrer menggunakan kunci enkripsi yang disimpan dalam brankas kunci.
Kunci Bungkus Membungkus kunci konten menggunakan kunci tertentu.
Buka Bungkus Kunci Membongkar kunci simetris menggunakan kunci yang ditentukan yang awalnya digunakan untuk membungkus kunci tersebut.
Menandatangani Membuat tanda tangan dari hash menggunakan kunci yang ditentukan.
Verifikasi Memverifikasi tanda tangan menggunakan kunci tertentu.

Operasi rahasia (hanya Key Vault)

Operasi Deskripsi
Dapatkan Rahasia Dapatkan rahasia tertentu dari brankas kunci tertentu.
Dapatkan Rahasia Mencantumkan rahasia dalam brankas kunci tertentu.
Dapatkan Versi Rahasia Mencantumkan semua versi rahasia yang ditentukan.
Atur Rahasia Mengatur rahasia dalam brankas kunci tertentu.
Perbarui Rahasia Updates atribut yang terkait dengan rahasia tertentu dalam brankas kunci tertentu.
Hapus Rahasia Menghapus rahasia dari brankas kunci tertentu.
Dapatkan Rahasia yang Dihapus Mendapatkan rahasia yang dihapus yang ditentukan.
Dapatkan Rahasia yang Dihapus Mencantumkan rahasia yang dihapus untuk vault yang ditentukan.
Hapus Menyeluruh Rahasia yang Dihapus Menghapus rahasia yang ditentukan secara permanen.
Pulihkan Rahasia yang Dihapus Memulihkan rahasia yang dihapus ke versi terbaru.
Cadangkan Rahasia Mencadangkan rahasia yang ditentukan.
Pulihkan Rahasia Memulihkan rahasia yang dicadangkan ke vault.

Operasi manajemen kunci akun penyimpanan (hanya Key Vault)

Operasi konfigurasi Akun Penyimpanan

Operasi Deskripsi
Dapatkan Akun Penyimpanan Mendapatkan informasi tentang akun penyimpanan tertentu. Operasi ini memerlukan izin penyimpanan/dapatkan.
Dapatkan Akun Penyimpanan Mencantumkan akun penyimpanan yang dikelola oleh brankas kunci yang ditentukan. Operasi ini memerlukan izin penyimpanan/daftar.
Memperbarui Akun Penyimpanan Updates atribut tertentu yang terkait dengan akun penyimpanan yang diberikan. Operasi ini memerlukan izin penyimpanan/set/pembaruan.
Atur Akun Penyimpanan Membuat atau memperbarui akun penyimpanan baru. Operasi ini memerlukan izin penyimpanan/set.
Hapus Akun Penyimpanan Menghapus akun penyimpanan. Operasi ini memerlukan izin penyimpanan/penghapusan.
Dapatkan Akun Penyimpanan yang Dihapus Mendapatkan akun penyimpanan yang dihapus yang ditentukan.
Mendapatkan Akun Penyimpanan yang Dihapus Mencantumkan akun penyimpanan yang dihapus untuk vault yang ditentukan.
Hapus Menyeluruh Akun Penyimpanan yang Dihapus Menghapus akun penyimpanan yang ditentukan secara permanen.
Memulihkan Akun Penyimpanan yang Dihapus Memulihkan akun penyimpanan yang dihapus.
Akun Penyimpanan Cadangan Mencadangkan akun penyimpanan yang ditentukan.
Pulihkan Akun Penyimpanan Memulihkan akun penyimpanan yang dicadangkan ke vault.

Operasi kunci Akun Penyimpanan

Operasi Deskripsi
Meregenerasi Kunci Akun Penyimpanan Meregenerasi nilai kunci yang ditentukan untuk akun penyimpanan yang diberikan. Operasi ini memerlukan izin penyimpanan/regeneratekey.

Operasi SAS Akun Penyimpanan

Operasi Deskripsi
Dapatkan Definisi Sas Mendapatkan informasi tentang definisi SAS untuk akun penyimpanan yang ditentukan. Operasi ini memerlukan izin penyimpanan/getsas.
Dapatkan Definisi Sas Mencantumkan definisi SAS penyimpanan untuk akun penyimpanan yang diberikan. Operasi ini memerlukan izin penyimpanan/listsas.
Atur Definisi Sas Membuat atau memperbarui definisi SAS baru untuk akun penyimpanan yang ditentukan. Operasi ini memerlukan izin penyimpanan/setsas.
Memperbarui Definisi Sas Updates atribut tertentu yang terkait dengan definisi SAS yang diberikan. Operasi ini memerlukan izin penyimpanan/setsas.
Hapus Definisi Sas Menghapus definisi SAS dari akun penyimpanan tertentu. Operasi ini memerlukan izin penyimpanan/deletesas.
Dapatkan Definisi Sas yang Dihapus Mendapatkan definisi sas yang dihapus yang ditentukan.
Dapatkan Definisi Sas yang Dihapus Mencantumkan definisi SAS yang dihapus untuk vault dan akun penyimpanan yang ditentukan.
Pulihkan Definisi Sas yang Dihapus Memulihkan definisi SAS yang dihapus.

Operasi sertifikat (hanya Key Vault)

Operasi Deskripsi
Dapatkan Sertifikat Mendapatkan informasi tentang sertifikat.
Dapatkan Sertifikat Mencantumkan sertifikat dalam brankas kunci tertentu
Dapatkan Versi Sertifikat Mencantumkan versi sertifikat.
Buat Sertifikat Membuat sertifikat baru.
Impor Sertifikat Mengimpor sertifikat ke dalam brankas kunci tertentu.
Gabungkan Sertifikat Menggabungkan sertifikat atau rantai sertifikat dengan pasangan kunci yang ada di server.
Dapatkan Operasi Sertifikat Mendapatkan operasi pembuatan sertifikat.
Perbarui Operasi Sertifikat Updates operasi sertifikat.
Hapus Operasi Sertifikat Menghapus operasi pembuatan untuk sertifikat tertentu.
Perbarui Sertifikat Memperbarui atribut yang ditentukan dan terkait dengan sertifikat tertentu.
Hapus Sertifikat Menghapus sertifikat dari brankas kunci tertentu.
Dapatkan Sertifikat yang Dihapus Mengambil informasi tentang sertifikat yang dihapus yang ditentukan.
Dapatkan Sertifikat yang Dihapus Mencantumkan sertifikat yang dihapus dalam vault yang ditentukan yang saat ini tersedia untuk pemulihan.
Hapus Menyeluruh Sertifikat yang Dihapus Menghapus sertifikat yang dihapus secara permanen.
Memulihkan Sertifikat yang Dihapus Memulihkan sertifikat yang dihapus kembali ke versi saat ini di bawah /certificates.
Cadangkan Sertifikat Mencadangkan sertifikat yang ditentukan.
Pulihkan Sertifikat Memulihkan sertifikat yang dicadangkan ke vault.

Operasi kebijakan sertifikat

Operasi Deskripsi
Dapatkan Kebijakan Sertifikat Mencantumkan kebijakan untuk sertifikat.
Memperbarui Kebijakan Sertifikat Updates kebijakan untuk sertifikat.

Operasi kontak sertifikat

Operasi Deskripsi
Mendapatkan Kontak Sertifikat Mencantumkan kontak sertifikat untuk brankas kunci tertentu.
Atur Kontak Sertifikat Mengatur kontak sertifikat untuk brankas kunci yang ditentukan.
Menghapus Kontak Sertifikat Menghapus kontak sertifikat untuk brankas kunci tertentu.

Operasi pengeluar sertifikat

Operasi Deskripsi
Dapatkan Penerbit Sertifikat Mencantumkan penerbit sertifikat yang ditentukan.
Mendapatkan Penerbit Sertifikat Mencantumkan penerbit sertifikat untuk brankas kunci tertentu.
Atur Pengeluar Sertifikat Mengatur penerbit sertifikat yang ditentukan.
Memperbarui Pengeluar Sertifikat Updates penerbit sertifikat yang ditentukan.
Menghapus Pengeluar Sertifikat Menghapus pengeluar sertifikat yang ditentukan.

Lihat juga