Zarządzanie profilami wersji interfejsu API w usłudze Azure Stack Hub

  • Artykuł

Profile interfejsu API określają dostawcę zasobów platformy Azure i wersję interfejsu API dla punktów końcowych REST platformy Azure. Można tworzyć niestandardowych klientów w różnych językach przy użyciu profilów interfejsu API. Każdy klient używa profilu interfejsu API, aby skontaktować się z odpowiednim dostawcą zasobów i wersją interfejsu API dla usługi Azure Stack Hub.

Aplikację można utworzyć do pracy z dostawcami zasobów platformy Azure bez konieczności znajomości dokładnie, która wersja każdego interfejsu API dostawcy zasobów jest zgodna z usługą Azure Stack Hub. Wystarczy wyrównać aplikację do profilu, a zestaw SDK powróci do poprawnej wersji interfejsu API.

Ten temat zawiera informacje przydatne podczas takich działań, jak:

  • Omówienie profilów interfejsu API dla usługi Azure Stack Hub.
  • Dowiedz się, jak tworzyć rozwiązania przy użyciu profilów interfejsu API.
  • Zobacz, gdzie znaleźć wskazówki dotyczące kodu.

Podsumowanie profilów interfejsu API

  • Profile interfejsów API są używane do reprezentowania zestawu dostawców zasobów platformy Azure i ich wersji interfejsu API.
  • Profile interfejsów API zostały utworzone w celu utworzenia szablonów w wielu chmurach platformy Azure. Profile zapewniają zgodny i stabilny interfejs.
  • Profile są wydawane cztery razy w roku.
  • Używane są trzy konwencje nazewnictwa profilów:
    • Najnowsza
      Zawiera najnowsze wersje interfejsu API wydane w globalnej platformie Azure.
    • rrrr-mm-dd-hybrid
      Wydanie dwurocznie koncentruje się na spójności i stabilności w wielu chmurach. Ten profil jest przeznaczony dla optymalnej zgodności z usługą Azure Stack Hub.
    • rrrr-mm-dd-profile
      Równoważy optymalną stabilność i najnowsze funkcje.

Profile interfejsu API platformy Azure i zgodność usługi Azure Stack Hub

Najnowsze profile interfejsu API platformy Azure nie są zgodne z usługą Azure Stack Hub. Użyj następujących konwencji nazewnictwa, aby zidentyfikować profile, które mają być używane dla rozwiązań usługi Azure Stack Hub:

Najnowsza
Ten profil ma najbardziej aktualne wersje interfejsu API znalezione na globalnej platformie Azure, które nie działają w usłudze Azure Stack Hub. najnowsza ma największą liczbę zmian powodujących niezgodność. Profil odkłada na bok stabilność i zgodność z innymi chmurami. Jeśli próbujesz użyć najbardziej aktualnych wersji interfejsu API, najnowszą wersją jest profil, którego należy użyć.

RRRR-mm-dd-hybrid
Ten profil jest udostępniany w marcu i wrześniu każdego roku. Ma optymalną stabilność i zgodność z różnymi chmurami i została zaprojektowana tak, aby była przeznaczona dla globalnej platformy Azure i usługi Azure Stack Hub. Wersje interfejsu API platformy Azure wymienione w tym profilu będą takie same jak te wymienione w usłudze Azure Stack Hub. Ten profil służy do tworzenia kodu dla rozwiązań w chmurze hybrydowej.

rrrr-mm-dd-profile
Ten profil jest udostępniany dla globalnej platformy Azure w czerwcu i grudniu. Nie działa w usłudze Azure Stack Hub i zwykle będzie wiele zmian powodujących niezgodność. Chociaż równoważy optymalną stabilność i najnowsze funkcje, różnica między najnowszymi i najnowszymi profilami polega na tym, że najnowsza wersja interfejsu API zawsze składa się z najnowszych wersji interfejsu API, niezależnie od tego, kiedy interfejs API zostanie wydany. Jeśli na przykład nowa wersja interfejsu API zostanie utworzona dla interfejsu API obliczeniowego jutro, ta wersja interfejsu API zostanie wyświetlona w najnowszej wersji, ale nie w profilu profilu rrrr-mm-dd-profile , ponieważ ten profil już istnieje. rrrr-mm-dd-profile obejmuje najbardziej aktualne wersje wydane przed czerwcem lub przed grudniem.

Profile interfejsu API usługi Azure Resource Manager

Usługa Azure Stack Hub nie używa najnowszej wersji interfejsu API znalezionych na globalnej platformie Azure. Podczas tworzenia rozwiązania należy znaleźć wersję interfejsu API dla każdego dostawcy zasobów platformy Azure zgodnego z usługą Azure Stack Hub.

Zamiast badać każdego dostawcę zasobów i określoną wersję obsługiwaną przez usługę Azure Stack Hub, możesz użyć profilu interfejsu API. Profil określa zestaw dostawców zasobów i wersji interfejsu API. Zestaw SDK lub narzędzie utworzone za pomocą zestawu SDK powróci do obiektu docelowego api-version określonego w profilu. W przypadku profilów interfejsu API można określić wersję profilu, która ma zastosowanie do całego szablonu. W czasie wykonywania usługa Azure Resource Manager wybiera odpowiednią wersję zasobu.

Profile interfejsu API współpracują z narzędziami korzystającymi z usługi Azure Resource Manager, takich jak program PowerShell, interfejs wiersza polecenia platformy Azure, kod podany w zestawie SDK i program Microsoft Visual Studio. Narzędzia i zestawy SDK mogą używać profilów do odczytywania wersji modułów i bibliotek do uwzględnienia podczas kompilowania aplikacji.

Jeśli na przykład używasz programu PowerShell do tworzenia konta magazynu przy użyciu dostawcy zasobów Microsoft.Storage , który obsługuje interfejs API-version 2016-03-30 i maszynę wirtualną przy użyciu dostawcy zasobów Microsoft.Compute z interfejsem API w wersji 2015-12-01, należy wyszukać moduł programu PowerShell obsługujący 2016-03-30 dla magazynu, a następnie zainstalować go moduł 2015-02-01. Zamiast tego można użyć profilu. Użyj polecenia cmdlet Install-Profile <profilename>, a program PowerShell ładuje poprawną wersję modułów.

Podobnie w przypadku używania zestawu SDK języka Python do tworzenia aplikacji opartej na języku Python można określić profil. Zestaw SDK ładuje odpowiednie moduły dla dostawców zasobów określonych w skrycie.

Jako deweloper oznacza to, że możesz skupić się na pisaniu rozwiązania. Zamiast badać, które wersje interfejsu API, dostawca zasobów i chmura współpracują ze sobą, możesz użyć profilu i wiedzieć, że kod działa we wszystkich chmurach, które obsługują ten profil.

Przykłady kodu profilu interfejsu API

Przykłady kodu ułatwiające integrację rozwiązania z preferowanym językiem z usługą Azure Stack Hub można znaleźć przy użyciu profilów. Obecnie można znaleźć wskazówki i przykłady dla następujących języków:

Następne kroki