Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axa-group/arm-template-merge
Azure Resource Manager (ARM) templates merging tool
https://github.com/axa-group/arm-template-merge
arm azure azure-resource-manager cli hacktoberfest merge template
Last synced: 2 months ago
JSON representation
Azure Resource Manager (ARM) templates merging tool
- Host: GitHub
- URL: https://github.com/axa-group/arm-template-merge
- Owner: axa-group
- License: mit
- Created: 2018-08-17T07:09:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T02:47:50.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T02:19:32.881Z (3 months ago)
- Topics: arm, azure, azure-resource-manager, cli, hacktoberfest, merge, template
- Language: JavaScript
- Homepage:
- Size: 380 KB
- Stars: 12
- Watchers: 8
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# `arm-template-merge`
[](https://www.npmjs.com/package/arm-template-merge)
[](https://nodejs.org/)
> _Azure Resource Manager (ARM) Template Merge_
This tool merges multiple [Azure Resource Manager (ARM) template](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-authoring-templates) files into a single template file.
Although [linked templates](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-linked-templates) may be used for combining multiple resources into a single deployment, they have some drawbacks:
- All linked templates must be accessible via a public URL so Azure Resource Manager can reach them during deployment, which may not be possible or cumbersome on some scenarios.
- Each linked template is resolved as a separate deployment, which may not be desired.
- Only the [incremental deployment mode](https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-modes) is allowed for linked templates.
## Prerequisites
- [Node.js 12.0+](https://nodejs.org/)
## How to use
Install the CLI globally:
```shell
npm install -g arm-template-merge
```
Then run `arm-template-merge` without any arguments for details on its utilization.
Alternatively, you can execute the CLI without installing it by running:
```shell
npx arm-template-merge
```
### Adding it as a dependency
You may add it to your project as a dependency:
```shell
npm install arm-template-merge
```
And use the merge functionality from your code:
```javascript
const fs = require('fs');
const mergeARMTemplates = require('arm-template-merge');
let template1 = JSON.parse(fs.readFileSync('template1.json', 'utf8'));
let template2 = JSON.parse(fs.readFileSync('template2.json', 'utf8'));
let merged = {};
merged = mergeARMTemplates(merged, template1);
merged = mergeARMTemplates(merged, template2);
fs.writeFileSync('merged-template.json', JSON.stringify(merged), 'utf8');
```
## Rules
The following rules are used for merging ARM template files:
- All files MUST share the same exact values for the following fields:
- `$schema`
- `contentVersion`
- `apiProfile` (if present)
- All files' `functions` and `resources` collections will each be combined into a single collection. Objects within a collection that are exact copies will yield a single object in the merged collection:
```text
[ | [ | [
{ }, --|-------------------------|--> { },
| { }, --|--> { },
{ }, | { }, | { }
] | ] | ]
```
- All files' `parameters`, `variables` and `outputs` objects will each be combined into a single object. Files declaring the same key within an object MUST have the same exact value, or an error will be thrown:
```text
{ | { | {
"A": , --|-------------------------|--> "A": ,
| "B": , --|--> "B": ,
"C": , | "C": , | "C":
"D": | "D": | <<< ERROR >>>
} | } | }
```
- Value and object equality follows Node.js' [`assert.deepStrictEqual()`](https://nodejs.org/api/assert.html#assert_assert_deepstrictequal_actual_expected_message) rules.