Gérer les profils de version d’API dans Azure Stack Hub

  • Article

Les profils d’API précisent le fournisseur de ressources Azure ainsi que la version d’API des points de terminaison Azure REST. Vous pouvez créer des clients personnalisés dans différents langages à l’aide des profils d’API. Chaque client utilise un profil d’API pour contacter le fournisseur de ressources et la version d’API appropriés pour Azure Stack Hub.

Vous pouvez créer une application qui fonctionne avec les fournisseurs de ressources Azure sans avoir à savoir exactement quelle version des API de fournisseur de ressources est compatible avec Azure Stack Hub. Il vous suffit d’aligner votre application sur un profil. Le Kit de développement logiciel (SDK) rétablit la version d’API appropriée.

Cette rubrique vous aide à :

  • Comprendre les profils d’API pour Azure Stack Hub.
  • comprendre l’utilisation des profils d’API pour développer vos solutions,
  • obtenir des conseils spécifiques au code.

Résumé des profils d’API

  • Les profils d’API représentent un ensemble de fournisseurs de ressources Azure et leurs versions d’API.
  • Les profils d’API ont été créés pour que vous puissiez générer des modèles utilisables sur plusieurs clouds Azure. Les profils fournissent une interface compatible et stable.
  • La mise en production des profils intervient quatre fois par an.
  • Trois conventions d’affectation de noms de profil sont utilisées :
    • le plus récent
      Contient les versions d’API les plus récentes publiées dans Azure global.
    • yyyy-mm-dd-hybrid
      Publiée deux fois par an, cette version se concentre sur la cohérence et la stabilité de plusieurs clouds. Ce profil vise à assurer une compatibilité optimale avec Azure Stack Hub.
    • yyyy-mm-dd-profile
      Équilibre une stabilité optimale et les fonctionnalités les plus récentes.

Profils d’API Azure et compatibilité avec Azure Stack Hub

Les profils d’API Azure les plus récents ne sont pas compatibles avec Azure Stack Hub. Utilisez les conventions d’affectation de noms suivantes pour identifier les profils à utiliser pour vos solutions Azure Stack Hub :

le plus récent
Ce profil inclut les versions d’API les plus à jour proposées dans Azure international. Ces versions ne sont pas compatibles avec Azure Stack Hub. Le profil Le plus récent présente le plus grand nombre de changements importants. Ce profil ne vise pas la stabilité et la compatibilité avec les autres clouds. Si vous essayez d’utiliser les versions d’API les plus à jour, Le plus récent est le profil que vous devez utiliser.

Yyyy-mm-dd-hybrid
Ce profil est publié deux fois par an, en mars et en septembre. Il garantit une stabilité et une compatibilité optimales de divers clouds. De plus, il est conçu pour cibler Azure international et Azure Stack Hub. Les versions d’API Azure répertoriées dans ce profil sont les mêmes que celles disponibles dans Azure Stack Hub. Utilisez ce profil pour développer du code pour des solutions cloud hybrides.

yyyy-mm-dd-profile
Ce profil pour Azure global est publié deux fois par an, en juin et en décembre. Il ne fonctionne pas avec Azure Stack Hub et présente généralement de nombreux changements cassants. Même s’il offre un équilibre entre une stabilité optimale et les fonctionnalités les plus récentes, La différence entre le profil Le plus récent et ce profil, est que le profil Le plus récent propose toujours les toutes dernières versions des API, quelle que soit la date de publication des API. Par exemple, si une nouvelle version de l’API Compute est créée demain, cette version est aussitôt proposée dans le profil Le plus récent, mais pas dans le profil yyyy-mm-dd-profile, car ce profil existe déjà. Le profil yyyy-mm-dd-profile fournit les dernières versions mises à jour ayant été publiées avant juin ou avant décembre.

Profils d’API Azure Resource Manager

Azure Stack Hub n’utilise pas les versions d’API les plus récentes disponibles dans Azure international. Quand vous créez une solution, vous devez rechercher la version d’API pour chaque fournisseur de ressources Azure qui est compatible avec Azure Stack Hub.

Plutôt que d’effectuer des recherches sur chaque fournisseur de ressources et sur chacune des versions spécifiques prises en charge par Azure Stack Hub, vous pouvez utiliser un profil d’API. Le profil spécifie un ensemble de fournisseurs de ressources et de versions d’API. Le SDK, ou un outil intégré au SDK, vous oriente vers le paramètre api-version cible indiquée dans le profil. Avec les profils d’API, vous pouvez spécifier une version de profil qui s’applique à un modèle entier. Au moment de l’exécution, Azure Resource Manager sélectionne la version appropriée de la ressource.

Les profils d’API fonctionnent avec des outils qui utilisent Azure Resource Manager, par exemple PowerShell, Azure CLI, le code fourni dans le SDK et Microsoft Visual Studio. Les outils et les Kits de développement logiciel (SDK) peuvent utiliser des profils pour lire la version des modules et des bibliothèques à inclure lors de la génération d’une application.

Par exemple, si vous utilisez PowerShell pour créer un compte de stockage à l’aide du fournisseur de ressources Microsoft.Storage, qui prend en charge le paramètre api-version 2016-03-30, et une machine virtuelle utilisant le fournisseur de ressources Microsoft.Compute avec le paramètre api-version 2015-12-01, vous devez rechercher quel module PowerShell prend en charge 2016-03-30 pour Storage et quel module prend en charge 2015-02-01 pour Compute, puis les installer. Pour vous éviter de procéder ainsi, vous pouvez utiliser un profil. Utilisez l’applet de commande Install-Profile <profilename> pour permettre à PowerShell de charger la version appropriée des modules.

De même, lorsque vous utilisez le Kit de développement logiciel (SDK) Python pour générer une application basée sur Python, vous pouvez spécifier le profil. Le Kit de développement logiciel (SDK) charge les modules appropriés aux fournisseurs de ressources spécifiés dans votre script.

En tant que développeur, cela signifie que vous pouvez ainsi vous concentrer sur l’écriture de votre solution. Au lieu de rechercher les versions d’API, le fournisseur de ressources et le cloud qui fonctionnent ensemble, vous pouvez utiliser un profil pour avoir l’assurance que votre code fonctionne dans tous les clouds qui prennent en charge ce profil.

Exemples de code de profil d’API

Il existe des exemples de code pour vous aider à intégrer votre solution et votre langage par défaut à Azure Stack Hub à l’aide des profils. Actuellement, vous pouvez trouver des conseils et des exemples pour les langages suivants :

  • .NET
    Utilisez le profil d’API .NET pour obtenir la version la plus récente et la plus stable de chaque type de ressource dans un package de fournisseurs de ressources. Pour plus d’informations, consultez l’article Utiliser des profils de version d’API avec .NET dans Azure Stack Hub.
  • PowerShell
    Utilisez le module Az.Bootstrapper, disponible via PowerShell Gallery pour obtenir les cmdlets PowerShell nécessaires pour utiliser des profils de version d’API. Pour plus d’informations, consultez Utiliser des profils de version d’API pour PowerShell. Utilisez le module AzureRM.Bootstrapper, disponible via PowerShell Gallery pour obtenir les cmdlets PowerShell nécessaires pour utiliser des profils de version d’API. Pour plus d’informations, consultez Utiliser des profils de version d’API pour PowerShell.
  • Azure CLI
    Mettez à jour la configuration de votre environnement pour utiliser le profil de version des API propre à Azure Stack Hub. Pour plus d’informations, consultez Utiliser les profils de version d’API pour Azure CLI.
  • Go
    Dans le SDK Go, un profil est une combinaison de différents types de ressources dans différentes versions de différents services. Les profils sont disponibles sous les profils/chemin d’accès avec leur version au format AAAA-MM-JJ. Pour plus d’informations, consultez Utiliser des profils de version d’API pour Go.
  • Python
    Le SDK Python prend en charge les profils de version d’API pour cibler différentes plateformes cloud comme Azure Stack Hub et Azure international. Utilisez des profils d’API pour créer des solutions pour un cloud hybride. Pour plus d’informations, consultez Utiliser des profils de version d’API avec Python.
  • Node.JS
    Le SDK Node.js pour Azure Stack Hub Resource Manager fournit des outils pour vous aider à créer et à gérer votre infrastructure. Pour plus d’informations, consultez l’article Utiliser des profils de version d’API avec Node.js.

Étapes suivantes