Freigeben über

Eingestellte API-Versionen (Juni 2024)

  • Artikel

GILT FÜR: Verbrauch | Developer | Basic | Standard | Premium

Azure API Management verwendet Azure Resource Manager (ARM), um Ihre API Management-Instanzen zu konfigurieren. Die API-Version ist in Ihre Verwendung von Vorlagen eingebettet, die Ihre Infrastruktur beschreiben, Tools, die zum Konfigurieren des Diensts verwendet werden, und Programme, die Sie schreiben, um Ihre Azure API Management-Dienste zu verwalten.

Ab dem 1. Juni 2024 werden alle API-Versionen für den Azure API Management-Dienst vor 2021-08-01 eingestellt (deaktiviert). Der zuvor mitgeteilte Ruhestandstermin war der 30. September 2023. Nach dem 1. Juni 2024 können API-Aufrufe mit einer API-Version vor 2021-08-01 ohne weitere Ankündigung fehlschlagen. Sie können Ihre API-Verwaltungsdienste nicht mehr mit vorhandenen Vorlagen, Tools, Skripts und Programmen erstellen oder verwalten, bis sie aktualisiert wurden, um DIE API-Version 2021-08-01 oder höher zu verwenden. Vorgänge auf der Datenebene (z. B. die Vermittlung von API-Anforderungen im Gateway) werden von diesem Update nicht betroffen sein, einschließlich nach dem 1. Juni 2024.

Ist mein Dienst davon betroffen?

Während Ihr Dienst von dieser Änderung nicht betroffen ist, werden alle Tools, Skripts oder Programme, die den Azure Resource Manager (z. B. azure CLI, Azure PowerShell, Azure API Management DevOps Resource Kit oder Terraform) verwenden, um mit dem API-Verwaltungsdienst zu interagieren und eine API-Verwaltungs-API-Version vor 2021-08-01 auf diese Änderung zu aufrufen. Nachdem eine API-Version eingestellt wurde, können Sie keine betroffenen Tools erfolgreich ausführen, es sei denn, Sie aktualisieren die Tools.

Wann wird die Änderung vorgenommen?

Die betroffenen API-Versionen werden ab dem 1. Juni 2024 schrittweise eingestellt.

Nachdem eine API-Version eingestellt wurde, werden Ihre Dienste weiterhin ausgeführt, wenn Sie ihre betroffenen Tools, Skripts und Programme nicht aktualisieren möchten. Sie können jedoch keine APIs hinzufügen oder entfernen, api-Richtlinien ändern oder ihren API-Verwaltungsdienst mit betroffenen Tools konfigurieren.

Erforderliche Maßnahme

Aktualisieren Sie Ihre Tools, Skripts und Programme mithilfe der Details im folgenden Abschnitt.

Außerdem wird empfohlen, die Mindest-API-Version in Ihrer API-Verwaltungsinstanz festzulegen.

Aktualisieren Von Tools, Skripts und Programmen

  • ARM-, Bicep- oder Terraform-Vorlagen: Aktualisieren Sie die jeweilige Vorlage so, dass sie die API-Version 2021-08-01 oder höher verwendet.

  • Azure CLI: Führen Sie az version aus, um Ihre Version zu überprüfen. Wenn Sie Version 2.42.0 oder höher ausführen, ist keine Aktion erforderlich. Verwenden Sie den Befehl az upgrade, um die Azure CLI bei Bedarf zu aktualisieren. Weitere Informationen finden Sie unter Aktualisieren von Azure CLI.

  • Azure PowerShell: Führen Sie Get-Module -ListAvailable -Name Az aus, um Ihre Version zu überprüfen. Wenn Sie Version 8.1.0 oder höher ausführen, ist keine Aktion erforderlich. Verwenden Sie Update-Module -Name Az -Repository PSGallery, um das Modul gegebenenfalls zu aktualisieren. Weitere Informationen finden Sie unter Installieren des Azure Az PowerShell-Moduls.

  • Andere Tools: Verwenden Sie die folgenden Versionen (oder höher):

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

  • Azure SDKs – Aktualisieren Sie die Azure API Management-SDKs auf die neuesten Versionen oder mindestens die folgenden Versionen:

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

Aktualisieren der Mindest-API-Versionseinstellung für Ihre API-Verwaltungsinstanz

Es wird empfohlen, die Mindest-API-Version für Ihre API-Verwaltungsinstanz mithilfe der Azure-Portal oder verwendung der REST-API oder anderer Tools festzulegen. Diese Einstellung schränkt die Steuerungsebenen-API-Aufrufe ihrer Instanz auf eine API-Version ein, die gleich oder neuer ist als dieser Wert. Durch Festlegen dieses Werts auf 2021-08-01 können Sie die Auswirkungen der Deaktivierung der API-Version auf Ihre Tools bewerten.

So legen Sie die Mindest-API-Version im Portal fest:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
  2. Wählen Sie im linken Menü unter Bereitstellung + Infrastruktur die Verwaltungs-API aus.
  3. Wählen Sie die Registerkarte "Verwaltungs-API-Einstellungen" aus .
  4. Wählen Sie unter "Mindest-API-Version erzwingen" "Ja" aus. Die Mindest-API-Version wird angezeigt.
  5. Wählen Sie Speichern.

Wichtig

Wenn die Mindest-API-Version im Portal ausgegraut ist, können Sie die Einstellung nur programmgesteuert aktualisieren, z. B. mithilfe der REST-API oder des Az APIM-Updatebefehls in der Azure CLI.

Weitere Informationen

Zugehöriger Inhalt

Sehen Sie sich alle bevorstehenden Breaking Changes und Funktionseinstellungen an.