Использование объектов в качестве параметров в цикле копирования в шаблоне Azure Resource Manager
При использовании объектов в качестве параметров в шаблонах Azure Resource Manager (шаблоны ARM) их можно включить в цикл копирования. Этот метод очень полезен в сочетании с циклом последовательного копирования, особенно для развертывания дочерних ресурсов.
Чтобы продемонстрировать этот подход, рассмотрим шаблон, который развертывает группу безопасности сети (NSG) с двумя правилами безопасности.
Сначала рассмотрим наши параметры. При просмотре шаблона мы видим, что мы определили один параметр с именем networkSecurityGroupsSettings
, который включает массив с именем securityRules
. Этот массив содержит два объекта JSON, каждый из которых задает параметры, определяющие правило безопасности.
{
"$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"
}
]
}
}
}
}
Теперь рассмотрим наш шаблон. У нас есть ресурс с именем NSG1
, который развертывает группу безопасности сети. Она также использует встроенную функцию итерации свойств ARM. Добавив цикл копирования в раздел свойств ресурса в шаблоне, можно динамически задавать количество элементов для свойства во время развертывания. Кроме того, не нужно будет повторять синтаксис шаблона.
{
"$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]"
}
}
}
]
}
}
]
}
Давайте подробнее рассмотрим, как значения свойств указываются в дочернем ресурсе securityRules
. Все наши свойства ссылаются с помощью parameters()
функции . Затем мы используем оператор точка для ссылки на наш securityRules
массив и индексируем его по текущему значению итерации. И наконец, еще один оператор-точку мы используем для ссылки на имя объекта.
Пробное использование шаблона
Пример шаблона доступен на сайте GitHub. Чтобы развернуть этот шаблон с помощью Azure CLI, выполните следующие команды Azure CLI:
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
Дальнейшие действия
- Azure Resource Manager
- Что такое шаблоны ARM?
- Руководство. Создание и развертывание первого шаблона ARM
- Руководство по добавлению ресурса в шаблон ARM
- Рекомендации по работе с шаблоном ARM
- Документация по Azure Resource Manager
- Документация по шаблонам ARM