De Azure Key Vault API-versie bijwerken die u gebruikt

Azure Key Vault maakt gebruik van versie-API's. Als uw toepassingen, scripts of infrastructuursjablonen een oudere API-versie aanroepen, kunt u nieuwere functies missen, gedrag gebruiken dat is gewijzigd in een latere versie of afhankelijk zijn van een versie die niet meer wordt aanbevolen. In dit artikel wordt uitgelegd hoe u kunt bepalen welke API-versie u gebruikt en hoe u naar een huidige, ondersteunde versie gaat.

Important

Alle API-versies van het Key Vault-beheervlak van vóór 2026-02-01 worden op 27 februari 2027 buiten gebruik gesteld. Na die datum blijven uw sleutelkluizen bestaan, maar u kunt ze alleen beheren met de API-versie 2026-02-01 van het besturingsvlak of hoger. Er is geen uitzondering of extensie tot deze datum. Deze buitengebruikstelling heeft geen invloed op gegevensvlak-API's (de API's die worden gebruikt voor het werken met sleutels, geheimen en certificaten). Zie Plannen voor Azure RBAC als het standaardmodel voor toegangsbeheer in Key Vault voor meer informatie.

Azure Key Vault heeft twee onafhankelijke API-oppervlakken, elk met een eigen versie:

API-oppervlak Wat het beheert Versieschema Voorbeeldeindpunt
Besturingsvlak (beheer) De sleutelkluisresource zelf: kluizen maken, bijwerken, verwijderen en eigenschappen configureren, zoals SKU, netwerkregels en toegangsbeheer. Op datum gebaseerd ({YYYY}-{MM}-{DD}) https://management.azure.com
Gegevensvlak Objecten in een kluis: sleutels, geheimen en certificaten en cryptografische bewerkingen. Op datum gebaseerd ({YYYY}-{MM}-{DD}) https://<vault-name>.vault.azure.net

De twee oppervlakken hebben verschillende versie- en levenscyclusprocedures. Als u het ene bijwerkt, wordt de andere niet bijgewerkt. Controleer beide als uw workload ze allebei gebruikt.

API-versies van de beheerlaag kunnen buiten gebruik worden gesteld, zoals eerder in dit artikel beschreven.

Previewversies van gegevensvlak-API's kunnen worden uitgefaseerd, dus gebruik geen previewversies in productie tenzij u die levenscyclus aanvaardt. Zie de Azure Key Vault REST API-verwijzing voor ondersteunde versies van de gegevensvlak-API.

Dit artikel is gericht op het identificeren en bijwerken van API-versies. Voor het bijwerken van de API-versie van een besturingsvlak hoeft u een bestaande sleutelkluis niet over te zetten van toegangsbeleid naar Azure RBAC. Zie Migreren naar Azure RBAC vanuit toegangsbeleid als u toegangsbeheer wilt migreren. Voor het standaardgedrag van Azure RBAC dat is geïntroduceerd voor nieuwe Key Vault-kluizen in API-versie en later, zie 2026-02-01.

Waarom overstappen naar een huidige API-versie

  • Gebruik ondersteunde mogelijkheden. Nieuwere API-versies kunnen functionaliteit toevoegen, gedrag corrigeren of nieuwe servicefuncties ondersteunen.
  • Houd productieworkloads stabiel. Gebruik een huidige stabiele API-versie voor productieworkloads. Preview-API-versies zijn bedoeld voor evaluatie en vroege tests, en ondersteuning voor Azure SLA's hebben mogelijk geen betrekking op deze SLA's. Preview-versies kunnen worden afgeschaft.
  • Houd hulpprogramma's en bibliotheken compatibel. Azure CLI, Azure PowerShell, SDK's, sjablonen en de portal kunnen verschillende API-versies gebruiken. Als u de versie voor één client bijwerkt, worden de andere niet bijgewerkt.

Zie Ondersteunde API-versies van besturingsvlak voor huidige versies van het besturingsvlak. Zie de naslaginformatie Azure Key Vault REST API voor ondersteunde versies van gegevensvlakken.

Bepalen welke API-versie u gebruikt

U geeft de API-versie anders op, afhankelijk van de manier waarop u Key Vault aanroept. Controleer elk oppervlak dat uw workload gebruikt.

Besturingsvlak (beheer)

  • REST API: De versie is de api-version queryreeksparameter voor aanvragen naar https://management.azure.com, bijvoorbeeld ?api-version=<control-plane-version>.
  • ARM-, Bicep- en Terraform-sjablonen: De versie staat in de eigenschap apiVersion van elke Microsoft.KeyVault/vaults-resource. In Bicep maakt deze bijvoorbeeld resource kv 'Microsoft.KeyVault/vaults@2026-02-01'deel uit van de declaratie van het resourcetype.
  • Beheer-SDK's voor besturingsvlak: de pakketversie kan bepalen welke API-versies een SDK ondersteunt, maar de pakketversie alleen identificeert niet altijd de API-versie die wordt gebruikt door een aanvraag. Controleer de opmerkingen bij de release van het pakket en de API-verwijzing (bijvoorbeeld voor Azure.ResourceManager.KeyVault of azure-mgmt-keyvault) en vergelijk deze met de pakketversie in het afhankelijkheidsmanifest van uw project. Zie Azure Key Vault clientbibliotheken voor API-verwijzingen per taal.
  • Azure CLI en Azure PowerShell: De versie van uw Azure CLI of Az module bepaalt de API-versie. Controleer uw geïnstalleerde versie met az version of Get-InstalledModule -Name Az.
  • Azure portal: De portal selecteert de API-versie van het besturingsvlak voor de aanvragen. U kunt die versie niet rechtstreeks instellen. De portal kan een andere API-versie gebruiken dan uw sjablonen, scripts of SDK's, dus gebruik geen portalgedrag om de versie te bepalen die door uw automatisering wordt gebruikt.
  • Azure Cloud Shell: Cloud Shell maakt gebruik van de huidige Azure CLI en Azure PowerShell versies. Als u scripts uitvoert in Cloud Shell, controleert u of deze compatibel zijn met de momenteel ondersteunde API-versie van het besturingsvlak.

Gegevensvlak

  • REST API: De versie staat in de api-version querystringparameter van verzoeken aan uw vault-eindpunt, bijvoorbeeld GET https://<vault-name>.vault.azure.net/secrets/<name>?api-version=<data-plane-version>.
  • SDK's voor gegevensvlak: de pakketversie kan bepalen welke API-versies een SDK ondersteunt, maar de pakketversie alleen identificeert niet altijd de API-versie die wordt gebruikt door een aanvraag. Controleer de opmerkingen bij de release van het pakket en de API-verwijzing (bijvoorbeeld voor Azure.Security.KeyVault.Secrets, Azure.Security.KeyVault.Keysof Azure.Security.KeyVault.Certificates) en vergelijk deze met de pakketversie in het afhankelijkheidsmanifest van uw project. Zie Azure Key Vault clientbibliotheken voor API-verwijzingen per taal.

Uw API-versie bijwerken

De API-versie van het besturingsvlak bijwerken

  1. Werk de API-versie bij in uw sjablonen en REST-aanroepen. Stel apiVersion (ARM, Bicep, Terraform) of de api-version querytekenreeksparameter (REST) in op een momenteel ondersteunde versie van het besturingsvlak in alle Microsoft.KeyVault/vaults definities en beheeraanvragen.

  2. Werk uw beheer-SDK’s voor de control plane bij. Controleer de opmerkingen bij de release van het pakket en de API-verwijzing voor de pakketversie die ondersteuning biedt voor de api-versie van het besturingsvlak die u hebt geselecteerd. Zie voor API-verwijzingen per taal en de pakketversies die ondersteuning bieden voor de huidige versie van het Key Vault besturingsvlak Azure Key Vault clientbibliotheken en releases van de Control Plane SDK.

    Note

    Het bijwerken van een beheer-SDK voor besturingsvlakken werkt geen SDK's voor het gegevensvlak bij. Werk elke SDK afzonderlijk bij als uw toepassing beide API-oppervlakken gebruikt.

  3. Werk Azure CLI en Azure PowerShell bij. Nieuwere hulpprogrammaversies roepen nieuwere API-versies aan.

    Werk de Azure CLI bij naar de nieuwste versie. Zie Het bijwerken van de Azure CLI voor meer informatie.

  1. Bekijk gedragswijzigingen voordat u implementeert. Lees het wijzigingslogboek en de specificatie van de API-versie voordat u implementeert. API-versie 2026-02-01 en hoger wijzigen het standaardmodel voor toegangsbeheer alleen voor nieuwe sleutelkluizen. Zie Plannen voor Azure RBAC als het standaardmodel voor toegangsbeheer in Key Vault voor meer informatie.

De API-versie van het gegevensvlak bijwerken

  1. Werk de API-versie bij in uw REST-aanroepen. Stel de api-version querytekenreeksparameter in op een momenteel ondersteunde versie van het gegevensvlak die wordt vermeld in de naslaginformatie over de REST API van Azure Key Vault.

  2. Werk de SDK's van uw gegevensvlak bij. Werk de Azure.Security.KeyVault.* pakketten (of het equivalent voor uw taal) bij naar een huidige stabiele versie. Controleer de opmerkingen bij de release van het pakket en de API-verwijzing om te bepalen welke API-versies van het gegevensvlak het pakket ondersteunt. Zie Azure Key Vault clientbibliotheken voor API-verwijzingen en pakketkoppelingen per taal.

Stabiele API-versies van gegevensvlakken worden niet beïnvloed door de huidige buitengebruikstelling van het besturingsvlak. Als u een previewversie van een gegevensvlak-API gebruikt, raadpleeg dan de serviceaankondigingen en de API-referentie voor informatie over de levenscyclus ervan.

Zie Verificatie, aanvragen en antwoorden en de Azure Key Vault REST API-verwijzing voor meer informatie over het aanroepen van de REST API voor het gegevensvlak.

Verwante onderwerpen

  • Laatst bijgewerkt om