Pisanie szablonów ARM

Szablony ARM umożliwiają definiowanie infrastruktury Azure jako kodu w formacie JSON. Pozwala to na powtarzalne, spójne wdrożenia, które można przechowywać w systemie kontroli wersji razem z kodem aplikacji. Szablony są idempotentne — wielokrotne uruchomienie tego samego szablonu daje ten sam rezultat, dzięki czemu można je bezpiecznie stosować ponownie po wprowadzeniu zmian.

Każdy szablon ARM zaczyna się od właściwości $schema wskazującej adres URL schematu szablonu, po której następuje ciąg contentVersion. Schemat informuje portal Azure i rozszerzenia edytora, jak weryfikować szablon i zapewniać funkcję IntelliSense. Kolejne pięć głównych sekcji to parameters, variables, functions, resources i outputs.

Parametry sprawiają, że szablony można wielokrotnie wykorzystywać, ponieważ przyjmują dane wejściowe w czasie wdrażania. Każdy parametr ma właściwość type (string, int, bool, object, array, secureString), opcjonalną wartość defaultValue oraz opcjonalną właściwość allowedValues służącą do walidacji. Użycie secureString w przypadku haseł gwarantuje, że wartość nigdy nie zostanie zapisana w historii wdrożeń.

Zmienne przechowują wartości obliczane na podstawie parametrów lub funkcji szablonu, ograniczając powtórzenia i ułatwiając konserwację szablonów. Zmienne są obliczane raz i używane w całej sekcji resources za pomocą wyrażenia [variables('name')]. Typowym wzorcem jest budowanie nazwy zasobu przez połączenie parametru z unikatowym sufiksem.

Tablica resources jest najważniejszą częścią szablonu ARM. Każdy element opisuje jeden zasób Azure i zawiera wymagane pola: type, apiVersion, name oraz location. Właściwość apiVersion przypisuje zasobowi konkretną wersję schematu dostawcy — zawsze należy używać najnowszej stabilnej wersji, aby uzyskać dostęp do najnowszych funkcji i uniknąć wycofanych właściwości.

Wyrażenia szablonów ARM są umieszczane w nawiasach kwadratowych [...] i obsługują wbudowane funkcje dla ciągów, tablic, obiektów oraz identyfikatorów zasobów. Do często używanych funkcji należą concat(), resourceGroup(), resourceId(), uniqueString() i parameters(). Funkcje te są obliczane po stronie serwera przez ARM w czasie wdrażania, a nie lokalnie.

Sekcja outputs definiuje wartości zwracane przez ARM po pomyślnym wdrożeniu. Outputs są niezbędne do łączenia szablonów — można wdrożyć szablon sieci i zwrócić identyfikator zasobu podsieci, a następnie przekazać go jako parametr do szablonu maszyny wirtualnej. Outputs mogą odwoływać się do dowolnego wyrażenia, w tym do właściwości zasobów z wdrożenia.

W przypadku złożonych architektur ARM obsługuje szablony połączone (odwołujące się do zewnętrznych adresów URL szablonów) oraz szablony zagnieżdżone (osadzające szablon w tablicy resources za pomocą typu Microsoft.Resources/deployments). Umożliwia to podzielenie dużego wdrożenia infrastruktury na modułowe, wielokrotnego użytku elementy, przy zachowaniu jednego szablonu orkiestracji jako punktu wejścia.

Zamiast przekazywać parametry w wierszu polecenia, można przechowywać je w osobnym pliku parametrów — pliku JSON z obiektem parameters zawierającym pary nazwa-wartość. Pliki parametrów mogą być specyficzne dla danego środowiska (np. dev.parameters.json, prod.parameters.json) i zatwierdzane w systemie kontroli wersji, podczas gdy poufne wartości są przechowywane jako odwołania do Azure Key Vault, a nie w postaci zwykłego tekstu.

Użyj polecenia Azure CLI az deployment group create, aby wdrożyć szablon do grupy zasobów. Przed wdrożeniem na produkcji uruchom az deployment group validate, aby wykryć błędy schematu i logiki, oraz az deployment group what-if, aby wyświetlić podgląd zmian zasobów. Te trzy polecenia tworzą bezpieczny potok wdrażania: weryfikacja, podgląd, wdrożenie.

Przestrzegaj następujących najlepszych praktyk dotyczących szablonów ARM: używaj parametrów dla wartości zależnych od środowiska, używaj zmiennych, aby unikać powtórzeń, przypisuj wersje interfejsu API do stabilnych wersji, używaj secureString dla haseł, dodawaj opisy metadanych do parametrów oraz dziel duże szablony na połączone moduły. Przechowuj szablony w repozytorium Git i wdrażaj je za pośrednictwem potoku CI/CD, aby zapewnić możliwość audytu.

Sprawdź swoją wiedzę na temat zagadnień Microsoft Azure Fundamentals (AZ-900) omówionych w tej lekcji.

W tej lekcji nauczył(a) się Pan/Pani, że szablony ARM to dokumenty JSON, które deklaratywnie definiują infrastrukturę Azure, parametry i zmienne sprawiają, że szablony można wielokrotnie wykorzystywać i łatwiej je utrzymywać, a przepływ pracy validate, what-if, deploy umożliwia bezpieczne i powtarzalne wdrożenia. Następnie zajmiemy się Bicep — nowoczesną abstrakcją nad kodem JSON ARM.