Memperbarui versi API Azure Key Vault yang Anda gunakan

Azure Key Vault menggunakan API berversi. Jika aplikasi, skrip, atau templat infrastruktur Anda memanggil versi API yang lebih lama, Anda mungkin melewatkan fitur yang lebih baru, menggunakan perilaku yang berubah di versi yang lebih baru, atau bergantung pada versi yang tidak lagi direkomendasikan. Artikel ini menjelaskan cara menentukan versi API mana yang Anda gunakan dan cara berpindah ke versi saat ini yang didukung.

Important

Semua versi API control plane Key Vault sebelum 2026-02-01 akan dihentikan pada 27 Februari 2027. Setelah tanggal tersebut, key vault Anda tetap ada, tetapi Anda hanya dapat mengelolanya dengan API control plane versi 2026-02-01 atau yang lebih baru. Tidak ada pengecualian atau ekstensi untuk tanggal ini. Penghentian ini tidak memengaruhi API sarana data (API yang digunakan untuk bekerja dengan kunci, rahasia, dan sertifikat). Untuk detailnya, lihat Merencanakan RBAC Azure sebagai model kontrol akses default di Key Vault.

Azure Key Vault memiliki dua permukaan API independen, masing-masing dengan versinya sendiri:

Cakupan API Apa yang dikelolanya Skema versi Contoh titik akhir
Bidang kontrol (pengelolaan) Sumber daya Key Vault itu sendiri: membuat, memperbarui, menghapus Key Vault, dan mengonfigurasi properti seperti SKU, aturan jaringan, dan kontrol akses. Berbasis tanggal ({YYYY}-{MM}-{DD}) https://management.azure.com
Plane data Objek di dalam brankas: kunci, rahasia, dan sertifikat, dan operasi kriptografi. Berbasis tanggal ({YYYY}-{MM}-{DD}) https://<vault-name>.vault.azure.net

Kedua platform memiliki praktik pembuatan versi dan siklus hidup yang berbeda. Memperbarui salah satunya tidak akan memperbarui yang lainnya. Tinjau keduanya jika beban kerja Anda menggunakan keduanya.

Versi API sarana kontrol dapat dihentikan, seperti yang dijelaskan sebelumnya dalam artikel ini.

Versi pratinjau API bidang data dapat dihentikan penggunaannya, jadi jangan gunakan versi pratinjau di lingkungan produksi kecuali Anda siap menerima siklus hidup tersebut. Untuk versi API bidang data yang didukung, lihat referensi REST API Azure Key Vault.

Artikel ini berfokus pada mengidentifikasi dan memperbarui versi API. Memperbarui versi API sarana kontrol tidak mengharuskan Anda untuk memigrasikan brankas kunci yang ada dari kebijakan akses ke Azure RBAC. Jika Anda ingin memigrasikan kontrol akses, lihat Migrasi ke Azure RBAC dari kebijakan akses. Untuk perilaku default RBAC Azure yang diperkenalkan untuk brankas kunci baru di versi 2026-02-01 API dan yang lebih baru, lihat Merencanakan RBAC Azure sebagai model kontrol akses default di Key Vault.

Mengapa pindah ke versi API saat ini

  • Gunakan kemampuan yang didukung. Versi API yang lebih baru dapat menambahkan kemampuan, perilaku yang benar, atau mendukung fitur layanan baru.
  • Menjaga beban kerja produksi tetap stabil. Gunakan versi API stabil saat ini untuk beban kerja produksi. Versi API pratinjau adalah untuk evaluasi dan pengujian awal, dan SLA Azure support mungkin tidak mencakupnya. Versi pratinjau dapat tidak digunakan lagi.
  • Menjaga alat dan pustaka tetap kompatibel. Azure CLI, Azure PowerShell, SDK, templat, dan portal dapat menggunakan versi API yang berbeda. Memperbarui versi untuk satu klien tidak memperbarui yang lain.

Untuk versi sarana kontrol saat ini, lihat Versi API sarana kontrol yang didukung. Untuk versi data plane yang didukung, lihat referensi Azure Key Vault REST API.

Menentukan versi API mana yang Anda gunakan

Anda menentukan versi API secara berbeda tergantung pada cara Anda memanggil Key Vault. Periksa setiap permukaan yang digunakan beban kerja Anda.

Bidang kontrol (manajemen)

  • REST API: Versi adalah api-version parameter string kueri pada permintaan ke https://management.azure.com, misalnya ?api-version=<control-plane-version>.
  • Template ARM, Bicep, dan Terraform: Versi ditentukan oleh properti apiVersion pada setiap sumber daya Microsoft.KeyVault/vaults. Dalam Bicep, ini adalah bagian dari deklarasi jenis sumber daya, misalnya resource kv 'Microsoft.KeyVault/vaults@2026-02-01'.
  • SDK manajemen sarana kontrol: Versi paket dapat menentukan versi API mana yang didukung SDK, tetapi versi paket saja tidak selalu mengidentifikasi versi API yang digunakan oleh permintaan. Periksa catatan rilis paket dan referensi API (misalnya, untuk Azure.ResourceManager.KeyVault atau azure-mgmt-keyvault) dan bandingkan dengan versi paket dalam manifes dependensi proyek Anda. Untuk referensi API menurut bahasa, lihat Azure Key Vault pustaka klien.
  • Azure CLI dan Azure PowerShell: Versi Azure CLI atau Az modul Anda menentukan versi API. Periksa versi yang diinstal dengan versi az atau Get-InstalledModule -Name Az.
  • Azure portal: Portal memilih versi API sarana kontrol untuk permintaannya. Anda tidak dapat mengatur versi tersebut secara langsung. Portal dapat menggunakan versi API yang berbeda dari templat, skrip, atau SDK Anda, jadi jangan gunakan perilaku portal untuk menentukan versi yang digunakan oleh otomatisasi Anda.
  • Azure Cloud Shell: Cloud Shell menggunakan versi Azure CLI dan Azure PowerShell saat ini. Jika Anda menjalankan skrip di Cloud Shell, pastikan skrip kompatibel dengan versi API sarana kontrol yang saat ini didukung.

Bidang data

  • REST API: Versi adalah api-version parameter string kueri pada permintaan ke titik akhir vault Anda, misalnya GET https://<vault-name>.vault.azure.net/secrets/<name>?api-version=<data-plane-version>.
  • SDK data plane: Versi paket dapat menentukan versi API mana yang didukung oleh SDK, tetapi versi paket saja tidak selalu mengidentifikasi versi API yang digunakan dalam permintaan. Periksa catatan rilis paket dan referensi API (misalnya, untuk Azure.Security.KeyVault.Secrets, , Azure.Security.KeyVault.Keysatau Azure.Security.KeyVault.Certificates) dan bandingkan dengan versi paket dalam manifes dependensi proyek Anda. Untuk referensi API menurut bahasa, lihat Azure Key Vault pustaka klien.

Memperbarui versi API Anda

Memperbarui versi API sarana kontrol

  1. Perbarui versi API di templat dan panggilan REST Anda. Atur apiVersion (ARM, Bicep, Terraform) atau parameter string kueri api-version (REST) ke versi control plane yang saat ini didukung di semua definisi Microsoft.KeyVault/vaults dan permintaan manajemen.

  2. Perbarui SDK manajemen sarana kontrol Anda. Periksa catatan rilis paket dan referensi API untuk versi paket yang mendukung versi API sarana kontrol yang Anda pilih. Untuk referensi API berdasarkan bahasa dan versi paket yang mendukung versi sarana kontrol Key Vault saat ini, lihat Azure Key Vault pustaka klien dan rilis SDK sarana kontrol.

    Note

    Memperbarui SDK manajemen sarana kontrol tidak memperbarui SDK sarana data. Perbarui setiap SDK secara terpisah jika aplikasi Anda menggunakan kedua permukaan API.

  3. Perbarui Azure CLI dan Azure PowerShell. Versi alat yang lebih baru memanggil versi API yang lebih baru.

    Perbarui Azure CLI ke versi terbaru. Untuk informasi selengkapnya, lihat Cara memperbarui Azure CLI.

  1. Tinjau perubahan perilaku sebelum Anda menyebarkan. Baca log perubahan dan spesifikasi versi API sebelum Anda menyebarkan. Versi 2026-02-01 API dan yang lebih baru mengubah model kontrol akses default hanya untuk brankas kunci baru. Untuk detailnya, lihat Merencanakan RBAC Azure sebagai model kontrol akses default di Key Vault.

Perbarui versi API data plane

  1. Perbarui versi API dalam panggilan REST Anda. Atur parameter string kueri api-version ke versi bidang data yang saat ini didukung, yang tercantum dalam referensi REST API Azure Key Vault.

  2. Perbarui SDK data plane Anda. Azure.Security.KeyVault.* Tingkatkan paket (atau yang setara untuk bahasa Anda) ke versi stabil saat ini. Periksa catatan rilis paket dan referensi API untuk menentukan versi API bidang data mana yang didukung oleh paket ini. Untuk referensi API dan tautan paket berdasarkan bahasa, lihat Azure Key Vault pustaka klien.

Versi API bidang data yang stabil tidak terpengaruh oleh penghentian bidang kontrol saat ini. Jika Anda menggunakan API sarana data pratinjau, tinjau pengumuman layanan dan referensi API untuk siklus hidupnya.

Untuk informasi selengkapnya tentang memanggil REST API sarana data, lihat Autentikasi, permintaan, dan respons serta referensi REST API Azure Key Vault.

Konten terkait

  • Terakhir diperbarui pada