With ARM GitHub Action, you can automate your workflow to deploy ARM templates and manage Azure resources.

• resourcegroup – Required
• templateLocation – Required Either the local template location or the template URI must be provided
• parameters – Optional
• deploymentName – Optional Specifies the name of the resource group deployment to create.
• deploymentMode – Optional Incremental (only add resources to resource group) or Complete (remove extra resources from resource group) or Validate. Default: Incremental.

• Azure Login – Required Login with your Azure credentials
• Checkout – Required To execute the scripts present in your repository

# File: .github/workflows/workflow.yml

on: [push]

name: AzureARMSample

jobs:

  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    
    - name: Azure Login
      uses: azure/login@v1
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
    
    - name: Checkout
      uses: actions/checkout@v1
      
    - name: Azure ARM Deployment
      uses: azure/ARM@v1
      with:
       resourceGroupName: github-action-arm-rg
       template-file: ./azuredeploy.json
       parameters: storageAccountType=Standard_LRS

• GITHUB_WORKSPACE is the environment variable provided by GitHub which represents the root of your repository.

Every template output will be exported as output.

To use any credentials like Azure Service Principal,add them as secrets in the GitHub repository and then use them in the workflow.

Follow the steps to configure the secret:

• Define a new secret under your repository settings, Add secret menu
• Store the output of the below az cli command as the value of secret variable 'AZURE_CREDENTIALS'

   az ad sp create-for-rbac --name "myApp" --role contributor \
                            --scopes /subscriptions/{subscription-id}/resourceGroups/{resource-group} \
                            --sdk-auth
                            
  # Replace {subscription-id}, {resource-group} with the subscription, resource group details

  # The command should output a JSON object similar to this:

  {
    "clientId": "<GUID>",
    "clientSecret": "<GUID>",
    "subscriptionId": "<GUID>",
    "tenantId": "<GUID>",
    (...)
  }
  

• Now in the workflow file in your branch: .github/workflows/workflow.yml replace the secret in Azure login action with your secret (Refer to the example above)

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.