Azure - Update Existing RSG with ARM Template

Do you ever find yourself face this kind the situation: You are told to provision new resources with ARM templates to an existing resource group that already has VMs and vNets built and running. How can you add new subnets and VMs to the resource group without breaking those ones already there?

Unlike AWS Cloud Formation Templates, Microsoft ARM Templates do not provide “Update” option for past deployments. In order to modify the existing environment, the usual option is to make the change through CLI, PowerShell or Azure portal. But what if you somehow have to make the change through ARM template?

One way to do this is to create a template that enlists all existing resources and then add changes to it.

Below is a lab setup I created through portal. Assume there is a requirement to create another subnet in the same vNet.

Image

First, we use Azure Resource Group’s Automation script feature to generate a ARM template based on the existing resources.

image

Reformat and Cleanup ARM Template

Next, download the whole deployment package as a ZIP file and Extract to local folder.

Open the folder in Visual Studio Code. The only files we will be changing are “template.json” and “parameters.json”.

Enable GIT for source control.

image

Because all we want is to update existing resource, we will need to keep all the parameter values same as the resources already created. To do that, we convert all the parameters to variables.

In parameters.json file, cut all the parameters to a new file.

The parameters are list in the format below. Conveniently it has its current value appended in the parameter name. So first, we move this value into the “value” field.

"virtualMachines_proxyvm1_name": {
            "value": null
         },

After the change, the parameter looks like this:

"virtualMachines_name": {
             "value": proxyvm1
         },

Next, remove “{}” and “value:” from the new file. (VS Tip: use Ctrl + F2 to edit multiple phrases)

"virtualMachines_name": "proxyvm1",
"virtualNetworks_name": "tomlabVNET1",
"networkInterfaces_name": "proxyVMNic",
"networkSecurityGroups_name": "tomlabLinuxSG",
"publicIPAddresses_name": "tomlabpubdns1940326763",
"storageAccounts_name": "visuatomlabprox072316000",
"virtualMachines_id": "/subscriptions/911c1a11-0db1-11a1-b011-fa1a1e01ce11/resourceGroups/tomlab-kr/providers/Microsoft.Compute/disks/proxyvm1_OsDisk_1_11a11f1c0c11111db1fcab111aa11cd1"

Paste the contents from the new file to Template.json Variables section.

We now need to remove the parameters from the “parameters{ }” section in template.json, as they are replaced with variables.

Image

We also need to replace the parameters in the “resources{ }” section with “variables” and their changed names as well. This is the most tedious part of the conversion. I found VS Code’s multi-selection feature is quite handy to do this job.

To further clean the template, remove “comments” and “provisioningState” lines.

image

image

After the modification your template should have all parameters replaced with variables.

Validate the ARM Template

Use Azure CLI to validate the template (you will need to sign in first with az login). Since there is no parameter used, we don’t need to specify the parameter file location.

az group deployment validate --resource-group tomlab-kr --template-file .\template.json 

Once confirm the template is all valid, we can now add the new resource, in this case a new subnet to this template.

The new subnet is added as a property of virtualNetwork.

"subnets": [
                    {
                        "name": "proxysubnet",
                        "properties": {
                            "addressPrefix": "192.168.188.0/24"
                        }
                    },
                    {
                        "name": "secondSubnet",
                        "properties": {
                            "addressPrefix": "192.168.180.0/24"
                        }
                    }
                ],

Save the template and validate it again.

Deploy the Template

Now, let’s deploy the template with CLI.

az group deployment create --resource-group tomlab-kr --template-file .\template.json

If all goes well, you should see the CLI returns the template in JSON.

Check in Azure portal, under the Resource Group –> Deployments.

image

Open Azure Portal and select Virtual networks, click Diagram. We can see the new subnet “secondSubnet” is now added. All existing resources are still intact.

Image

Comments

Popular posts from this blog

Install AWS CLI on WSL Ubuntu

On Premise Mailbox user missing in Exchange Online GAL

Migrate Azure AD Connect Between AD Forests