TheModin/template-building-blocks

A tool for deploying Azure infrastructure based on proven practices. Azure building blocks take advantage of the Azure CLI and Azure Resource Manager templates to provision collections of resources as logical units with production-ready settings.

           _     _     
          | |   | |    
  __ _ ___| |__ | |__  
 / _` |_  / '_ \| '_ \ 
| (_| |/ /| |_) | |_) |
 \__,_/___|_.__/|_.__/ 

Version 2.0.4 was published 11/27/2017 to address a few minor bugs, and implement a more robust versioning scheme. Customers using earlier versions will see breaking changes in our next releases. To avoid future breaking changes, upgrade to v2.0.4 now. Follow the steps in Getting Started below to upgrade to v2.0.4.

Azure Building Blocks: Simplifying Resource Deployment

The Azure Building Blocks project is a command line tool and set of Azure Resource Manager templates designed to simplify deployment of Azure resources. Users author a set of simplified parameters to specify settings for Azure resources, and the command line tool merges these parameters with best practice defaults to produce a set of final parameter files that can be deployed with the Azure Resource Manager templates.

Getting Started

Install the Azure Building Blocks using npm:

npm install -g @mspnp/azure-building-blocks

Verify the version of azure building blocks you are running using the command below. Make sure you are running version 2.0.4 or later.

azbb -V

Then, author an Azure Building Blocks parameter file and run the azbb command line tool.

Documentation

Full documentation for the command line tool and parameter file schema is available on the Wiki.

Examples

Azure Building Blocks parameters to deploy three identical VMs:

"type": "VirtualMachine",
"settings": {
    "vmCount": 3,
    "osType": "windows",
    "namePrefix": "test",
    "adminPassword": "testPassw0rd!23",
    "nics": [{"subnetName": "web"}],
    "virtualNetwork": {"name": "ra-vnet"}
}

The command line tool merges best practice defaults to the parameters as follows:

• Enables diagnostics on all VMs
• Deploys the VMs in an availability set
• All VM disks are managed
• OS is latest Windows Server 2016 image
• Public IP created for each VM

To add a load balancer in front of the three identical VMs:

"type": "VirtualMachine",
"settings": {
    "vmCount": 3,
    "osType": "windows",
    "namePrefix": "test",
    "adminPassword": "testPassw0rd!23",
    "nics": [{
        "subnetName": "web",
        "isPublic": false,
        "backendPoolsNames": ["bp1"]
        }],
    "virtualNetwork": {"name": "ra-vnet"},
    "loadBalancerSettings": {
        "backendPools": [{"name": "bp1"}]
    }
}

License

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.