Partager via

Mise hors service des versions de l’API (juin 2024)

  • Article

S’APPLIQUE À : Consommation | Développeur | De base | Standard | Premium

Azure Gestion des API utilise Azure Resource Manager (ARM) pour configurer vos instances de Gestion des API. La version de l’API est incorporée dans votre utilisation de modèles qui décrivent votre infrastructure, les outils utilisés pour configurer le service et les programmes que vous écrivez pour gérer vos services Azure Gestion des API.

À compter du 1er juin 2024, toutes les versions d’API du service Azure Gestion des API antérieures à 2021-08-01 sont supprimées (désactivées). La date de retraite précédemment communiquée était le 30 septembre 2023. À tout moment après le 1er juin 2024, les appels d’API utilisant une version d’API antérieure à 2021-08-01 peuvent échouer sans préavis. Vous ne pourrez plus créer ou gérer vos services Gestion des API avec des modèles, outils, scripts et programmes existants à l’aide d’une version de l’API supprimée jusqu’à ce qu’ils soient mis à jour pour utiliser l’API version 2021-08-01 ou ultérieure. Les opérations de plan de données (telles que les demandes d’API de médiatage dans la passerelle) ne seront pas affectées par cette mise à jour, y compris après le 1er juin 2024.

Mon service est-il concerné par ce changement ?

Bien que votre service ne soit pas affecté par cette modification, tout outil, script ou programme qui utilise Azure Resource Manager (par exemple, Azure CLI, Azure PowerShell, Azure Gestion des API Kit de ressources DevOps ou Terraform) pour interagir avec le service Gestion des API et appelle une version d’API Gestion des API antérieure à 2021-08-01 est affecté par cette modification. Une fois qu’une version d’API est supprimée, vous ne pourrez pas exécuter correctement les outils affectés, sauf si vous mettez à jour les outils.

Quelle est la date limite pour effectuer ce changement ?

Les versions d’API affectées seront mises hors service progressivement à compter du 1er juin 2024.

Une fois qu’une version d’API est supprimée, si vous préférez ne pas mettre à jour vos outils, scripts et programmes concernés, vos services continueront à s’exécuter. Toutefois, vous ne pourrez pas ajouter ou supprimer des API, modifier la stratégie d’API ou configurer votre service Gestion des API avec des outils affectés.

Action requise

Mettez à jour vos outils, scripts et programmes à l’aide des détails de la section suivante.

Nous vous recommandons également de définir la version minimale de l’API dans votre instance de Gestion des API.

Mettre à jour vos outils, scripts et programmes

  • Modèles ARM, Bicep ou Terraform : mettez à jour le modèle pour utiliser l’API version du 01/08/2021 ou ultérieure.

  • Azure CLI : Exécuter az version pour vérifier votre version. Si vous exécutez la version 2.42.0 ou ultérieure, aucune action n’est requise. Utilisez la commande az upgrade pour mettre à niveau Azure CLI si nécessaire. Pour plus d’informations, consultez Comment mettre à jour Azure CLI.

  • Azure PowerShell : Exécuter Get-Module -ListAvailable -Name Az pour vérifier votre version. Si vous exécutez la version 8.1.0 ou ultérieure, aucune action n’est requise. Utilisez Update-Module -Name Az -Repository PSGallery pour mettre à jour le module si nécessaire. Pour plus d’informations, consultez Installer le module Azure Az PowerShell.

  • Autres outils : utilisez les versions suivantes (ou ultérieures) :

    • Gestion des API Kit de ressources DevOps : 1.0.0
    • Fournisseur Terraform azurerm : 3.0.0

  • Kits de développement logiciel (SDK) Azure - Mettez à jour les kits de développement logiciel (SDK) Azure Gestion des API vers les dernières versions ou au moins les versions suivantes :

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

Mettre à jour le paramètre de version minimale de l’API sur votre instance de Gestion des API

Nous vous recommandons de définir la version minimale de l’API pour votre instance de Gestion des API à l’aide du Portail Azure ou de l’API REST ou d’autres outils. Ce paramètre limite les appels d’API de plan de contrôle à votre instance à une version d’API égale ou ultérieure à cette valeur. En définissant cette valeur sur 2021-08-01, vous pouvez évaluer l’impact des retraits de version de l’API sur vos outils.

Pour définir la version minimale de l’API dans le portail :

  1. Dans le portail Azure, accédez à votre instance APIM.
  2. Dans le menu de gauche, sous Déploiement + infrastructure, sélectionnez API Gestion.
  3. Sélectionnez l’onglet Paramètres de l’API gestion.
  4. Sous Appliquer la version minimale de l’API, sélectionnez Oui. La version minimale de l’API s’affiche.
  5. Cliquez sur Enregistrer.

Important

Si la version minimale de l’API dans le portail est grisée, vous pouvez uniquement mettre à jour le paramètre par programmation, par exemple, à l’aide de l’API REST ou de la commande az apim update dans Azure CLI.

Plus d’informations

Contenu connexe

Consultez l’ensemble des changements et mises hors service nets des fonctionnalités.