Správa profilů verzí rozhraní API ve službě Azure Stack Hub

  • Článek

Profily rozhraní API určují poskytovatele prostředků Azure a verzi rozhraní API pro koncové body Azure REST. Pomocí profilů rozhraní API můžete vytvářet vlastní klienty v různých jazycích. Každý klient používá profil rozhraní API ke kontaktování správného poskytovatele prostředků a verze rozhraní API pro službu Azure Stack Hub.

Můžete vytvořit aplikaci pro spolupráci s poskytovateli prostředků Azure, aniž byste museli přesně vědět, která verze rozhraní API jednotlivých poskytovatelů prostředků je kompatibilní se službou Azure Stack Hub. Stačí zarovnat aplikaci k profilu a sada SDK se vrátí ke správné verzi rozhraní API.

Toto téma vám pomůže s těmito aktivitami:

  • Seznamte se s profily rozhraní API pro službu Azure Stack Hub.
  • Zjistěte, jak můžete pomocí profilů rozhraní API vyvíjet řešení.
  • Podívejte se, kde najdete pokyny pro konkrétní kód.

Souhrn profilů rozhraní API

  • Profily rozhraní API se používají k reprezentaci sady poskytovatelů prostředků Azure a jejich verzí rozhraní API.
  • Profily rozhraní API byly vytvořeny, abyste mohli vytvářet šablony napříč několika cloudy Azure. Profily poskytují kompatibilní a stabilní rozhraní.
  • Profily se vydávají čtyřikrát ročně.
  • Používají se tři zásady vytváření názvů profilů:
    • Nejnovější
      Obsahuje nejnovější verze rozhraní API vydané v globálním Azure.
    • yyyy-mm-dd-hybrid
      Tato verze vydaná dvakrát ročně se zaměřuje na konzistenci a stabilitu napříč několika cloudy. Tento profil cílí na optimální kompatibilitu se službou Azure Stack Hub.
    • yyyy-mm-dd-profile
      Vyrovnává optimální stabilitu a nejnovější funkce.

Profily rozhraní Azure API a kompatibilita se službou Azure Stack Hub

Nejnovější profily rozhraní Azure API nejsou kompatibilní se službou Azure Stack Hub. K určení profilů, které se mají použít pro vaše řešení Azure Stack Hub, použijte následující zásady vytváření názvů:

Nejnovější
Tento profil má nejaktuálnější verze rozhraní API v globálním Azure, které ve službě Azure Stack Hub nefungují. nejnovější obsahuje největší počet změn způsobujících chybu. Profil dává stranou stabilitu a kompatibilitu s jinými cloudy. Pokud se pokoušíte použít nejnovější verze rozhraní API, nejnovější je profil, který byste měli použít.

Yyyy-mm-dd-hybrid
Tento profil se vydává každý rok v březnu a září. Má optimální stabilitu a kompatibilitu s různými cloudy a je navržená tak, aby cílila na globální Azure a Azure Stack Hub. Verze rozhraní Azure API uvedené v tomto profilu budou stejné jako verze uvedené ve službě Azure Stack Hub. Tento profil použijte k vývoji kódu pro hybridní cloudová řešení.

yyyy-mm-dd-profile
Tento profil se pro globální Azure vydá v červnu a prosinci. Se službou Azure Stack Hub nefunguje a obvykle dojde k mnoha zásadním změnám. I když vyrovnává optimální stabilitu a nejnovější funkce, rozdíl mezi nejnovějším a tímto profilem spočívá v tom, že nejnovější verze vždy obsahují nejnovější verze rozhraní API, bez ohledu na to, kdy je rozhraní API vydáno. Pokud se například zítra vytvoří nová verze rozhraní API pro rozhraní API služby Compute, bude tato verze rozhraní API uvedená v nejnovější verzi, ale ne v profilu yyyy-mm-dd-profile , protože tento profil už existuje. yyyy-mm-dd-profile pokrývá nejaktuálnější verze vydané před červnem nebo před prosincem.

Profily rozhraní API služby Azure Resource Manager

Azure Stack Hub nepoužívá nejnovější verzi verzí rozhraní API, která se nachází v globálním Azure. Při vytváření řešení musíte najít verzi rozhraní API pro každého poskytovatele prostředků Azure, který je kompatibilní se službou Azure Stack Hub.

Místo zkoumání jednotlivých poskytovatelů prostředků a konkrétní verze podporované službou Azure Stack Hub můžete použít profil rozhraní API. Profil určuje sadu poskytovatelů prostředků a verzí rozhraní API. Sada SDK nebo nástroj sestavený pomocí sady SDK se vrátí k cíli api-version zadanému v profilu. Pomocí profilů rozhraní API můžete zadat verzi profilu, která se vztahuje na celou šablonu. Za běhu Resource Manager Azure vybere správnou verzi prostředku.

Profily rozhraní API fungují s nástroji, které používají Azure Resource Manager, jako je PowerShell, Azure CLI, kód poskytovaný v sadě SDK a Microsoft Visual Studio. Nástroje a sady SDK můžou pomocí profilů zjistit, které verze modulů a knihoven se mají zahrnout do vytváření aplikace.

Pokud například pomocí PowerShellu vytvoříte účet úložiště pomocí poskytovatele prostředků Microsoft.Storage , který podporuje api-version 2016-03-30 a virtuální počítač využívající poskytovatele prostředků Microsoft.Compute s api-version 2015-12-01, musíte vyhledat modul PowerShellu, který podporuje 2016-03-30 pro storage a který modul podporuje 2015-02-01 pro výpočty, a pak je nainstalovat. Místo toho můžete použít profil. Použijte rutinu Install-Profile <profilename>a PowerShell načte správnou verzi modulů.

Podobně při použití sady Python SDK k sestavení aplikace založené na Pythonu můžete zadat profil. Sada SDK načte správné moduly pro poskytovatele prostředků, které jste zadali ve skriptu.

Jako vývojář to znamená, že se můžete soustředit na psaní řešení. Místo zkoumání verzí rozhraní API, poskytovatele prostředků a cloudu můžete použít profil a zjistit, že váš kód funguje ve všech cloudech, které tento profil podporují.

Ukázky kódu profilu rozhraní API

Pomocí profilů můžete najít ukázky kódu, které vám pomůžou integrovat vaše řešení s upřednostňovaným jazykem se službou Azure Stack Hub. V současné době najdete pokyny a ukázky pro následující jazyky:

  • .NET
    Profil rozhraní .NET API použijte k získání nejnovější a nejstabilnější verze každého typu prostředku v balíčku poskytovatele prostředků. Další informace najdete v tématu Použití profilů verzí rozhraní API s .NET ve službě Azure Stack Hub.
  • PowerShell
    Pomocí modulu Az.Bootstrapper dostupného prostřednictvím Galerie prostředí PowerShell získejte rutiny PowerShellu potřebné pro práci s profily verzí rozhraní API. Informace najdete v tématu Použití profilů verzí rozhraní API pro PowerShell. Pomocí modulu AzureRM.Bootstrapper dostupného prostřednictvím Galerie prostředí PowerShell získejte rutiny PowerShellu potřebné pro práci s profily verzí rozhraní API. Informace najdete v tématu Použití profilů verzí rozhraní API pro PowerShell.
  • Azure CLI
    Aktualizujte konfiguraci prostředí tak, aby používalo profil verze rozhraní API specifické pro službu Azure Stack Hub. Informace najdete v tématu Použití profilů verzí rozhraní API pro Azure CLI.
  • Přejít
    V sadě Go SDK je profil kombinací různých typů prostředků s různými verzemi z různých služeb. Profily jsou k dispozici pod profilem nebo cestou s jejich verzí ve formátu RRRR-MM-DD . Informace najdete v tématu Použití profilů verzí rozhraní API pro Go.
  • Ruby
    Sada Ruby SDK pro službu Azure Stack Hub Resource Manager poskytuje nástroje, které vám pomůžou sestavovat a spravovat infrastrukturu. Poskytovatelé prostředků v sadě SDK zahrnují výpočetní prostředky, virtuální sítě a úložiště v jazyce Ruby. Informace najdete v tématu Použití profilů verzí rozhraní API s Ruby.
  • Python
    Python SDK podporuje profily verzí rozhraní API pro cílení na různé cloudové platformy, jako je Azure Stack Hub a globální Azure. Profily rozhraní API můžete použít k vytvoření řešení pro hybridní cloud. Informace najdete v tématu Použití profilů verzí rozhraní API s Pythonem.
  • Node.js
    Sada Node.js SDK pro službu Azure Stack Hub Resource Manager poskytuje nástroje, které vám pomůžou sestavovat a spravovat infrastrukturu. Další informace najdete v tématu Použití profilů verzí rozhraní API s Node.js.

Další kroky