Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unstoppablemango/imaug-2022-bicep


https://github.com/unstoppablemango/imaug-2022-bicep

Last synced: 1 day ago
JSON representation

Awesome Lists containing this project

README 

        
# Iowa Microsoft Azure User Group - Bicep Talk



Infrastructure as code with Bicep and migrating from ARM.



This talk assumes a loose knowledge of Azure Resource Manager (ARM) templates and Infrastructure as Code (IaC).



## What is Bicep?



Bicep is a domain-specific language (DSL) that uses declarative syntax to deploy Azure resources.



## Tooling



The Bicep CLI is the primary driver for working with `.bicep` files.

It can be installed multiple ways, but if you already have the Azure CLI you can install bicep from there.



```shell

az bicep install

```



More installation options can be found in the [docs](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/install).



To get the best development experience, use [VSCode](https://code.visualstudio.com/) and install the [Bicep extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep).

This will enable syntax highlighting, intellisense, navigation, and linting all in the editor.



## 01 Bicep



Basic syntax and usage.



Parameters



```bicep

param name string = 'imaug-01'

```



Variables



```bicep

var appName = 'app-imaug-01'

```



Resources



```bicep

resource app 'Microsoft.Web/sites@2021-03-01' = {

    // ...

}

```



Strings



```bicep

var appName = 'app-${name}'

```



Functions



```bicep

param location string = resourceGroup().location

```



Outputs



```bicep

output appUrl string = myApp.properties.defaultHostName

```



## 02 Conditionals



`if` statements



```bicep

resource app 'Microsoft.Web/sites@2021-03-01' if (shouldDeploy) {

    // ...

}

```



Ternaries



```bicep

var name = location == 'eastus2' ? 'in-the-east' : 'not-in-the-east'

```



## 03 Loops



Arrays



```bicep

var numArray = [

    1

    2

    3

]

```



Resource loop



```bicep

resource accounts 'Microsoft.Storage/storageAccounts@2021-08-01' = [for i in numArray: {

    // ...

}]

```



Using resource arrays



```bicep

var accountNames = [for i in numArray: accounts[i].name]

```



## 04 Modules



Modules



```bicep

module keyVaultDeployment 'key-vault.bicep' = {

    // ...

}

```



Module outputs



```bicep

// key-vault.bicep

output uri string = vault.properties.vaultUri



// azuredeploy.bicep

var vaultUri = keyVaultDeployment.outputs.uri

```



More recently, bicep has introduced the concept of registries.

I won't go in depth on them for this talk, but more info can be found in the link below.



## 05 Linting



Bicep comes with a linter and can be used with `bicep build` or the [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep).

The default rules at the time of writing are taken from [arm-ttk test cases](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-test-cases).



## 06 Migrating from ARM



If you have an existing ARM template, the easiest way to get started migrating to Bicep is using `bicep decompile` on your template.

This will generate a `.bicep` file based on your ARM template.

It's not a perfect representation, and will more than likely require modification before it can be used a replacemnt, but it's a great starting point especially when you have a large number of resources.



## Using this repo



This repo is primarily used for presenting, but you can deploy the samples if you like.

Change the name in [rg-name.txt](/rg-name.txt) to the name of your resource group.



Most directories contain a reference bicep file, and an empty azuredeploy bicep file.

The `azuredeploy.bicep` file will be used while presenting, with the reference file available in case I screw something up (but can also be deployed).



Each directory also contains a set of helper scripts to setup and tear down resources.

These point at the empty `azuredeploy.bicep` files by default.

You can either point them at the `reference.bicep` file, or update `azuredeploy.bicep`.



As always, be sure to verify the contents of the scripts yourself before executing anything!