Vyřazení verzí rozhraní API (červen 2024)

  • Článek

PLATÍ PRO: Consumption | Vývojář | Základní | Standardní | Premium

Azure API Management ke konfiguraci instancí služby API Management používá Azure Resource Manager (ARM). Verze rozhraní API je vložená do vašich používaných šablon, které popisují vaši infrastrukturu, nástroje používané ke konfiguraci služby a programy, které píšete pro správu služeb Azure API Management.

Od 1. června 2024 se všechny verze rozhraní API pro službu Azure API Management před 8. 8. 2021 vyřadí z provozu (zakázané). Datum vyřazení dříve bylo 30. září 2023. Kdykoli po 1. červnu 2024 můžou volání rozhraní API používající verzi rozhraní API před 2021-08-01 selhat bez dalšího upozornění. Už nebudete moct vytvářet ani spravovat služby API Management pomocí existujících šablon, nástrojů, skriptů a programů pomocí vyřazené verze rozhraní API, dokud nebudou aktualizovány tak, aby používaly rozhraní API verze 2021-08-01 nebo novější. Operace roviny dat (například mediating požadavků rozhraní API v bráně) nebudou touto aktualizací ovlivněny, včetně po 1. červnu 2024.

To má vliv na moji službu?

I když na vaši službu nemá tato změna vliv, žádný nástroj, skript nebo program, který používá Azure Resource Manager (například Azure CLI, Azure PowerShell, Sadu prostředků Azure API Management DevOps nebo Terraform) k interakci se službou API Management a volání verze rozhraní API Management před 2021-08-01, se touto změnou ovlivní. Po vyřazení verze rozhraní API nebudete moct úspěšně spustit žádné ovlivněné nástroje, pokud nástroje neaktualizujete.

Jaký je konečný termín změny?

Ovlivněné verze rozhraní API budou postupně vyřazeny od 1. června 2024.

Po vyřazení verze rozhraní API, pokud nechcete aktualizovat ovlivněné nástroje, skripty a programy, budou se služby dál spouštět. Nebudete ale moct přidávat ani odebírat rozhraní API, měnit zásady rozhraní API nebo jinak konfigurovat službu API Management s ovlivněnými nástroji.

Požadovaná akce

Pomocí podrobností v následující části aktualizujte nástroje, skripty a programy.

Doporučujeme také nastavit minimální verzi rozhraní API ve vaší instanci služby API Management.

Aktualizace nástrojů, skriptů a programů

  • Šablony ARM, Bicep nebo Terraform – Aktualizujte šablonu tak, aby používala rozhraní API verze 2021-08-01 nebo novější.

  • Azure CLI – Spuštěním az version zkontrolujte svou verzi. Pokud používáte verzi 2.42.0 nebo novější, nevyžaduje se žádná akce. az upgrade V případě potřeby pomocí příkazu upgradujte Azure CLI. Další informace najdete v tématu Postup aktualizace Azure CLI.

  • Azure PowerShell – Spuštěním Get-Module -ListAvailable -Name Az zkontrolujte svou verzi. Pokud používáte verzi 8.1.0 nebo novější, nevyžaduje se žádná akce. V Update-Module -Name Az -Repository PSGallery případě potřeby modul aktualizujte. Další informace najdete v tématu Instalace modulu Azure Az PowerShell.

  • Jiné nástroje – použijte následující verze (nebo novější):

    • Sada prostředků API Management DevOps: 1.0.0
    • Zprostředkovatel Terraform azurerm: 3.0.0

  • Sady Azure SDK – Aktualizujte sady SDK služby Azure API Management na nejnovější verze nebo alespoň následující verze:

    • .NET: v1.1.0
    • Přejít: 1.0.0
    • Python: 3.0.0
    • JavaScript: 8.0.1
    • Java: 1.0.0-beta3

Aktualizace nastavení minimální verze rozhraní API v instanci služby API Management

Doporučujeme nastavit minimální verzi rozhraní API pro vaši instanci služby API Management pomocí webu Azure Portal nebo pomocí rozhraní REST API nebo jiných nástrojů. Toto nastavení omezuje volání rozhraní API řídicí roviny do vaší instance na verzi rozhraní API, která je rovna nebo novější než tato hodnota. Nastavením této hodnoty na 2021-08-01 můžete vyhodnotit dopad vyřazení verzí rozhraní API na vaše nástroje.

Nastavení minimální verze rozhraní API na portálu:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.
  2. V nabídce vlevo v části Nasazení a infrastruktura vyberte rozhraní API pro správu.
  3. Vyberte kartu Nastavení rozhraní API pro správu.
  4. V části Vynutit minimální verzi rozhraní API vyberte Ano. Zobrazí se minimální verze rozhraní API.
  5. Zvolte Uložit.

Důležité

Pokud je minimální verze rozhraní API na portálu neaktivní, můžete nastavení aktualizovat pouze programově, například pomocí rozhraní REST API nebo příkazu az apim update v Azure CLI.

Více informací

Související obsah

Podívejte se na všechny nadcházející zásadní změny a vyřazení funkcí.