Quickstart: Criar modelos de gestor de recursos Azure com Código de Estúdio VisualQuickstart: Create Azure Resource Manager templates with Visual Studio Code

As Ferramentas de Gestor de Recursos Azure para Código do Estúdio Visual fornecem suporte linguístico, snippets de recursos e auto-preconização de recursos.The Azure Resource Manager Tools for Visual Studio Code provide language support, resource snippets, and resource autocompletion. Estas ferramentas ajudam a criar e validar modelos do Gestor de Recursos Azure.These tools help create and validate Azure Resource Manager templates. Neste arranque rápido, você usa a extensão para criar um modelo de Gestor de Recursos Azure de raiz.In this quickstart, you use the extension to create an Azure Resource Manager template from scratch. Ao fazê-lo, experimenta as capacidades de extensões tais como snippets de modelo ARM, validação, conclusão e suporte de ficheiros de parâmetros.While doing so you experience the extensions capabilities such as ARM template snippets, validation, completions, and parameter file support.

Para completar este arranque rápido, precisa do Código do Estúdio Visual,com a extensão de ferramentas Azure Resource Manager instalada.To complete this quickstart, you need Visual Studio Code, with the Azure Resource Manager tools extension installed. Também precisa do Azure CLI ou do módulo Azure PowerShell instalado e autenticado.You also need either the Azure CLI or the Azure PowerShell module installed and authenticated.

Se não tiver uma subscrição do Azure, crie uma conta gratuita antes de começar.If you don't have an Azure subscription, create a free account before you begin.

Criar um modelo ARMCreate an ARM template

Crie e abra com o Visual Studio Code um novo ficheiro nomeado azuredeploy.jsem.Create and open with Visual Studio Code a new file named azuredeploy.json. Introduza arm o editor de código, que inicia os cortes do Azure Resource Manager para andaimes com um modelo ARM.Enter arm into the code editor, which initiates Azure Resource Manager snippets for scaffolding out an ARM template.

Selecione arm! para criar um modelo traçado para uma implementação de grupo de recursos Azure.Select arm! to create a template scoped for an Azure resource group deployment.

Imagem mostrando azure Resource Manager andaimes

Este corte cria os blocos básicos de construção para um modelo ARM.This snippet creates the basic building blocks for an ARM template.

Imagem mostrando um modelo DE ARM totalmente andaime

Note que o modo de linguagem Visual Studio Code mudou de JSON para Azure Resource Manager Template.Notice that the Visual Studio Code language mode has changed from JSON to Azure Resource Manager Template. A extensão inclui um servidor de idioma específico para modelos ARM que fornece validação, conclusão e outros serviços linguísticos específicos da ARM.The extension includes a language server specific to ARM templates which provides ARM template-specific validation, completion, and other language services.

Imagem mostrando Azure Resource Manager como o modo de linguagem Visual Studio Code

Adicione um recurso AzureAdd an Azure resource

A extensão inclui snippets para muitos recursos Azure.The extension includes snippets for many Azure resources. Estes snippets podem ser usados para adicionar facilmente recursos à sua implementação do modelo.These snippets can be used to easily add resources to your template deployment.

Coloque o cursor no bloco de recursos do gabarito, escreva storage e selecione o corte de armazenamento de braço.Place the cursor in the template resources block, type in storage, and select the arm-storage snippet.

Imagem mostrando um recurso sendo adicionado ao modelo ARM

Esta ação adiciona um recurso de armazenamento ao modelo.This action adds a storage resource to the template.

Imagem mostrando um recurso de armazenamento Azure em um modelo ARM

A tecla do separador pode ser usada para abasar através de propriedades configuráveis na conta de armazenamento.The tab key can be used to tab through configurable properties on the storage account.

Imagem mostrando como a tecla de separador pode ser usada para navegar através da configuração de recursos

Conclusão e validaçãoCompletion and validation

Uma das capacidades mais poderosas da extensão é a sua integração com os esquemas Azure.One of the most powerful capabilities of the extension is its integration with Azure schemas. Os esquemas Azure fornecem a extensão com capacidades de validação e de conclusão conscientes do recurso.Azure schemas provide the extension with validation and resource-aware completion capabilities. Vamos modificar a conta de armazenamento para ver validação e conclusão em ação.Let's modify the storage account to see validation and completion in action.

Em primeiro lugar, atualize o tipo de conta de armazenamento para um valor inválido, como megaStorage .First, update the storage account kind to an invalid value such as megaStorage. Note que esta ação produz um aviso indicando que megaStorage não é um valor válido.Notice that this action produces a warning indicating that megaStorage is not a valid value.

Imagem mostrando uma configuração de armazenamento inválida

Para utilizar as capacidades de conclusão, megaStorage remova, coloque o cursor dentro das cotações duplas e prima ctrl + space .To use the completion capabilities, remove megaStorage, place the cursor inside of the double quotes, and press ctrl + space. Esta ação apresenta uma lista de conclusão de valores válidos.This action presents a completion list of valid values.

Imagem mostrando a extensão auto-conclusão

Adicionar parâmetros de modeloAdd template parameters

Agora crie e use um parâmetro para especificar o nome da conta de armazenamento.Now create and use a parameter to specify the storage account name.

Coloque o cursor no bloco de parâmetros, adicione uma volta de transporte, " escreva e, em seguida, selecione o new-parameter corte.Place your cursor in the parameters block, add a carriage return, type ", and then select the new-parameter snippet. Esta ação adiciona um parâmetro genérico ao modelo.This action adds a generic parameter to the template.

Imagem mostrando um parâmetro sendo adicionado ao modelo ARM

Atualize o nome do parâmetro storageAccountName para e a descrição para Storage Account Name .Update the name of the parameter to storageAccountName and the description to Storage Account Name.

Imagem mostrando o parâmetro concluído em um modelo ARM

Os nomes da conta de armazenamento Azure têm um comprimento mínimo de 3 caracteres e um máximo de 24.Azure storage account names have a minimum length of 3 characters and a maximum of 24. Adicione ambos minLength e ao parâmetro e forneça os maxLength valores apropriados.Add both minLength and maxLength to the parameter and provide appropriate values.

Imagem mostrando minLength e maxLength sendo adicionados a um parâmetro do modelo ARM

Agora, no recurso de armazenamento, atualize a propriedade do nome para usar o parâmetro.Now, on the storage resource, update the name property to use the parameter. Para tal, retire o nome atual.To do so, remove the current name. Introduza uma cotação dupla e um suporte quadrado de [ abertura, que produz uma lista de funções do modelo ARM.Enter a double quote and an opening square bracket [, which produces a list of ARM template functions. Selecione parâmetros da lista.Select parameters from the list.

Imagem mostrando a conclusão automática ao usar parâmetros nos recursos do modelo ARM

A introdução de uma única cotação ' no interior dos suportes redondos produz uma lista de todos os parâmetros definidos no modelo, neste caso, armazenamentoAme de contagem de armazenamento.Entering a single quote ' inside of the round brackets produces a list of all parameters defined in the template, in this case, storageAccountName. Selecione o parâmetro.Select the parameter.

Imagem mostrando parâmetro completo em um recurso de modelo ARM

Criar um ficheiro de parâmetrosCreate a parameter file

Um ficheiro de parâmetro do modelo ARM permite armazenar valores de parâmetros específicos do ambiente e passar estes valores em grupo no tempo de implementação.An ARM template parameter file allows you to store environment-specific parameter values and pass these values in as a group at deployment time. Por exemplo, pode ter um ficheiro de parâmetros com valores específicos de um ambiente de teste e outro para um ambiente de produção.For example, you may have a parameter file with values specific to a test environment and another for a production environment.

A extensão facilita a criação de um ficheiro de parâmetros a partir dos seus modelos existentes.The extension makes it easy to create a parameter file from your existing templates. Para tal, clique com o botão direito no modelo no editor de código e selecione Select/Create Parameter File .To do so, right-click on the template in the code editor and select Select/Create Parameter File.

Imagem mostrando o processo de clique direito para criar um ficheiro de parâmetro a partir de um modelo ARM

Selecione New > All Parameters > Selecione um nome e localização para o ficheiro de parâmetros.Select New > All Parameters > Select a name and location for the parameter file.

Imagem mostrando o nome e guardar o diálogo de ficheiro ao criar um ficheiro de parâmetros a partir de um modelo ARM

Esta ação cria um novo arquivo de parâmetros e mapeia-o com o modelo a partir do qual foi criado.This action creates a new parameter file and maps it with the template from which it was created. Pode ver e modificar o mapeamento de ficheiros do modelo/parâmetro atual na barra de estado do Código do Estúdio Visual enquanto o modelo é selecionado.You can see and modify the current template/parameter file mapping in the Visual Studio Code status bar while the template is selected.

Imagem mostrando o mapeamento de ficheiro de modelo/parâmetro na barra de estado do Código do Estúdio Visual.

Agora que o ficheiro de parâmetros foi mapeado para o modelo, a extensão valida tanto o modelo como o ficheiro de parâmetros juntos.Now that the parameter file has been mapped to the template, the extension validates both the template and parameter file together. Para ver esta validação na prática, adicione um valor de dois caracteres ao storageAccountName parâmetro no ficheiro do parâmetro e guarde o ficheiro.To see this validation in practice, add a two-character value to the storageAccountName parameter in the parameter file and save the file.

Imagem mostrando um modelo invalidado devido à questão do ficheiro do parâmetro

Volte ao modelo ARM e note que foi levantado um erro indicando que o valor não satisfaz os critérios de parâmetro.Navigate back to the ARM template and notice that an error has been raised indicating that the value does not meet the parameter criteria.

Imagem mostrando um modelo de ARM válido

Atualize o valor para algo apropriado, guarde o ficheiro e volte ao modelo.Update the value to something appropriate, save the file, and navigate back to the template. Note que o erro no parâmetro foi resolvido.Notice that the error on the parameter has been resolved.

Implementar o modeloDeploy the template

Abra o terminal integrado do Código do Estúdio Visual utilizando a ctrl + ` combinação de chaves e utilize o módulo Azure CLI ou Azure PowerShell para implantar o modelo.Open the integrated Visual Studio Code terminal using the ctrl + ` key combination and use either the Azure CLI or Azure PowerShell module to deploy the template.

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

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

Limpar recursosClean up resources

Quando os recursos Azure já não forem necessários, utilize o módulo Azure CLI ou Azure PowerShell para eliminar o grupo de recursos quickstart.When the Azure resources are no longer needed, use the Azure CLI or Azure PowerShell module to delete the quickstart resource group.

az group delete --name arm-vscode

Passos seguintesNext steps