Usar objetos como parâmetros em um loop de cópia em um modelo do Azure Resource Manager
Ao usar objetos como parâmetros em modelos do Azure Resource Manager (modelos ARM), você pode incluí-los em um loop de cópia. Essa técnica é muito útil quando é combinada com um loop de cópia serial, especialmente para implantar recursos filho.
Para demonstrar isso, vamos dar uma olhada em um modelo que implante um NSG (grupo de segurança de rede) com duas regras de segurança.
Primeiro, vamos dar uma olhada nos nossos parâmetros. Quando examinamos nosso modelo, vemos que definimos um parâmetro denominado networkSecurityGroupsSettings
, que inclui uma matriz chamada securityRules
. Essa matriz contém dois objetos JSON, cada um dos quais especifica configurações que definem uma regra de segurança.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"parameters":{
"networkSecurityGroupsSettings": {
"value": {
"securityRules": [
{
"name": "RDPAllow",
"description": "allow RDP connections",
"direction": "Inbound",
"priority": 100,
"sourceAddressPrefix": "*",
"destinationAddressPrefix": "10.0.0.0/24",
"sourcePortRange": "*",
"destinationPortRange": "3389",
"access": "Allow",
"protocol": "Tcp"
},
{
"name": "HTTPAllow",
"description": "allow HTTP connections",
"direction": "Inbound",
"priority": 200,
"sourceAddressPrefix": "*",
"destinationAddressPrefix": "10.0.1.0/24",
"sourcePortRange": "*",
"destinationPortRange": "80",
"access": "Allow",
"protocol": "Tcp"
}
]
}
}
}
}
Agora vamos dar uma olhada no nosso modelo. Temos um recurso chamado NSG1
que implanta o NSG. Ele também usa o recurso de iteração de propriedade interno do ARM. Ao adicionar o loop de cópia à seção de propriedades de um recurso em seu modelo, você consegue definir dinamicamente o número de itens para uma propriedade durante a implantação. Você também evita a repetição da sintaxe do modelo.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"VNetSettings": {
"type": "object"
},
"networkSecurityGroupsSettings": {
"type": "object"
}
},
"resources": [
{
"apiVersion": "2020-05-01",
"type": "Microsoft.Network/virtualNetworks",
"name": "[parameters('VNetSettings').name]",
"location": "[resourceGroup().location]",
"properties": {
"addressSpace": {
"addressPrefixes": [
"[parameters('VNetSettings').addressPrefixes[0].addressPrefix]"
]
},
"subnets": [
{
"name": "[parameters('VNetSettings').subnets[0].name]",
"properties": {
"addressPrefix": "[parameters('VNetSettings').subnets[0].addressPrefix]"
}
},
{
"name": "[parameters('VNetSettings').subnets[1].name]",
"properties": {
"addressPrefix": "[parameters('VNetSettings').subnets[1].addressPrefix]"
}
}
]
}
},
{
"apiVersion": "2020-05-01",
"type": "Microsoft.Network/networkSecurityGroups",
"name": "NSG1",
"location": "[resourceGroup().location]",
"properties": {
"copy": [
{
"name": "securityRules",
"count": "[length(parameters('networkSecurityGroupsSettings').securityRules)]",
"input": {
"name": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].name]",
"properties": {
"description": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].description]",
"priority": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].priority]",
"protocol": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].protocol]",
"sourcePortRange": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].sourcePortRange]",
"destinationPortRange": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].destinationPortRange]",
"sourceAddressPrefix": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].sourceAddressPrefix]",
"destinationAddressPrefix": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].destinationAddressPrefix]",
"access": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].access]",
"direction": "[parameters('networkSecurityGroupsSettings').securityRules[copyIndex('securityRules')].direction]"
}
}
}
]
}
}
]
}
Vamos examinar mais detalhadamente como podemos especificar os valores de propriedade no recurso filho securityRules
. Todas as nossas propriedades são referenciadas usando a função parameters()
. Em seguida, usamos o operador dot para fazer referência à nossa securityRules
matriz e indexá-la pelo valor atual da iteração. Por fim, usamos outro operador de ponto para fazer referência ao nome do objeto.
Experimentar o modelo
Um modelo de exemplo está disponível no GitHub. Para implantar o modelo, clone o repositório e execute os seguintes comandos da CLI do Azure:
git clone https://github.com/mspnp/template-examples.git
cd template-examples/example3-object-param
az group create --location <location> --name <resource-group-name>
az deployment group create -g <resource-group-name> \
--template-uri https://raw.githubusercontent.com/mspnp/template-examples/master/example3-object-param/deploy.json \
--parameters deploy.parameters.json
Próximas etapas
- Azure Resource Manager
- O que são modelos do ARM?
- Tutorial: Criar e implantar seu primeiro modelo do Resource Manager
- Tutorial: Adicionar um recurso ao modelo do ARM
- Práticas recomendadas para modelos do ARM
- Documentação do Azure Resource Manager
- Documentação do modelo ARM