Aktualizace používané verze rozhraní API Azure Key Vault

Azure Key Vault používá verzovaná rozhraní API. Pokud vaše aplikace, skripty nebo šablony infrastruktury volají starší verzi rozhraní API, můžou vám chybět novější funkce, používat chování, které se změnilo v novější verzi nebo závisí na verzi, která se už nedoporučuje. Tento článek vysvětluje, jak určit, jakou verzi rozhraní API používáte, a jak přejít na aktuální podporovanou verzi.

Important

Všechny verze rozhraní API řídicí roviny služby Key Vault před verzí 2026-02-01 budou vyřazeny k 27. února 2027. Po tomto datu budou vaše trezory klíčů i nadále existovat, ale spravovat je budete moct pouze pomocí rozhraní API roviny řízení ve verzi 2026-02-01 nebo novější. K tomuto datu neexistuje žádná výjimka ani rozšíření. Toto ukončení nemá vliv na rozhraní API data plane (rozhraní API používaná pro práci s klíči, tajnými údaji a certifikáty). Podrobnosti najdete v tématu Plán pro Azure RBAC jako výchozí model řízení přístupu v Key Vault.

Azure Key Vault má dva nezávislé rozhraní API, z nichž každý má vlastní verze:

Plocha rozhraní API Co spravuje Schéma verzí Příklad koncového bodu
Řídicí vrstva (správa) Samotný prostředek trezoru klíčů: vytváření, aktualizace a odstraňování trezorů a konfigurace vlastností, jako jsou SKU, síťová pravidla a řízení přístupu. Na základě data ({YYYY}-{MM}-{DD}) https://management.azure.com
Datová rovina Objekty uvnitř trezoru: klíče, tajné kódy a certifikáty a kryptografické operace. Na základě data ({YYYY}-{MM}-{DD}) https://<vault-name>.vault.azure.net

Obě rozhraní mají odlišné postupy verzování a správy životního cyklu. Aktualizace jednoho neaktualizuje druhý. Zkontrolujte obojí, pokud vaše úloha používá obojí.

Verze rozhraní API řídicí roviny mohou být vyřazeny, jak je popsáno výše v tomto článku.

Verze rozhraní API roviny dat ve verzi Preview se dají přestat používat, takže pokud tento životní cyklus nepřijmete, nepoužívejte verze Preview v produkčním prostředí. Podporované verze rozhraní API roviny dat najdete v referenčních informacích k Azure Key Vault rozhraní REST API.

Tento článek se zaměřuje na identifikaci a aktualizaci verzí rozhraní API. Aktualizace verze rozhraní API roviny řízení nevyžaduje migraci existujícího trezoru klíčů ze zásad přístupu do Azure RBAC. Pokud chcete migrovat řízení přístupu, přečtěte si téma Migrace na Azure RBAC ze zásad přístupu. Výchozí chování Azure RBAC zavedené pro nové trezory klíčů v rozhraní API verze 2026-02-01 a novějších najdete v tématu Plánování Azure RBAC jako výchozího modelu řízení přístupu v Key Vaultu.

Proč přejít na aktuální verzi rozhraní API

  • Používejte podporované funkce. Novější verze rozhraní API můžou přidávat funkce, správné chování nebo podporovat nové funkce služeb.
  • Udržujte provozní úlohy stabilní. Pro produkční úlohy použijte aktuální stabilní verzi rozhraní API. Preview verze rozhraní API jsou určeny k vyhodnocení a ranému testování a smlouvy SLA podpory Azure se na ně nemusejí vztahovat. Preview verze mohou být označeny jako zastaralé.
  • Udržujte nástroje a knihovny kompatibilní. Azure CLI, Azure PowerShell, sady SDK, šablony a portál můžou používat různé verze rozhraní API. Aktualizace verze pro jednoho klienta neaktualizuje ostatní.

Aktuální verze roviny řízení naleznete v tématu Podporované verze rozhraní API roviny řízení. Podporované verze roviny dat najdete v referenčních informacích k Azure Key Vault rozhraní REST API.

Určení používané verze rozhraní API

Verzi rozhraní API zadáte odlišně podle toho, jak voláte Key Vault. Zkontrolujte každé prostředí, které vaše úloha používá.

Řídicí rovina (správa)

  • REST API: Verze je parametr api-version v query stringu v požadavcích na https://management.azure.com, například ?api-version=<control-plane-version>.
  • Šablony ARM, Bicep a Terraform: Verze je vlastnost apiVersion u každého prostředku Microsoft.KeyVault/vaults. V Bicep je součástí deklarace typu prostředku, například resource kv 'Microsoft.KeyVault/vaults@2026-02-01'.
  • Sady SDK pro správu řídicí roviny: Verze balíčku může určovat, které verze rozhraní API sada SDK podporuje, ale samotná verze balíčku neumožňuje vždy určit verzi rozhraní API použitou v požadavku. Projděte si poznámky k verzi balíčku a referenční informace k rozhraní API (například pro Azure.ResourceManager.KeyVault nebo azure-mgmt-keyvault) a porovnejte je s verzí balíčku v manifestu závislostí vašeho projektu. Reference k rozhraní API podle jazyka najdete v tématu klientské knihovny Azure Key Vault.
  • Azure CLI a Azure PowerShell: Verze Azure CLI nebo Az modulu určuje verzi rozhraní API. Zkontrolujte nainstalovanou verzi pomocí az version nebo Get-InstalledModule -Name Az.
  • portál Azure: Portál pro své požadavky vybere verzi rozhraní API řídicí roviny. Tuto verzi nemůžete nastavit přímo. Portál může používat jinou verzi rozhraní API než šablony, skripty nebo sady SDK, takže k určení verze používané automatizací nepoužívejte chování portálu.
  • Azure Cloud Shell: Cloud Shell používá aktuální verze Azure CLI a Azure PowerShell. Pokud spouštíte skripty v Cloud Shell, ujistěte se, že jsou kompatibilní s aktuálně podporovanou verzí rozhraní API roviny řízení.

Datová rovina

  • REST API: Verze je parametr api-version v řetězci dotazu v požadavcích na koncový bod vašeho trezoru, například GET https://<vault-name>.vault.azure.net/secrets/<name>?api-version=<data-plane-version>.
  • Sady SDK pro datovou vrstvu: Verze balíčku může určit, které verze rozhraní API balíček SDK podporuje, ale samotná verze balíčku ne vždy určuje verzi rozhraní API použitou v požadavku. Projděte si poznámky k vydání balíčku a referenční dokumentaci k API (například pro Azure.Security.KeyVault.Secrets, Azure.Security.KeyVault.Keys nebo Azure.Security.KeyVault.Certificates) a porovnejte je s verzí balíčku uvedenou v manifestu závislostí vašeho projektu. Referenční informace k rozhraní API podle jazyka najdete v článku Klientské knihovny pro Azure Key Vault.

Aktualizace verze rozhraní API

Aktualizace verze rozhraní API roviny řízení

  1. Aktualizujte verzi rozhraní API ve svých šablonách a voláníCH REST. Nastavte apiVersion (ARM, Bicep, Terraform) nebo parametr řetězce dotazu api-version (REST) na aktuálně podporovanou verzi řídicí roviny ve všech definicích Microsoft.KeyVault/vaults a požadavcích na správu.

  2. Aktualizujte sady SDK pro správu řídicí roviny. Projděte si poznámky k verzi balíčku a referenční informace k rozhraní API pro verzi balíčku, která podporuje verzi rozhraní API roviny řízení, kterou jste vybrali. Referenční informace k rozhraní API podle jazyka a verze balíčků, které podporují aktuální verzi řídicí roviny Key Vault, naleznete v tématech Klientské knihovny pro Azure Key Vault a Verze sady SDK pro řídicí rovinu.

    Note

    Aktualizace sady SDK pro správu řídicí roviny neaktualizuje sady SDK roviny dat. Aktualizujte jednotlivé sady SDK samostatně, pokud vaše aplikace používá obě plochy rozhraní API.

  3. Aktualizujte Azure CLI a Azure PowerShell. Novější verze nástrojů volají novější verze rozhraní API.

    Aktualizujte Azure CLI na nejnovější verzi. Další informace najdete v tématu Jak aktualizovat Azure CLI.

  1. Před nasazením zkontrolujte změny chování. Před nasazením si přečtěte protokol změn a specifikaci verze rozhraní API. Verze 2026-02-01 rozhraní API a novější změní výchozí model řízení přístupu pouze pro nové trezory klíčů. Podrobnosti najdete v tématu Plán pro Azure RBAC jako výchozí model řízení přístupu v Key Vault.

Aktualizace verze rozhraní API roviny dat

  1. Aktualizujte verzi rozhraní API ve voláníCH REST. api-version Nastavte parametr řetězce dotazu na aktuálně podporovanou verzi roviny dat uvedenou v referenčních informacích k rozhraní AZURE KEY VAULT REST API.

  2. Aktualizujte své sady SDK pro datovou rovinu. Azure.Security.KeyVault.* Upgradujte balíčky (nebo ekvivalent pro váš jazyk) na aktuální stabilní verzi. Projděte si poznámky k verzi balíčku a referenční informace k rozhraní API a zjistěte, které verze rozhraní API roviny dat balíček podporuje. Referenční informace k rozhraní API a odkazy na balíčky podle jazyka najdete v článku Klientské knihovny Azure Key Vault.

Současné vyřazení řídicí roviny nemá vliv na stabilní verze rozhraní API roviny dat. Pokud používáte rozhraní API roviny dat ve verzi Preview, projděte si oznámení služby a referenční dokumentaci k tomuto API týkající se jeho životního cyklu.

Další informace o volání rozhraní REST API roviny dat najdete v tématu Ověřování, požadavky a odpovědi a referenční informace k rozhraní REST API Azure Key Vault.

Související obsah

  • Poslední aktualizace v