Chef knife plug-in for Microsoft Azure
Latest commit 2eb998f Oct 14, 2016 @jjasghar jjasghar committed on GitHub Merge pull request #407 from chef/contributing2
Move contributing doc to unified location

Knife Azure

Gem Version Build Status


A knife plugin to create, delete, and enumerate Microsoft Azure resources to be managed by Chef.

NOTE: You may also want to consider using the azure-xplat-cli, this application is written by the Azure team and has many other integrations with Azure. If click here you'll see deeper examples of using the Chef extension and Azure.


Be sure you are running the latest version of Chef DK, which can be installed via:

This plugin is distributed as a Ruby Gem. To install it, run:

chef gem install knife-azure

Depending on your system's configuration, you may need to run this command with root/administrator privileges.


knife-azure 1.6.0 onwards, we are adding support for Azure Resource Manager. You can easily switch between the

  • Service management: commands using the Azure service management API
  • Resource manager: commands using the Azure Resource Manager API

They are not designed to work together. Commands starting with knife azure use ASM mode, while commands starting with knife azurerm use ARM mode.

PLEASE NOTE that Azuererm subcommands are experimental and of alpha quality. Not suitable for production use. Please use ASM subcommands for production.


  1. ASM Configuration
  2. ARM Configuration

Detailed Usage

  1. ASM Mode
  2. ARM Mode

Bootstrap existing VM to install the chef-client using chef-extension :

We have added a utility in ASM and ARM to bootstrap existing VM. This will install the chef-client using chef extension on your VM.

  1. Bootstrap Doc for ASM Mode
  2. Bootstrap Doc for ARM Mode


For information on contributing to this project see


Copyright:: Copyright (c) 2012-2016 Chef Software, Inc.

License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.