Tutorial: Criar e implantar seu primeiro modelo do ARM

  • Artigo

Este tutorial apresenta a você os modelos do ARM (Azure Resource Manager). Ele mostra como criar um modelo inicial e implantá-lo no Azure. Esse tutorial ensina sobre a estrutura do modelo e as ferramentas necessárias para trabalhar com modelos. Leva cerca de 12 minutos para concluir esta instrução, mas o tempo real de conclusão varia com base em quantas ferramentas você precisa instalar.

Este tutorial é o primeiro de uma série. À medida que avança pela série, você modifica o modelo inicial passo a passo até explorar todas as partes principais de um modelo do ARM. Esses elementos são os blocos de construção para modelos muito mais complexos. Esperamos que ao final da série você tenha confiança para criar seus próprios modelos e esteja pronto para automatizar suas implantações com modelos.

Se você quiser saber mais sobre os benefícios de usar modelos e por que deve automatizar a implantação com modelos, confira visão geral do modelo do ARM. Para saber mais sobre os modelos do ARM por meio de um conjunto guiado de módulos do Learn, confira Implantar e gerenciar recursos no Azure usando modelos do ARM de JSON.

Caso não tenha uma assinatura do Microsoft Azure, crie uma conta gratuita antes de começar.

Dica

Se você for novo em ARM modelos, considere aprender o Bicep. Apresentamos um novo idioma chamado Bicep que oferece os mesmos recursos dos modelos do ARM, mas com uma sintaxe mais fácil de usar. Para saber mais sobre o Bicep, consulte Início rápido: criar arquivos Bicep com o Visual Studio Code.

Obter ferramentas

Vamos começar verificando se você tem as ferramentas necessárias para criar e implantar modelos. Instale estas ferramentas no seu computador local.

Editor

Os modelos são arquivos JavaScript Object Notation (JSON). Para criar modelos, você precisa de um bom editor de JSON. Recomendamos o Visual Studio Code com a extensão Ferramentas do Azure Resource Manager. Se precisar instalar essas ferramentas, confira Guia de Início Rápido: Criar modelos do ARM com o Visual Studio Code.

Implantação de linha de comando

Você também precisa do Azure PowerShell ou da interface de linha de comando do Azure (CLI) para implantar o modelo. Se você usar a CLI do Azure, precisará ter a versão 2.37.0 ou posterior. Para obter as instruções de instalação, confira:

Depois de instalar o Azure PowerShell ou a CLI do Azure, é preciso que você entre pela primeira vez. Para obter ajuda, confira Entrar – PowerShell ou Entrar – CLI do Azure.

Importante

Se você estiver usando a CLI do Azure, verifique se você tem a versão 2.37.0 ou posterior. Se você estiver usando o Azure PowerShell, verifique se você tem a versão 7.2.4 ou posterior. Os comandos mostrados neste tutorial não funcionarão se você estiver usando versões anteriores. Para verificar sua versão instalada, use: az --version.

Ok, você está pronto para começar a aprender sobre modelos.

Criar seu primeiro modelo

  1. Abra o Visual Studio Code com a extensão Ferramentas do processador ARM instalada.

  2. Do menu Arquivo, selecione Novo Arquivo para criar um novo arquivo.

  3. No menu arquivo, selecione Salvar como.

  4. Dê ao arquivo o nome azuredeploy e selecione a extensão de arquivo json. O nome completo do arquivo é azuredeploy.json.

  5. Salve o arquivo na estação de trabalho. Selecione um caminho que seja fácil de lembrar, pois você fornecerá esse caminho mais tarde ao implantar o modelo.

  6. Copie e cole o JSON a seguir no arquivo:

    {
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": []
}

    Esta é a aparência do seu ambiente do Visual Studio Code:

    Captura de tela do Visual Studio Code exibindo um modelo ARM vazio com estrutura JSON no editor.

    Este modelo não implanta nenhum recurso. Estamos começando com um modelo em branco para que você possa se familiarizar com as etapas para implantar um modelo, minimizando a chance de algo dar errado.

    O arquivo JSON tem estes elementos:

    • $schema: especifica a localização do arquivo de esquema JSON. O arquivo de esquema descreve as propriedades que estão disponíveis em um modelo. Por exemplo, o esquema define resources como uma das propriedades válidas para um modelo. Não se preocupe se a data do esquema é 04-01-2019. Essa versão de esquema está atualizada e inclui todos os recursos mais recentes. A data do esquema não foi alterada porque não houve alterações significativas desde sua introdução.
    • contentVersion: Especifica a versão do modelo por exemplo, 1.0.0.0. Você pode fornecer qualquer valor para esse elemento. Use esse valor para documentar alterações significativas em seu modelo. Ao implantar recursos com o modelo, você pode usar esse valor para verificar se está usando o modelo correto.
    • resources: Contém os recursos que você deseja implantar ou atualizar. Atualmente está vazio, mas você adicionará recursos mais tarde.

  7. Salve o arquivo.

Parabéns, você criou seu primeiro modelo.

Entrar no Azure

Para começar a trabalhar com o Azure PowerShell ou com a CLI do Azure, entre com suas credenciais do Azure.

Selecione as guias nas seções de código a seguir para escolher entre o Azure PowerShell e a CLI do Azure. Os exemplos de CLI neste artigo são escritos para o shell do Bash.

Connect-AzAccount

Se tiver várias assinaturas do Azure, selecione a que deseja usar. Substitua SubscriptionName pelo nome da sua assinatura. Em vez do nome da assinatura, você também pode usar a ID da assinatura.

Set-AzContext SubscriptionName

Criar grupo de recursos

Ao implantar um modelo, você pode especificar um grupo de recursos que conterá os recursos. Antes de executar o comando de implantação, crie o grupo de recursos com o Bash da CLI do Azure ou o Azure PowerShell.

Observação

As amostras da CLI do Azure são escritas para o bash do shell. Para executar este exemplo no Windows PowerShell ou no Prompt de Comando, talvez seja necessário remover as barras traseiras e gravar o comando como uma linha, como:

az group create --name myResourceGroup --location "Central US"

New-AzResourceGroup `
  -Name myResourceGroup `
  -Location "Central US"

Implantar modelo

Para implantar o modelo, use a CLI do Azure ou o Azure PowerShell. Use o grupo de recursos que você criou anteriormente. Dê um nome para a implantação para que você possa identificá-la facilmente no histórico de implantação. Para sua conveniência, crie também uma variável que armazena o caminho para o arquivo de modelo. Essa variável facilita a execução dos comandos de implantação porque você não precisa digitar o caminho sempre que implantar. Substitua {provide-the-path-to-the-template-file} e as chaves {} pelo caminho para o arquivo de modelo.

$templateFile = "{provide-the-path-to-the-template-file}"
New-AzResourceGroupDeployment `
  -Name blanktemplate `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile

O comando de implantação retorna os resultados. Procure ProvisioningState para ver se a implantação foi bem-sucedida.

Observação

Se a implantação falhar, use a opção verbose para obter informações sobre os recursos que estão sendo criados. Use a opção debug para obter mais informações de depuração.

Verificar implantação

Você pode verificar a implantação explorando o grupo de recursos no portal do Azure.

  1. Entre no portal do Azure.

  2. No menu à esquerda, selecione Grupos de recursos.

  3. Marque a caixa à esquerda de myResourceGroup e selecione myResourceGroup.

  4. Selecionar o grupo de recursos que você criou no procedimento anterior. O nome padrão é myResourceGroup. O grupo de recursos ainda não tem recursos porque você implantou um modelo em branco.

  5. Observe que, no meio da visão geral, na seção Essentials, a página exibe o status da implantação ao lado de Implantações. Selecione 1 Bem-sucedida.

    Captura de tela do portal do Azure mostrando o status da implantação na seção Essentials do grupo de recursos.

  6. Você vê um histórico das implantações do grupo de recursos. Marque a caixa à esquerda de blanktemplate e selecione blanktemplate.

    Captura de tela do portal do Azure exibindo o histórico de implantação com uma implantação de modelo em branco selecionada.

  7. Você verá um resumo da implantação. Nesse caso não há muito o que ver, porque nenhum recurso foi implantado. Posteriormente nesta série, talvez você ache útil examinar o resumo no histórico de implantação. Observe que à esquerda você pode exibir entradas, saídas e o modelo usado durante a implantação.

    Captura de tela do portal do Azure mostrando o resumo da implantação do modelo em branco.

Limpar os recursos

Se você estiver passando para o próximo tutorial, não será necessário excluir o grupo de recursos.

Se estiver parando agora, talvez você queira excluir o grupo de recursos.

  1. No portal do Azure, selecione Grupos de recursos no menu à esquerda.

  2. Digite o nome do grupo de recursos no campo de texto Filtro para qualquer campo....

  3. Marque a caixa ao lado de myResourceGroup e selecione myResourceGroup ou o nome do seu grupo de recursos.

  4. Escolha Excluir grupo de recursos no menu superior.

    Captura de tela do portal do Azure com a opção

Próximas etapas

Você criou um modelo simples para implantar no Azure. No próximo tutorial, você aprenderá a adicionar uma conta de armazenamento ao modelo e implantá-la em seu grupo de recursos.

Adicionar recurso