Mettre à jour une définition d'API dans Azure API Management - Cloud

Exemples d'utilisation de Talend Cloud API Designer
Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
Last publication date
2024-03-06

Importez un fichier sur Azure API Management pour mettre à jour une définition existante.

Avant de commencer

  • Vous avez accès à Azure API Management.
  • Vous avez installé Microsoft PowerShell. Pour plus d'informations, consultez la documentation Microsoft PowerShell (en anglais).
  • Vous avez installé le module Azure PowerShell. Pour plus d'informations, consultez la documentation Microsoft Azure (en anglais).
  • Vous avez exporté votre définition d'API.
  • Vous avez importé une version précédente de la définition d'API sur Azure API Management.
  • Vous avez défini vos paramètres de contexte en tant que variable. Pour plus d'informations, consultez la procédure ci-dessus.

Procédure

  1. Ouvrez une invite de commande et entrez la commande suivante afin de charger le fichier : 
    Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "{format}" -SpecificationPath "{yourfile}" -ApiId "{api-id}" -Path "{api-url-suffix}"
  2. Ajoutez les paramètres adéquats :
    Paramètre Description
    {format} Format de la définition d'API à importer. La valeur peut être :
    • Swagger (recommandé)
    • Wadl
    • Wsdl
    • OpenApi
    {yourfile} Chemin et nom du fichier de la définition d'API exportée.
    {api-id} ID Azure API Management de l'API à mettre à jour.
    {api-url-suffix} Chemin d'accès à l'API Web à ajouter à la fin de l'URL publique de votre API.
  3. Exécutez la commande.

Résultats

Votre définition d'API est importée et le nouveau fichier remplace la version précédente. Vous pouvez vérifier votre mise à jour sur le portail Azure.

Dans cet exemple, une première version de la définition d'API nommée Contacts API contenant cinq opérations a été chargée. Elle a ensuite été remplacée par une nouvelle définition nommée Contacts API V2 contenant dix opérations.

Capture d'écran de la définition d'API mise à jour.

Pour plus d'informations concernant la commande Import-AzApiManagementApi, consultez la documentation Azure (en anglais).