Snabbstart: Skapa ARM-mallar med Visual Studio Code

Azure Resource Manager Tools for Visual Studio Code tillhandahåller språkstöd, resursfragment och automatisk komplettering av resurser. De här verktygen hjälper dig att skapa och verifiera Azure Resource Manager-mallar (ARM-mallar) och är därför den rekommenderade metoden för att skapa och konfigurera ARM-mallar. I den här snabbstarten använder du tillägget för att skapa en ARM-mall från grunden. När du gör det upplever du tilläggsfunktioner som ARM-mallfragment, validering, slutföranden och stöd för parameterfiler.

För att slutföra den här snabbstarten behöver du Visual Studio Code, med tillägget Azure Resource Manager tools installerat. Du behöver också antingen Azure CLI eller modulen Azure PowerShell installerad och autentiserad.

Om du inte har en Azure-prenumeration kan du skapa ett kostnadsfritt konto innan du börjar.

Tips

Vi rekommenderar Bicep eftersom det har samma funktioner som ARM-mallar och syntaxen är enklare att använda. Mer information finns i Snabbstart: Skapa Bicep-filer med Visual Studio Code.

Skapa en ARM-mall

Skapa och öppna med Visual Studio Code en ny fil med namnet azuredeploy.json. Ange arm i kodredigeraren, som initierar Azure Resource Manager kodfragment för att autogenerera en ARM-mall.

Välj arm! för att skapa en mall som är begränsad till en Azure-resursgruppsdistribution.

Bild som visar Kodfragment för Azure Resource Manager-kodfragment

Det här kodfragmentet skapar de grundläggande byggstenarna för en ARM-mall.

Bild som visar en fullständigt autogenererad ARM-mall

Observera att språkläget i Visual Studio Code har ändrats från JSON till Azure Resource Manager Template. Tillägget innehåller en språkserver som är specifik för ARM-mallar som tillhandahåller ARM-mallspecifik validering, slutförande och andra språktjänster.

Bild som visar Azure Resource Manager som språkläget i Visual Studio Code

Lägga till en Azure-resurs

Tillägget innehåller kodfragment för många Azure-resurser. Dessa kodfragment kan användas för att enkelt lägga till resurser i malldistributionen.

Placera markören i mallresursblocket , skriv in storageoch välj kodfragmentet arm-storage .

Bild som visar en resurs som läggs till i ARM-mallen

Den här åtgärden lägger till en lagringsresurs i mallen.

Bild som visar en Azure Storage-resurs i en ARM-mall

Tabbnyckeln kan användas för att ta en flik via konfigurerbara egenskaper för lagringskontot.

Bild som visar hur tabbnyckeln kan användas för att navigera i resurskonfigurationen

Slutförande och validering

En av de mest kraftfulla funktionerna i tillägget är dess integrering med Azure-scheman. Azure-scheman tillhandahåller tillägget med validerings- och resursmedvetna slutförandefunktioner. Nu ska vi ändra lagringskontot för att se hur valideringen och slutförandet fungerar.

Uppdatera först lagringskontots typ till ett ogiltigt värde, till exempel megaStorage. Observera att den här åtgärden genererar en varning som anger att megaStorage inte är ett giltigt värde.

Bild som visar en ogiltig lagringskonfiguration

Om du vill använda slutförandefunktionerna tar du bort megaStorage, placerar markören inuti de dubbla citattecknarna och trycker på + ctrlspace . Den här åtgärden visar en kompletteringslista med giltiga värden.

Bild som visar automatisk komplettering av tillägg

Lägga till mallparametrar

Skapa och använd nu en parameter för att ange lagringskontots namn.

Placera markören i parameterblocket, lägg till en vagnretur, skriv "och välj sedan kodfragmentet new-parameter . Den här åtgärden lägger till en allmän parameter i mallen.

Bild som visar en parameter som läggs till i ARM-mallen

Uppdatera namnet på parametern till storageAccountName och beskrivningen till Storage Account Name.

Bild som visar den slutförda parametern i en ARM-mall

Namn på Azure-lagringskonton har en minsta längd på 3 tecken och högst 24. Lägg till både minLength och maxLength i parametern och ange lämpliga värden.

Bild som visar minLength och maxLength som läggs till i en ARM-mallparameter

Uppdatera nu namnegenskapen för lagringsresursen så att parametern används. Det gör du genom att ta bort det aktuella namnet. Ange ett dubbelt citattecken och en inledande hakparentes [, som skapar en lista över ARM-mallfunktioner. Välj parametrar i listan.

Bild som visar automatisk slutförande när parametrar används i ARM-mallresurser

Om du anger ett enkelt citattecken ' inom de runda hakparenteserna skapas en lista över alla parametrar som definierats i mallen, i det här fallet storageAccountName. Välj parametern .

Bild som visar slutförd parameter i en ARM-mallresurs

Skapa en parameterfil

Med en ARM-mallparameterfil kan du lagra miljöspecifika parametervärden och skicka dessa värden som en grupp vid distributionen. Du kan till exempel ha en parameterfil med värden som är specifika för en testmiljö och en annan för en produktionsmiljö.

Tillägget gör det enkelt att skapa en parameterfil från dina befintliga mallar. Det gör du genom att högerklicka på mallen i kodredigeraren och välja Select/Create Parameter File.

Bild som visar högerklicksprocessen för att skapa en parameterfil från en ARM-mall

Välj New>All Parameters> Välj ett namn och en plats för parameterfilen.

Bild som visar dialogrutan för namn och spara fil när du skapar en parameterfil från en ARM-mall

Den här åtgärden skapar en ny parameterfil och mappar den med mallen som den skapades från. Du kan se och ändra den aktuella mallen/parameterfilens mappning i statusfältet i Visual Studio Code medan mallen är markerad.

Bild som visar mappningen av mall-/parameterfilen i statusfältet i Visual Studio Code.

Nu när parameterfilen har mappats till mallen validerar tillägget både mallen och parameterfilen tillsammans. Om du vill se den här verifieringen i praktiken lägger du till ett värde med två tecken till parametern storageAccountName i parameterfilen och sparar filen.

Bild som visar en ogiltig mall på grund av problem med parameterfilen

Gå tillbaka till ARM-mallen och observera att ett fel har genererats som anger att värdet inte uppfyller parameterkriterierna.

Bild som visar en giltig ARM-mall

Uppdatera värdet till något lämpligt, spara filen och gå tillbaka till mallen. Observera att felet för parametern har lösts.

Distribuera mallen

Öppna den integrerade Visual Studio Code-terminalen med hjälp av nyckelkombinationen ctrl + ` och använd antingen Azure CLI- eller Azure PowerShell-modulen för att distribuera mallen.

az group create --name arm-vscode --location eastus

az deployment group create --resource-group arm-vscode --template-file azuredeploy.json --parameters azuredeploy.parameters.json

Rensa resurser

När Azure-resurserna inte längre behövs kan du använda Azure CLI eller Azure PowerShell modulen för att ta bort snabbstartsresursgruppen.

az group delete --name arm-vscode

Nästa steg