DEV Community: Ángel Pérez

ARM Template Specs now GA!

Ángel Pérez — Thu, 06 May 2021 17:08:55 +0000

TL;DR – Template Specs is a new resource type for storing ARM templates in your resource groups for faster sharing, deployment, and role-based access control (RBAC) on those Templates shared within an organization. Template Specs addresses today's biggest challenges around ARM template management, storage, and access.

The Problem: Sharing ARM templates across an organization is challenging, requiring more management steps of the external or internal storage from which they are shared.

Sharing: ensuring the right teams within your organization have access becomes very tedious as you cannot leverage Azure RBAC on the ARM templates you want to share.
Management: providing teams with the latest ARM templates in a consistent and versioned way.

Why Template Specs?

As a native solution, Template Specs will enable users to bring all their ARM templates to Azure as a resource and securely store and share them within an Azure tenant.

The Solution: 1st Party secure storage and management of ARM templates within Azure.

Sharing: Who can access a Template Spec can be defined using Azure RBAC.
Management: Template Specs can be versioned within the same resource, ensuring users can always access the latest iterations of an ARM template (or templates) stored in a Template Spec.

What's New Since Public Preview?

New API version 2021-05-01. Thanks to all the customer feedback during our public preview, we were able to close 3 issues, fix 5 bugs, and make the decision to change the names of the template and artifacts properties:

What's Coming Soon Post-GA?

Bicep integration: az ts create with bicep files.
Built-in template specs support.
Support for UI Forms – UI Forms will replace createUIDefinition going forward.
GA version of Azure CLI and PowerShell with breaking changes being released by end of May.
- Due to the property renames highlighted above, you will see new property names when you GET a Template Spec version. This could be a breaking change if you are dependent on querying these properties in a script. This will not change how Template Specs are created or updated when using Azure Portal, Azure CLI, and PowerShell, but it will change how they are created via REST/ARM Templates/Bicep.
- If you’d like to test the latest Az PowerShell cmdlets early, they are available in PowerShell Gallery

Template Spec Reference and Docs:

Note: Template Specs can be created with an ARM template, but we strongly recommend using Portal, PowerShell or CLI for creating Template Specs. Microsoft.Resources/templateSpecs/versions - ARM template reference | Microsoft Docs

Creating and Deploying a Template Spec Resource

A Template Spec is a resource that contains an array of Template Spec versions which consists of a root template and any number of linked templates. A Template Spec can be created using the Portal, PowerShell, Azure CLI, REST API, or ARM Template. To help visualize a Template Spec create, here are some examples of what it would look like in the Azure CLI:

Creating a Template Spec using Azure CLI
To create a Template Spec, use the az ts create command to package an ARM into the Template Spec resource.

az ts create --name webAppSpec --version "v1.0" --resource-group rgName --location "westus2" --template-file "azuredeploy.json"

Required properties:

--name: The name for the Template Spec resource.
--version: The version number or name of the version being + created.
--location: The Azure region for the Template Spec resource.
--template-file: The ARM template to be packaged into a template spec.

Creating and Deploying a Template Spec with Linked Templates using Azure CLI
To create a Template Spec with artifacts inside it, we need the following:

Create main template (e.g. azuredeploy.json) that deploys linked templates, to be passed into the az ts create command as a template file.
Create N number of deployment resources with linked templates referenced using the relativePath property within the templateLink object.

In this example the linked templates are stored in a subfolder called linkedTemplates, which is in the same path as the main template file. The relativePath property is relative to the template file where relativePath is declared. The relativePath property can take any of the following values:
./linkedTemplates/storagelinkedTemplate.json
/linkedTemplates/storagelinkedTemplate.json
linkedTemplates/storagelinkedTemplate.json
Note: relativePath can also be used deploy remote linked templates given all template files are staged together and available via remote URI, such as GitHub or Azure storage. The main template is called by using URI and all linked templates referenced as relative to that main template will have a URI constructed using the main template URI and the relativePath specified. This feature requires api version 2020-10-01 or greater. To learn more about this feature, please refer to Link templates for deployment - Microsoft Docs.
Run the az ts create command to create or update a template spec version. This command packages the linked templates added via templateLink as linked templates in your Template Spec version.
az ts create --name webAppSpec --version "v1.0" --resource-group rgName --location "westus2" --template-file "azuredeploy.json"
This command packages the template file azuredeploy.json into the main template of the Template Spec version webAppSpec-v1.0 and all linked templates specified into the linkedTemplates[] array of the Template Spec object.
Deploy the Template Spec by passing in its resource ID using the az deployment group create command. First, we need to get the ID of the Template Spec resource created, and this can be done easily in the Azure CLI by using the az ts show command:
id=$(az ts show --name webAppSpec --version "v1.0" --resource-group rgName --query "id")
After storing the resource ID of the template spec into a variable, run the command az deployment group create and pass in the variable to the --template-spec input parameter:
az deployment group create --resource-group rgName --template-spec $id
Verify the contents of a Template Spec by running the az ts export command that downloads a specified Template Spec version into an --output-folder in your local file system.
az ts export --output-folder "C:\\exported-template-specs" -s "template-spec-version-ID"
This command exports the specified Template Spec’s main template (e.g. webAppSpec.JSON) and an artifacts folder with all of its corresponding linked templates.

The contents of a Template Spec version can also be seen using the Azure Portal.

Deploying a Template Spec as Linked Template using ARM Template with ID Reference

A Template Spec resource can also be referenced using the templateLink property and specifying the id of the template spec:

Template Specs in National Clouds
Please note that Template Specs is not yet GA in National Clouds. The target GA date for National Clouds is end of July.

References and Docs

ARM Template Specs now Public Preview!

Ángel Pérez — Thu, 28 Jan 2021 00:36:34 +0000

The Problem: Sharing ARM templates across an organization is challenging, requiring more management steps of the external or internal storage from which they are shared.

Sharing: ensuring the right teams within your organization have access becomes very tedious as you cannot leverage Azure RBAC on the ARM templates you want to share.
Management: providing teams with the latest ARM templates in a consistent and versioned way.

Why Template Specs?

As a native solution, Template Specs will enable users to bring all their ARM templates to Azure as a resource and securely store and share them within an Azure tenant.

The Solution: 1st Party secure storage and management of ARM templates within Azure.

Sharing: Who can access a Template Spec can be defined using Azure RBAC.
Management: Template Specs can be versioned within the same resource, ensuring users can always access the latest iterations of an ARM template (or templates) stored in a Template Spec.

Template Spec Reference and Docs:

Note: Below references show how Template Specs can be created with an ARM template, but we strongly recommend using Portal, PowerShell or CLI for creating Template Specs.

Creating and Deploying a Template Spec Resource

Creating a Template Spec using Azure CLI
To create a Template Spec, use the az ts create command to package an ARM into the Template Spec resource.

az ts create --name webAppSpec --version "1.0" --resource-group rgName --location "westus2" --template-file "azuredeploy.json"

Required properties:

--name: The name for the Template Spec resource.
--version: The version number or name of the version being + created.
--location: The Azure region for the Template Spec resource.
--template-file: The ARM template to be packaged into a template spec.

Creating and Deploying a Template Spec with Linked Templates using Azure CLI
To create a Template Spec with artifacts inside it, we need the following:

Create main template (e.g. azuredeploy.json) that deploys linked templates, to be passed into the az ts create command as a template file.
Create N number of deployment resources with linked templates referenced using the relativePath property within the templateLink object.

In this example the linked templates are stored in a subfolder called artifacts, which is in the same path as the main template file. The relativePath property is relative to the template file where relativePath is declared. The relativePath property can take any of the following values:
./artifacts/storagelinkedTemplate.json
/artifacts/storagelinkedTemplate.json
artifacts/storagelinkedTemplate.json
Note: relativePath can also be used deploy remote linked templates given all template files are staged together and available via remote URI, such as GitHub or Azure storage. The main template is called by using URI and all linked templates referenced as relative to that main template will have a URI constructed using the main template URI and the relativePath specified. This feature requires api version 2020-10-01 or greater. To learn more about this feature, please refer to Link templates for deployment - Microsoft Docs.
Run the az ts create command to create or update a template spec version. This command packages the linked templates added via templateLink as artifacts in your Template Spec version.
az ts create --name webAppSpec --version "1.0" --resource-group rgName --location "westus2" --template-file "azuredeploy.json"
This command packages the template file azuredeploy.json into the main template of the Template Spec version webAppSpec-1.0 and all linked templates specified into the artifacts[] array of the Template Spec object.
Deploy the Template Spec by passing in its resource ID using the az deployment group create command. First, we need to get the ID of the Template Spec resource created, and this can be done easily in the Azure CLI by using the az ts show command:
id=$(az ts show --name webAppSpec --version "1.0" --resource-group rgName --query "id")
After storing the resource ID of the template spec into a variable, run the command az deployment group create and pass in the variable to the --template-spec input parameter:
az deployment group create --resource-group rgName --template-spec $id
Verify the contents of a Template Spec by running the az ts export command that downloads a specified Template Spec version into an --output-folder in your local file system.
az ts export --output-folder "C:\\exported-template-specs" -s "template-spec-version-ID"
This command exports the specified Template Spec’s main template (e.g. webAppSpec.JSON) and an artifacts folder with all of its corresponding template artifacts. The contents of a Template Spec version can also be seen using the Azure Portal.

Deploying a Template Spec as Linked Template using ARM Template with ID Reference

A Template Spec resource can also be referenced using the templateLink property and specifying the id of the template spec:

References and Docs

We look forward to feedback and seeing you succeed on Azure with ARM Template Specs. Please feel free to reach out with any questions on Twitter or GitHub.

Learn to manage Azure resources using ARM templates, with these 6 LEARN modules

Ángel Pérez — Fri, 11 Dec 2020 19:35:13 +0000

Today more and more businesses are moving their workloads to the cloud. To achieve this, a variety of career disciplines come together to create products that are reliable and that can be deployed in an easily repeatable manner.

Let’s take an e-commerce company as an example. A developer might work on some front-end and back-end components, whereas a DevOps engineer might focus more on the integration and delivery setup of the entire app, and the Cloud Architect and Project Manager work on the architecture layout for development and production environments.

Consistent and repeatable deployments require extensive communication across teams.

Consistent and repeatable deployments require extensive communication across teams when using a REST API or other imperative clients to create and update the resources in each deployment. A failure in clear communication can lead to a divergence in an environment configuration.

To solve the divergence problem, businesses make use of Infrastructure-as-Code (IaC), which enables teams to describe their cloud environments into text files using a declarative syntax. Azure Resource Manager (ARM) is the name of Azure’s cloud native declarative syntax and the files used to describe a cloud resource (or resources) is called an ARM template. Using ARM templates provides some key benefits:

Centralized Resource Configurations: Rather than having different cloud resource configurations stored in each different team’s source control, requiring constant sharing, DevOps, Cloud Architects, and Developers teams can store their latest cloud resource configurations into the ARM templates that are used to describe that resource.
Reliable and Repeatable Deployments: By describing your cloud resource configurations into an ARM template, anyone with access to that template can deploy and get the exact same cloud resource.
Simplified Resource Management: Before IaC, users had to use GUIs and other clients to view and manage their resources, making it easier for teams to lose track of what resources they have and how they are configured. By using ARM templates, teams have a better picture of what resources are present and how they are setup.
Managed Orchestration: Ensuring the correct order of operations occur on deployment is complex. Azure Resource Manage takes care of that for you by orchestrating the deployment of interdependent resources so that they get created in the right order. When possible, ARM deploys resources in parallel to finish deployments faster. By using ARM templates, you deploy the template through one command, instead of through multiple imperative commands.

ARM Template Learn Path

The ARM Template Learning Path provides you with a FREE Azure sandbox environment to test out ARM template concepts, features and best practices. This learn path is designed for beginner to advanced users, looking to learn about ARM templates with scenarios that build on top of each other. The ARM template learn path consists of the following modules:

Module 1: Deploy Azure infrastructure by using ARM templates

This module will teach you how to author your own ARM template using Visual Studio Code. You will learn how to declare resources and customize your ARM template by adding multiple resources, parameters, and outputs.

Module 2: Deploy to multiple Azure environments by using ARM template features

In this module you will learn how to use ARM template language expressions to generate unique values and how to reuse the expression used by storing it into a variable. This module will also cover the basics in how to use tags to organize your resources and how to separate parameters into its own file.

Module 3: Preview changes and validate Azure resources by using what-if and the ARM template test toolkit

In this module you will learn how to preview changes to your ARM template before deploying them by using the what-if capability, enabling you identify any creation, update, or deletion of resources before deploying those changes. You will also learn how to validate your ARM template using the ARM template test toolkit.

Module 4: Automate the deployment of ARM templates by using GitHub Actions

This module walks through the different ways ARM templates can be deployed based on your needs and automate the deployment using GitHub actions (CI/CD). Lastly, you will learn how to break down complex templates into multiple smaller linked templates.

Module 5: Extend ARM templates by using deployment scripts

In this module you will learn how to setup custom steps in your ARM template by using deployment scripts to integrate with external systems.

Module 6: Manage complex cloud deployments by using advanced ARM template features

This module walks through how to use more advanced ARM template features like the dependsOn, copy, and condition constructs, for managing secrets in conditional deployments.