Deploys a directory to an Azure website.

gruntplugin, azure, deployment
npm install grunt-azure-deploy@1.0.2



A grunt wrapper for the node package azure-deploy, which deploys a directory to an Azure WebSite using git integration.

For the latest documentation, visit the official Github repository.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-azure-deploy --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:



In your project's Gruntfile, add a section named azureDeploy to the data object passed into grunt.initConfig().

  azureDeploy: {
    options: {
      credential_file: process.env['HOME']+'/.azure/creds.json' // the location and name of your Azure credentials stored as JSON
    directory: './build', // the directory of data you wish to deploy
    website_name: 'testWebsite' // your Azure Website name



Type: String Default value: '.azure_deploy.json'

A string value that is used to specify the location of the Azure deployment credentials file. File should be formatted as JSON.

Enable Deployment in the Azure Portal

  1. Log in to the Azure Portal.
  2. In your App Service app's blade, click Settings > Deployment source. Click Choose source, then click Local Git Repository, and then click OK.
  3. If this is your first time setting up a repository in Azure, you need to create login credentials for it under Settings > Deployment credentials.

Managing Azure Credentials

Add your Azure WebSite deployment credentials to a separate JSON file. For security reasons, make sure this file is outside of or ignored by source control!

  "username": "testUser",
  "password": "testPassword123"


In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)