Samouczek: korzystanie z dokumentacji szablonu usługi ARM

Dowiedz się, jak znaleźć informacje o schemacie szablonu i użyć tych informacji do tworzenia szablonów usługi Azure Resource Manager (szablonów usługi ARM).

W tym samouczku użyjesz szablonu podstawowego z szablonów szybkiego startu platformy Azure. Korzystając z dokumentacji referencyjnej szablonu, zweryfikujesz szablon.

Ten samouczek obejmuje następujące zadania:

• Otwieranie szablonu szybkiego startu
• Informacje o szablonie
• Znajdowanie dokumentacji szablonu
• Edytowanie szablonu
• Wdrożenie szablonu

Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Wymagania wstępne

Aby ukończyć pracę z tym artykułem, potrzebne są następujące zasoby:

• Program Visual Studio Code z rozszerzeniem Resource Manager Tools. Zobacz Szybki start: tworzenie szablonów usługi ARM przy użyciu Visual Studio Code.

Otwieranie szablonu szybkiego startu

Szablony szybkiego startu platformy Azure to repozytorium szablonów usługi ARM. Zamiast tworzyć szablon od podstaw, możesz znaleźć szablon przykładowy i zmodyfikować go. Szablon używany w tym przewodniku Szybki start ma nazwę Create a standard storage account (Tworzenie standardowego konta magazynu). Szablon definiuje zasób konta usługi Azure Storage.

1. W Visual Studio Code wybierz pozycję Plik>Otwórz plik.

2. W polu File name (Nazwa pliku) wklej następujący adres URL:

   https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json
   

3. Wybierz pozycję Open (Otwórz), aby otworzyć plik.

4. Wybierz pozycję Plik>Zapisz jako , aby zapisać plik jako azuredeploy.json na komputerze lokalnym.

Informacje o schemacie

1. Z poziomu Visual Studio Code zwiń szablon na poziom główny. Masz najprostszą strukturę z następującymi elementami:

   

   • $schema: określ lokalizację pliku schematu JSON opisującego wersję języka szablonu.
   • contentVersion: określ dowolną wartość dla tego elementu, aby udokumentować znaczące zmiany w szablonie.
   • metadata: określ metadane szablonu.
   • parameters: określ wartości, które są udostępniane podczas wdrażania w celu dostosowania wdrożenia zasobów.
   • variables: określ wartości, które są używane jako fragmenty JSON w szablonie, aby uprościć wyrażenia języka szablonu. Ten szablon nie zawiera tego elementu.
   • resources: określ typy zasobów, które są wdrażane lub aktualizowane w grupie zasobów.
   • outputs: określ wartości zwracane po wdrożeniu.

2. Rozwiń węzeł resources. Microsoft.Storage/storageAccounts Istnieje zdefiniowany zasób. Wersja interfejsu API wyświetlana na zrzucie ekranu to 2022-09-01. Nazwa jednostki SKU używa wartości parametru. Parametr nosi nazwę storageAccountType.

   

3. Rozwiń, parameters aby zobaczyć, jak storageAccountType jest zdefiniowany. Parametr ma osiem dozwolonych wartości.

Korzystając z odwołania do szablonu, możesz dowiedzieć się, czy używasz najnowszej wersji interfejsu API i czy definicja parametru zawiera wszystkie dozwolone wartości.

Znajdowanie dokumentacji szablonu

1. Przejdź do dokumentacji szablonu platformy Azure.

2. W polu Filtruj według tytułu wprowadź konta magazynu i wybierz pierwsze konta magazynu w obszarze Magazyn referencyjny>.

   

3. Wybierz pozycję Szablon usługi ARM.

4. Typ zasobu zwykle ma kilka wersji interfejsu API. Na tej stronie domyślnie jest wyświetlana najnowsza wersja schematu szablonu. Wybierz pole listy rozwijanej Najnowsze , aby wyświetlić wersje. Najnowsza wersja wyświetlana na zrzucie ekranu to 2022-09-01. Wybierz pozycję Najnowsza lub wersję bezpośrednio poniżej pozycji Najnowsze , aby wyświetlić najnowszą wersję. Upewnij się, że ta wersja jest zgodna z wersją używaną dla zasobu konta magazynu w szablonie. Jeśli zaktualizujesz wersję interfejsu API, sprawdź, czy definicja zasobu jest zgodna z odwołaniem do szablonu.

   

5. Ta strona zawiera szczegółowe informacje o typie zasobu storageAccount. Na przykład wyświetla listę dozwolonych wartości dla obiektu Sku . Istnieje osiem jednostek SKU i są one zgodne z tymi wymienionymi w otwartym wcześniej szablonie szybkiego startu.

   

Wdrożenie szablonu

1. Zaloguj się do usługi Azure Cloud Shell

2. Wybierz preferowane środowisko, wybierając program PowerShell lub powłokę Bash (dla interfejsu wiersza polecenia) w lewym górnym rogu. Po przełączeniu wymagane jest ponowne uruchomienie powłoki.

   

3. Wybierz pozycję Przekaż/pobierz pliki, a następnie wybierz pozycję Przekaż. Zobacz poprzedni zrzut ekranu. Wybierz plik, który został zapisany w poprzedniej sekcji. Po przekazaniu pliku możesz użyć ls polecenia i cat polecenia , aby sprawdzić, czy plik został pomyślnie przekazany.

4. W Cloud Shell uruchom następujące polecenia. Wybierz kartę, aby wyświetlić kod programu PowerShell lub kod interfejsu wiersza polecenia.

   Podczas wdrażania szablonu określ storageAccountType parametr z nowo dodaną wartością, na przykład Standard_RAGRS. Wdrożenie zakończy się niepowodzeniem, jeśli użyto oryginalnego szablonu szybkiego startu, ponieważ Standard_RAGRS nie była dozwoloną wartością.

   Interfejs wiersza polecenia

   echo "Enter a project name that is used to generate resource group name:" &&
   read projectName &&
   echo "Enter the location (i.e. centralus):" &&
   read location &&
   resourceGroupName="${projectName}rg" &&
   az group create --name $resourceGroupName --location "$location" &&
   az deployment group create --resource-group $resourceGroupName --template-file "$HOME/azuredeploy.json" --parameters storageAccountType='Standard_RAGRS'
   

   Program PowerShell

   $projectName = Read-Host -Prompt "Enter a project name that is used to generate resource group name"
   $location = Read-Host -Prompt "Enter the location (i.e. centralus)"
   $resourceGroupName = "${projectName}rg"
   
   New-AzResourceGroup -Name $resourceGroupName -Location "$location"
   New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName -TemplateFile "$HOME/azuredeploy.json" -storageAccountType "Standard_RAGRS"
   

Oczyszczanie zasobów

Gdy zasoby platformy Azure nie będą już potrzebne, wyczyść wdrożone zasoby, usuwając grupę zasobów.

1. W Azure Portal wybierz pozycję Grupa zasobów z menu po lewej stronie.
2. Wprowadź nazwę grupy zasobów w polu Filtruj według nazwy.
3. Wybierz nazwę grupy zasobów. W grupie zasobów zostanie wyświetlonych łącznie sześć zasobów.
4. Wybierz pozycję Usuń grupę zasobów z górnego menu.

Następne kroki

W tym samouczku przedstawiono sposób użycia dokumentacji szablonu w celu dostosowania istniejącego szablonu. Aby dowiedzieć się, jak utworzyć wiele wystąpień konta magazynu, zobacz:

Tworzenie wielu wystąpień