ARMHelper

Development Status

Production status

Introduction

This module is created to make it easier to work with ARM deployments.

You are at this point able to:

• Get detailed errormessages when Azure gives general errors
• Get an overview of all the resources that would get deployed
• Check if resources that you want to deploy already exist and whether they would be overwritten.

For an introduction, please view http://4bes.nl/2019/04/09/armhelper-a-module-to-help-create-arm-templates

For usage in an Azure DevOps pipeline: http://4bes.nl/2019/04/18/build-pipeline-in-azure-devops-for-arm-templates-part-ii-using-armhelper-and-yaml

Common setup

prerequisites

• Access to an Azure subscription
• Have the AzureRM or AZ module installed and a connection ready
• Windows PowerShell or PowerShell Core. MacOS and Linux are tested in the pipeline, but could have issues. Please let me know if you run in to one

Installation

Install ARMHelper from the PowerShell Gallery:

Install-Module -Name ARMHelper -Scope CurrentUser
Import-Module ARMHelper

Examples

Get a detailed output for a general error

C:\> Get-ARMDeploymentErrorMessage -ResourceGroupName ARMTest -TemplateFile .\azuredeploy.json -TemplateParameterFile .\azuredeploy.parameters.json

the output is a generic error message. The log is searched for a more clear errormessage
General Error. Find info below:
ErrorCode: AccountNameInvalid
Errormessage: arm-aqkc32cvb2qmmw is not a valid storage account name. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Get an overview of the new resources that would be deployed

C:\> Test-ARMDeploymentResource -ResourceGroupName ARMTest -TemplateFile .\azuredeploy.json -TemplateParameterFile .\azuredeploy.parameters.json

Mode for deployment is Incremental
The following Resources will be deployed:


 Resource: storageAccounts

Name        : armaqkc32cvb2qmmw
Type        : Microsoft.Storage/storageAccounts
ID          : /subscriptions/12345678-abcd-1234-1234-12345678/resourceGroups/armtesting/providers/Microsoft.Storage/storageAccounts/armaqkc32cvb2qmmw
Location    : westeurope
accountType : Standard_LRS
apiVersion  : 2015-06-15
ARMcreated  : True
displayName : armaqkc32cvb2qmmw

Test if a Resource exists already

C:\> Test-ARMExistingResource -ResourceGroupName armtesting -TemplateFile .\azuredeploy.json -TemplateParameterFile .\azuredeploy.parameters.json

Mode for deployment is Incremental
The following resources do not exist and will be created
armaqkc32cvb2qmmw

C:\> Test-ARMExistingResource -ResourceGroupName armtesting -TemplateFile .\azuredeploy.json -TemplateParameterFile .\azuredeploy.parameters.json

Mode for deployment is Incremental
The following resources exist. Mode is set to incremental. New properties might be added
armaqkc32cvb2qmmw

See Docs-folder for more documentation. (Generated with PlatyPS )

Change Log

View Change log here

To Contribute

Any ideas or contributions are welcome! Please add an issue with your suggestions.

Known Issues

View known issues here