Variáveis em modelos do ARM

Artigo
03/20/2024

Este artigo descreve como definir e utilizar variáveis no modelo do Azure Resource Manager (modelo arm). Utiliza variáveis para simplificar o modelo. Em vez de repetir expressões complicadas em todo o modelo, define uma variável que contém a expressão complicada. Em seguida, utilize essa variável conforme necessário em todo o modelo.

Resource Manager resolve as variáveis antes de iniciar as operações de implementação. Onde quer que a variável seja utilizada no modelo, o Resource Manager substitui-a pelo valor resolvido.

Dica

Recomendamos o Bicep porque oferece as mesmas capacidades que os modelos do ARM e a sintaxe é mais fácil de utilizar. Para saber mais, veja variáveis.

Está limitado a 256 variáveis num modelo. Para obter mais informações, veja Limites de modelos.

Definir variável

Ao definir uma variável, não especifica um tipo de dados para a variável. Em vez disso, forneça um valor ou expressão de modelo. O tipo de variável é inferido a partir do valor resolvido. O exemplo seguinte define uma variável para uma cadeia.

"variables": {
  "stringVar": "example value"
},

Para construir a variável, pode utilizar o valor de um parâmetro ou de outra variável.

"parameters": {
  "inputValue": {
    "defaultValue": "deployment parameter",
    "type": "string"
  }
},
"variables": {
  "stringVar": "myVariable",
  "concatToVar": "[concat(variables('stringVar'), '-addtovar') ]",
  "concatToParam": "[concat(parameters('inputValue'), '-addtoparam')]"
}

Pode utilizar funções de modelo para construir o valor da variável.

O exemplo seguinte cria um valor de cadeia para um nome de conta de armazenamento. Utiliza várias funções de modelo para obter um valor de parâmetro e concatena-o numa cadeia exclusiva.

"variables": {
  "storageName": "[concat(toLower(parameters('storageNamePrefix')), uniqueString(resourceGroup().id))]"
},

Não pode utilizar a função de referência ou qualquer uma das funções de lista na declaração de variável. Estas funções obtêm o estado de runtime de um recurso e não podem ser executadas antes da implementação quando as variáveis são resolvidas.

Utilizar variável

O exemplo seguinte mostra como utilizar a variável para uma propriedade de recurso.

Para referenciar o valor da variável, utilize a função variables .

"variables": {
  "storageName": "[concat(toLower(parameters('storageNamePrefix')), uniqueString(resourceGroup().id))]"
},
"resources": [
  {
    "type": "Microsoft.Storage/storageAccounts",
    "name": "[variables('storageName')]",
    ...
  }
]

Modelo de exemplo

O modelo seguinte não implementa recursos. Mostra algumas formas de declarar variáveis de diferentes tipos.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "inputValue": {
      "defaultValue": "deployment parameter",
      "type": "string"
    }
  },
  "variables": {
    "stringVar": "myVariable",
    "concatToVar": "[concat(variables('stringVar'), '-addtovar') ]",
    "concatToParam": "[concat(parameters('inputValue'), '-addtoparam')]",
    "arrayVar": [
      1,
      2,
      3,
      4
    ],
    "objectVar": {
      "property1": "value1",
      "property2": "value2"
    },
    "copyWithinVar": {
      "copy": [
        {
          "name": "disks",
          "count": 5,
          "input": {
            "name": "[concat('myDataDisk', copyIndex('disks', 1))]",
            "diskSizeGB": "1",
            "diskIndex": "[copyIndex('disks')]"
          }
        },
        {
          "name": "diskNames",
          "count": 5,
          "input": "[concat('myDataDisk', copyIndex('diskNames', 1))]"
        }
      ]
    },
    "copy": [
      {
        "name": "topLevelCopy1",
        "count": 5,
        "input": {
          "name": "[concat('oneDataDisk', copyIndex('topLevelCopy1', 1))]",
          "diskSizeGB": "1",
          "diskIndex": "[copyIndex('topLevelCopy1')]"
        }
      },
      {
        "name": "topLevelCopy2",
        "count": 3,
        "input": {
          "name": "[concat('twoDataDisk', copyIndex('topLevelCopy2', 1))]",
          "diskSizeGB": "1",
          "diskIndex": "[copyIndex('topLevelCopy2')]"
        }
      },
      {
        "name": "topLevelCopy3",
        "count": 4,
        "input": "[concat('stringValue', copyIndex('topLevelCopy3'))]"
      },
      {
        "name": "topLevelCopy4",
        "count": 4,
        "input": "[copyIndex('topLevelCopy4')]"
      }
    ]
  },
  "resources": [],
  "outputs": {
    "stringOutput": {
      "type": "string",
      "value": "[variables('stringVar')]"
    },
    "concatToVariableOutput": {
      "type": "string",
      "value": "[variables('concatToVar')]"
    },
    "concatToParameterOutput": {
      "type": "string",
      "value": "[variables('concatToParam')]"
    },
    "arrayOutput": {
      "type": "array",
      "value": "[variables('arrayVar')]"
    },
    "arrayElementOutput": {
      "type": "int",
      "value": "[variables('arrayVar')[0]]"
    },
    "objectOutput": {
      "type": "object",
      "value": "[variables('objectVar')]"
    },
    "copyWithinVariableOutput": {
      "type": "object",
      "value": "[variables('copyWithinVar')]"
    },
    "topLevelCopyOutput1": {
      "type": "array",
      "value": "[variables('topLevelCopy1')]"
    },
    "topLevelCopyOutput2": {
      "type": "array",
      "value": "[variables('topLevelCopy2')]"
    },
    "topLevelCopyOutput3": {
      "type": "array",
      "value": "[variables('topLevelCopy3')]"
    },
    "topLevelCopyOutput4": {
      "type": "array",
      "value": "[variables('topLevelCopy4')]"
    }
  }
}

Variáveis de configuração

Pode definir variáveis que contêm valores relacionados para configurar um ambiente. Define a variável como um objeto com os valores. O exemplo seguinte mostra um objeto que contém valores para dois ambientes : teste e prod. Transmita um destes valores durante a implementação.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "environmentName": {
      "type": "string",
      "allowedValues": [
        "test",
        "prod"
      ],
      "metadata": {
        "description": "Specify either test or prod for configuration values."
      }
    }
  },
  "variables": {
    "environmentSettings": {
      "test": {
        "instanceSize": "Small",
        "instanceCount": 1
      },
      "prod": {
        "instanceSize": "Large",
        "instanceCount": 4
      }
    }
  },
  "resources": [],
  "outputs": {
    "instanceSize": {
      "value": "[variables('environmentSettings')[parameters('environmentName')].instanceSize]",
      "type": "string"
    },
    "instanceCount": {
      "value": "[variables('environmentSettings')[parameters('environmentName')].instanceCount]",
      "type": "int"
    }
  }
}

Passos seguintes

Para saber mais sobre as propriedades disponíveis para variáveis, veja Compreender a estrutura e a sintaxe dos modelos do ARM.
Para obter recomendações sobre a criação de variáveis, veja Melhores práticas - variáveis.
Para obter um modelo de exemplo que atribua regras de segurança a um grupo de segurança de rede, veja regras de segurança de rede e ficheiro de parâmetros.

Partilhar via