Dela via

API-versionsavgångar (juni 2024)

  • Artikel

GÄLLER FÖR: Förbrukning | Utvecklare | Grundläggande | Standard | Premium

Azure API Management använder Azure Resource Manager (ARM) för konfigurera API Management-instanser. API-versionen är inbäddad i din användning av mallar som beskriver din infrastruktur, de verktyg som används för att konfigurera tjänsten och de program som du skriver för att hantera dina Azure API Management-tjänster.

Från och med 1 juni 2024 dras alla API-versioner för Azure API Management-tjänsten före 2021-08-01 tillbaka (inaktiverad). Det tidigare kommunicerade datumet för pensionering var den 30 september 2023. När som helst efter den 1 juni 2024 kan API-anrop med hjälp av en API-version före 2021-08-01 misslyckas utan ytterligare meddelande. Du kommer inte längre att kunna skapa eller hantera DINA API Management-tjänster med befintliga mallar, verktyg, skript och program med en tillbakadragen API-version förrän de har uppdaterats för att använda API-version 2021-08-01 eller senare. Dataplansåtgärder (till exempel att förmedla API-begäranden i gatewayen) påverkas inte av den här uppdateringen, inklusive efter den 1 juni 2024.

Påverkas min tjänst av detta?

Även om din tjänst inte påverkas av den här ändringen påverkas alla verktyg, skript eller program som använder Azure Resource Manager (till exempel Azure CLI, Azure PowerShell, Azure API Management DevOps Resource Kit eller Terraform) för att interagera med API Management-tjänsten och anropar en API Management API-version före 2021-08-01 av den här ändringen. När en API-version har dragits tillbaka kan du inte köra några verktyg som påverkas om du inte uppdaterar verktygen.

Vilken är tidsfristen för ändringen?

De berörda API-versionerna dras tillbaka gradvis från och med den 1 juni 2024.

När en API-version har dragits tillbaka fortsätter tjänsterna att köras om du föredrar att inte uppdatera de verktyg, skript och program som påverkas. Du kommer dock inte att kunna lägga till eller ta bort API:er, ändra API-princip eller på annat sätt konfigurera API Management-tjänsten med berörda verktyg.

Nödvändig åtgärd

Uppdatera dina verktyg, skript och program med hjälp av informationen i följande avsnitt.

Vi rekommenderar också att du anger lägsta API-version i DIN API Management-instans.

Uppdatera dina verktyg, skript och program

  • ARM-, Bicep- eller Terraform-mallar – Uppdatera mallen så att den använder API-version 2021-08-01 eller senare.

  • Azure CLI – Kör az version för att kontrollera din version. Om du kör version 2.42.0 eller senare krävs ingen åtgärd. az upgrade Använd kommandot för att uppgradera Azure CLI om det behövs. Mer information finns i Så här uppdaterar du Azure CLI.

  • Azure PowerShell – Kör Get-Module -ListAvailable -Name Az för att kontrollera din version. Om du kör version 8.1.0 eller senare krävs ingen åtgärd. Använd Update-Module -Name Az -Repository PSGallery för att uppdatera modulen om det behövs. Mer information finns i Installera Azure Az PowerShell-modulen.

  • Andra verktyg – Använd följande versioner (eller senare):

    • API Management DevOps Resource Kit: 1.0.0
    • Terraform azurerm-provider: 3.0.0

  • Azure SDK:er – Uppdatera Azure API Management SDK:er till de senaste versionerna eller åtminstone följande versioner:

    • .NET: v1.1.0
    • Gå: 1.0.0
    • Python: 3.0.0
    • JavaScript: 8.0.1
    • Java: 1.0.0-beta3

Uppdatera inställningen lägsta API-version på DIN API Management-instans

Vi rekommenderar att du anger lägsta API-version för din API Management-instans med hjälp av Azure-portalen eller med hjälp av REST-API:et eller andra verktyg. Den här inställningen begränsar kontrollplanets API-anrop till din instans till en API-version som är lika med eller nyare än det här värdet. Genom att ange det här värdet till 2021-08-01 kan du utvärdera effekten av api-versionens tillbakadragningar på dina verktyg.

Så här anger du lägsta API-version i portalen:

  1. I Azure-portalen går du till din API Management-instans.
  2. I den vänstra menyn går du till Distribution + infrastruktur och väljer Hanterings-API.
  3. Välj fliken Inställningar för hanterings-API.
  4. Under Framtvinga lägsta API-version väljer du Ja. Den lägsta API-versionen visas.
  5. Välj Spara.

Viktigt!

Om den lägsta API-versionen i portalen är nedtonad kan du bara uppdatera inställningen programmatiskt, till exempel med hjälp av REST-API:et eller kommandot az apim update i Azure CLI.

Mer information

Relaterat innehåll

Se alla kommande icke-bakåtkompatibla ändringar och funktionsavbrott.