Hantera API-versionsprofiler i Azure Stack

  • Artikel

API-profiler anger Azure-resursprovidern och API-versionen för Azure REST-slutpunkter. Du kan skapa anpassade klienter på olika språk med hjälp av API-profiler. Varje klient använder en API-profil för att kontakta rätt resursprovider och API-version för Azure Stack Hub.

Du kan skapa en app för att arbeta med Azure-resursproviders utan att behöva veta exakt vilken version av varje resursprovider-API som är kompatibel med Azure Stack Hub. Just align your app to a profile (Justera din app till en profil) så återgår SDK:n till rätt API-version.

Det här avsnittet hjälper dig att:

  • Förstå API-profiler för Azure Stack Hub.
  • Lär dig hur du kan använda API-profiler för att utveckla dina lösningar.
  • Se var du hittar kodspecifik vägledning.

Sammanfattning av API-profiler

  • API-profiler används för att representera en uppsättning Azure-resursproviders och deras API-versioner.
  • API-profiler har skapats så att du kan skapa mallar i flera Azure-moln. Profiler ger ett kompatibelt och stabilt gränssnitt.
  • Profiler släpps fyra gånger per år.
  • Tre namngivningskonventioner för profiler används:
    • senaste
      Innehåller de senaste API-versionerna som släppts i globala Azure.
    • åååå-mm-dd-hybrid
      Den här versionen släpps varannan år och fokuserar på konsekvens och stabilitet i flera moln. Den här profilen är avsedd för optimal Azure Stack Hub-kompatibilitet.
    • åååå-mm-dd-profil
      Balanserar optimal stabilitet och de senaste funktionerna.

Azure API-profiler och Azure Stack Hub-kompatibilitet

De senaste Azure API-profilerna är inte kompatibla med Azure Stack Hub. Använd följande namngivningskonventioner för att identifiera vilka profiler som ska användas för dina Azure Stack Hub-lösningar:

senaste
Den här profilen har de senaste API-versionerna som finns i globala Azure, som inte fungerar i Azure Stack Hub. senaste har det största antalet icke-bakåtkompatibla ändringar. Profilen åsidosätter stabilitet och kompatibilitet med andra moln. Om du försöker använda de senaste API-versionerna är den profil som du bör använda.

Åååå-mm-dd-hybrid
Profilen släpps i mars och september varje år. Den har optimal stabilitet och kompatibilitet med olika moln och är utformad för att rikta sig mot globala Azure och Azure Stack Hub. Azure API-versionerna som anges i den här profilen är desamma som de som anges i Azure Stack Hub. Använd den här profilen för att utveckla kod för hybridmolnlösningar.

åååå-mm-dd-profil
Den här profilen släpps för globala Azure i juni och december. Det fungerar inte med Azure Stack Hub och det sker vanligtvis många icke-bakåtkompatibla ändringar. Även om den balanserar optimal stabilitet och de senaste funktionerna är skillnaden mellan den senaste och den här profilen att den senaste alltid består av de senaste API-versionerna, oavsett när API:et släpps. Om till exempel en ny API-version skapas för compute-API:et i morgon visas den API-versionen i den senaste, men inte i profilen åååå-mm-dd-profile , eftersom den här profilen redan finns. yyyy-mm-dd-profile täcker de senaste versionerna som släpptes före juni eller före december.

Api-profiler för Azure Resource Manager

Azure Stack Hub använder inte den senaste versionen av API-versionerna som finns i globala Azure. När du skapar en lösning måste du hitta API-versionen för varje Azure-resursprovider som är kompatibel med Azure Stack Hub.

I stället för att undersöka varje resursprovider och den specifika version som stöds av Azure Stack Hub kan du använda en API-profil. Profilen anger en uppsättning resursproviders och API-versioner. SDK:t, eller ett verktyg som skapats med SDK:t, återgår till det mål api-version som anges i profilen. Med API-profiler kan du ange en profilversion som gäller för en hel mall. Vid körning väljer Azure Resource Manager rätt version av resursen.

API-profiler fungerar med verktyg som använder Azure Resource Manager, till exempel PowerShell, Azure CLI, kod som tillhandahålls i SDK och Microsoft Visual Studio. Verktyg och SDK:er kan använda profiler för att läsa vilken version av moduler och bibliotek som ska ingå när du skapar en app.

Om du till exempel använder PowerShell för att skapa ett lagringskonto med hjälp av resursprovidern Microsoft.Storage , som stöder api-version 2016-03-30 och en virtuell dator med hjälp av Microsoft.Compute-resursprovidern med api-version 2015-12-01, måste du leta upp vilken PowerShell-modul som stöder 2016-03-30 för Storage och vilken modul som stöder 2015-02-01 för beräkning och sedan installera dem. I stället kan du använda en profil. Använd cmdleten Install-Profile <profilename>och PowerShell läser in rätt version av modulerna.

På samma sätt kan du ange profilen när du använder Python SDK för att skapa en Python-baserad app. SDK läser in rätt moduler för de resursprovidrar som du har angett i skriptet.

Som utvecklare innebär det att du kan fokusera på att skriva din lösning. I stället för att undersöka vilka API-versioner, resursprovider och moln som fungerar tillsammans kan du använda en profil och veta att din kod fungerar i alla moln som stöder den profilen.

Kodexempel för API-profil

Du hittar kodexempel som hjälper dig att integrera din lösning med önskat språk med Azure Stack Hub med hjälp av profiler. För närvarande hittar du vägledning och exempel för följande språk:

  • .NET
    Använd .NET API-profilen för att få den senaste, mest stabila versionen av varje resurstyp i ett resursproviderpaket. Mer information finns i Använda API-versionsprofiler med .NET i Azure Stack Hub.
  • PowerShell
    Använd Az.Bootstrapper-modulen som är tillgänglig via PowerShell-galleriet för att hämta de PowerShell-cmdletar som krävs för att arbeta med API-versionsprofiler. Mer information finns i Använda API-versionsprofiler för PowerShell. Använd modulen AzureRM.Bootstrapper som är tillgänglig via PowerShell-galleriet för att hämta de PowerShell-cmdletar som krävs för att arbeta med API-versionsprofiler. Mer information finns i Använda API-versionsprofiler för PowerShell.
  • Azure CLI
    Uppdatera din miljökonfiguration för att använda den Azure Stack Hub-specifika API-versionsprofilen. Mer information finns i Använda API-versionsprofiler för Azure CLI.
  • Kör
    I Go SDK är en profil en kombination av olika resurstyper med olika versioner från olika tjänster. Profiler är tillgängliga under profilerna/sökvägen med deras version i formatet ÅÅÅÅ-MM-DD . Mer information finns i Använda API-versionsprofiler för Go.
  • Ruby
    Ruby SDK för Azure Stack Hub-Resource Manager innehåller verktyg som hjälper dig att skapa och hantera din infrastruktur. Resursprovidrar i SDK:et inkluderar beräkning, virtuella nätverk och lagring med Ruby-språket. Mer information finns i Använda API-versionsprofiler med Ruby.
  • Python
    Python SDK stöder API-versionsprofiler för att rikta in sig på olika molnplattformar, till exempel Azure Stack Hub och globala Azure. Använd API-profiler för att skapa lösningar för ett hybridmoln. Mer information finns i Använda API-versionsprofiler med Python.
  • Node.js
    Node.js SDK för Azure Stack Hub-Resource Manager innehåller verktyg som hjälper dig att skapa och hantera din infrastruktur. Mer information finns i Använda API-versionsprofiler med Node.js.

Nästa steg