Udostępnij za pośrednictwem

Omówienie szablonów interfejsu wiersza polecenia dla deweloperów platformy Azure

  • Artykuł

Szablony interfejsu wiersza polecenia dla deweloperów platformy Azure (azd) to standardowe repozytoria kodu zawierające przykładowy kod aplikacji, a także azd pliki konfiguracji i infrastruktury. azd szablony umożliwiają aprowizację zasobów platformy Azure, wdrażanie aplikacji, konfigurowanie potoków ciągłej integracji/ciągłego wdrażania i nie tylko. Możesz utworzyć własne szablony lub rozpocząć korzystanie z istniejącego szablonu z repozytorium szablonu, takiego jak Awesome AZD. W tym artykule poznasz następujące pojęcia:

  • Jak azd szablony umożliwiają aprowizację i wdrażanie zasobów aplikacji
  • Jak azd szablony są ustrukturyzowane
  • Jak zdecydować, czy używać istniejącego szablonu, czy utworzyć go
  • Eksplorowanie istniejących azd szablonów startowych

Dlaczego warto używać szablonów interfejsu wiersza polecenia dla deweloperów platformy Azure?

Deweloperzy często napotykają wiele czasochłonnych i trudnych zadań podczas tworzenia prawidłowo zaprojektowanych i skonfigurowanych aplikacji środowiskowych dla chmury. Zespoły muszą uwzględniać wiele różnych zagadnień w tych środowiskach, takich jak tworzenie zasobów, stosowanie konfiguracji, konfigurowanie monitorowania i rejestrowania, tworzenie potoków ciągłej integracji/ciągłego wdrażania i inne zadania. azd szablony zmniejszają i usprawniają te obowiązki, aby pomóc deweloperowi w podróży od lokalnego programowania do pomyślnie wdrożonej aplikacji na platformie Azure.

Załóżmy na przykład, że pracujesz w firmie, która obsługuje platformę zarządzania biletami i komunikacji klienta, która wymaga następujących zasobów platformy Azure:

  • Dwa wystąpienia usługi App Service i plan usługi App Service do hostowania aplikacji internetowej frontonu i interfejsu API zaplecza
  • Wystąpienie usługi Key Vault do przechowywania bezpiecznych wpisów tajnych aplikacji
  • Baza danych Cosmos DB do trwałego przechowywania danych aplikacji
  • Zasoby usługi Azure Monitor, takie jak pulpity nawigacyjne usługi Application Insights
  • Usługa Service Bus do zarządzania skalowalnymi komunikatami
  • Potoki ciągłej integracji/ciągłego wdrażania w celu zapewnienia niezawodnego wdrażania zmian za pośrednictwem zautomatyzowanego, powtarzalnego procesu.

Zamiast rozpoczynać od podstaw, możesz skorzystać z azd istniejących szablonów architektury, aby aprowizować i wdrażać większość zasobów. Następnie zespół programistyczny może skupić się na tworzeniu aplikacji i tworzeniu mniejszych korekt architektury szablonu.

Jak działają szablony interfejsu wiersza polecenia dla deweloperów platformy Azure

Szablony interfejsu wiersza polecenia dla deweloperów platformy Azure są przeznaczone do pracy z poleceniami azd takimi jak azd init i azd up. Szablony obejmują pliki konfiguracji i infrastruktury jako kodu (IaC), które są używane przez polecenia do wykonywania zadań, takich jak aprowizowanie zasobów platformy Azure i wdrażanie do nich kodu aplikacji.

Na przykład typowy azd przepływ pracy korzystający z istniejącego szablonu obejmuje następujące kroki:

  1. Uruchom polecenie z parametrem , azd init --template aby sklonować istniejący szablon z usługi GitHub.

    azd init --template todo-nodejs-mongo

  2. Uruchom polecenie , azd auth login aby uwierzytelnić się w ramach subskrypcji platformy Azure.

    azd auth login

  3. Uruchom polecenie , azd up aby aprowizować i wdrażać zasoby szablonu na platformie Azure. Polecenie azd up wykorzystuje pliki konfiguracji i infrastruktury jako kodu (IaC) w szablonie w celu aprowizowania zasobów platformy Azure i wdrażania aplikacji w tych zasobach.

    azd up

  4. Po skonfigurowaniu środowiska na platformie Azure możesz lokalnie zmodyfikować funkcje aplikacji lub szablony zasobów platformy Azure, a następnie uruchomić azd up ponownie, aby aprowizować zmiany.

Omówienie struktury szablonu interfejsu wiersza polecenia dla deweloperów platformy Azure

Wszystkie azd szablony współdzielą podobną strukturę plików na azd podstawie konwencji. Minimalne wymagane zasoby zwykle obejmują następujące elementy:

  • infra folder — zawiera całą infrastrukturę Bicep lub Terraform jako pliki kodu dla szablonu azd . azd Wykonuje te pliki w celu utworzenia zasobów platformy Azure wymaganych do hostowania aplikacji.

  • azure.yaml file — plik konfiguracji, który definiuje co najmniej jedną usługę w projekcie i mapuje je na zasoby platformy Azure zdefiniowane w folderze infra na potrzeby wdrożenia. Możesz na przykład zdefiniować usługę interfejsu API i usługę frontonu internetowego i zamapować je na różne zasoby platformy Azure na potrzeby wdrożenia.

  • .azure folder — zawiera podstawowe konfiguracje platformy Azure i zmienne środowiskowe, takie jak lokalizacja wdrażania zasobów lub innych informacji o subskrypcji.

  • src folder — zawiera cały kod źródłowy aplikacji, który można wdrożyć. Niektóre azd szablony wykluczają src folder i udostępniają tylko zasoby infrastruktury, dzięki czemu można dodać własny kod aplikacji.

    Uwaga

    Szablony wykluczające src folder są zwykle projektowane jako szablony początkowe infrastruktury.

azd szablony obejmują również co najmniej jeden z następujących folderów:

  • .github folder — przechowuje pliki przepływu pracy ciągłej integracji/ciągłego wdrażania dla funkcji GitHub Actions, domyślnego dostawcy ciągłej integracji/ciągłego wdrażania dla usługi azd.
  • .azdo folder — jeśli zdecydujesz się użyć usługi Azure Pipelines na potrzeby ciągłej integracji/ciągłego wdrażania, zdefiniuj pliki konfiguracji przepływu pracy w tym folderze.
  • .devcontainer folder — umożliwia skonfigurowanie środowiska deweloperskiego kontenera dla aplikacji.

Na przykład wspólny azd szablon może być zgodny z następującą strukturą folderów:

Zrzut ekranu przedstawiający strukturę szablonu interfejsu wiersza polecenia dla deweloperów platformy Azure.

Zacznij od istniejącego szablonu lub utwórz własny

Istnieją dwa główne podejścia do pracy z szablonami azd :

  • Zacznij od istniejącego azd szablonu.
    • Jest to dobry wybór, jeśli dopiero zaczynasz pracę azd lub szukasz szablonu do skompilowania nowej aplikacji z podobną architekturą i strukturami.
  • Przekonwertuj istniejący projekt na azd szablon.
    • Jest to dobry wybór, gdy masz już istniejącą aplikację, ale chcesz, aby była zgodna z możliwościami azd .

Poniższe sekcje zawierają więcej informacji na temat tych dwóch opcji.

Rozpocznij od istniejącego szablonu

Szeroki wybór szablonów jest dostępny w galerii szablonów azd awesome-azd. Te szablony udostępniają infrastrukturę i kod aplikacji dla różnych scenariuszy programowania, struktur językowych i usług platformy Azure. Jeśli znajdziesz szablon zgodny z lokalnym stosem aplikacji lub żądaną architekturą, możesz rozszerzyć i zastąpić kod szablonu własnymi

Na przykład następujące azd szablony udostępniają punkty początkowe dla typowych architektur i struktur aplikacji:

Template Host aplikacji Stos techniczny
React Web App with C# API and MongoDB on Azure Azure App Service Azure Cosmos DB for NoSQL, Bicep
React Web App with C# API and SQL Database on Azure Azure App Service Azure SQL Database, Bicep
Statyczna aplikacja internetowa React i funkcje z interfejsem API języka C# i usługą SQL Database na platformie Azure Azure Static Web Apps, Azure Functions Azure SQL Database, Bicep

Tworzenie nowego azd szablonu dla aplikacji

Możesz również przekonwertować istniejącą aplikację na azd szablon, aby ulepszyć repozytorium dzięki możliwościom aprowizacji i wdrażania. Takie podejście pozwala na największą kontrolę i tworzy rozwiązanie wielokrotnego użytku na potrzeby przyszłych prac programistycznych w aplikacji. Ogólne kroki tworzenia własnego szablonu są następujące:

  • Zainicjuj szablon projektu za pomocą azd initpolecenia .
  • Utwórz infrastrukturę Bicep lub Terraform jako pliki kodu w folderze infra .
  • Zaktualizuj plik, azure.yaml aby powiązać usługi app services wraz z zasobami platformy Azure.
  • Aprowizuj i wdróż za pomocą polecenia azd up.

Następujące zasoby zawierają więcej informacji na temat tworzenia własnych szablonów:

Wskazówki dotyczące używania azd szablonów

Należy pamiętać, że każdy szablon używany z interfejsem wiersza polecenia dla deweloperów platformy Azure jest licencjonowany przez odpowiedniego właściciela (co może lub nie być firmą Microsoft) zgodnie z umową, która towarzyszy szablonowi. Twoim zadaniem jest określenie, jaka licencja ma zastosowanie do dowolnego szablonu, którego chcesz użyć.

Firma Microsoft nie ponosi odpowiedzialności za żadne szablony inne niż Microsoft i nie wyświetla tych szablonów pod kątem problemów z zabezpieczeniami, prywatnością, zgodnością ani wydajnością. Szablony używane z interfejsem wiersza polecenia dla deweloperów platformy Azure, w tym dostarczone przez firmę Microsoft, nie są obsługiwane przez żaden program pomocy technicznej lub usługę firmy Microsoft. Wszystkie szablony dostarczane przez firmę Microsoft są dostarczane w sposób as is bez gwarancji jakiegokolwiek rodzaju.

Następne kroki

Wybieranie i wdrażanie szablonu