Azure Resource Manager テンプレートのコピー ループのパラメーターとしてオブジェクトを使用する
Azure Resource Manager テンプレート (ARM テンプレート) でオブジェクトをパラメーターとして使用すると、コピー ループにそれらを含めることができます。 この方法は、シリアル コピー ループ (特に子リソースのデプロイ) と組み合わせるときに非常に便利です。
このアプローチを示すために、2 つのセキュリティ規則でネットワーク セキュリティ グループ (NSG) をデプロイするテンプレートを見てみましょう。
まず、パラメーターを見てみましょう。 テンプレートを見ると、securityRules という名前の配列を含む networkSecurityGroupsSettings という名前の 1 つのパラメーターを定義したことがわかります。 この配列には、セキュリティ規則を定義する設定をそれぞれ指定する 2 つの 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"
}
]
}
}
}
}
ここで、テンプレートを見てみましょう。 NSG をデプロイする NSG1 という名前のリソースがあります。 これは、ARM の組み込みのプロパティ イテレーション機能も使用します。 テンプレート内のリソースの properties セクションにコピー ループを追加することにより、デプロイ時にプロパティの項目数を動的に設定できます。 テンプレートの構文を繰り返す必要もありません。
{
"$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 コマンドを実行します。
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 テンプレートのドキュメント