Explore a estrutura e o esquema do modelo do Azure Resource Manager

  • 6 minutos

Um modelo do Azure Resource Manager contém uma definição formatada em JSON de um ou mais recursos do Azure, juntamente com parâmetros e variáveis que facilitam a personalização de sua configuração.

Em sua estrutura mais simples, um modelo tem os seguintes elementos:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "",
  "apiProfile": "",
  "parameters": {  },
  "variables": {  },
  "functions": [  ],
  "resources": [  ],
  "outputs": {  }
}
Nome do elemento Necessário Description
$schema Sim Local do arquivo de esquema JSON (JavaScript Object Notation) que descreve a versão da linguagem do modelo. O número de versão que utiliza depende do âmbito da implementação e do seu editor de JSON.

Se você estiver usando o Visual Studio Code com a extensão de ferramentas do Azure Resource Manager, use a versão mais recente para implantações de grupo de recursos:
https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#

Outros editores (incluindo o Visual Studio) podem não conseguir processar esse esquema. Para esses editores, use:
https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#

Para implantações de assinatura, use:
https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#

Para implantações de grupo de gerenciamento, use:
https://schema.management.azure.com/schemas/2019-08-01/managementGroupDeploymentTemplate.json#

Para implantações de locatário, use:
https://schema.management.azure.com/schemas/2019-08-01/tenantDeploymentTemplate.json#
contentVersion Sim Versão do modelo (como 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 usando o modelo, esse valor pode ser usado para garantir que o modelo correto esteja sendo usado.
apiProfile Não Uma versão da API que serve como uma coleção de versões da API para tipos de recursos. Use esse valor para evitar ter que especificar versões de API para cada recurso no modelo. Quando você especifica uma versão de perfil de API e não especifica uma versão de API para o tipo de recurso, o Gerenciador de Recursos usa a versão de API para esse tipo de recurso definido no perfil.

A propriedade de perfil da API é especialmente útil ao implantar um modelo em ambientes diferentes, como o Azure Stack e o Azure global. Use a versão do perfil da API para garantir que seu modelo use automaticamente as versões suportadas em ambos os ambientes. Para obter uma lista das versões atuais do perfil da API e das versões da API de recursos definidas no perfil, consulte Perfil da API.

Para obter mais informações, consulte Controlar versões usando perfis de API.
parameters Não Valores fornecidos quando a implantação é executada para personalizar a implantação de recursos.
variáveis Não Valores que são usados como fragmentos JSON no modelo para simplificar expressões de linguagem de modelo.
funções Não Funções definidas pelo usuário que estão disponíveis no modelo.
Recursos Sim Tipos de recursos implantados ou atualizados em um grupo de recursos ou assinatura.
saídas Não Valores que são retornados após a implantação.

Demonstração opcional