--- title: "Azure Runbooks: Your Complete Guide to Automated Solutions" description: "Elevate your automation game with Azure Runbooks: streamline Azure-related tasks efficiently and transform your workflow for maximum productivity." canonical: "https://adamtheautomator.com/azure-runbook/" --- # Azure Runbooks: Your Complete Guide to Automated Solutions > Elevate your automation game with Azure Runbooks: streamline Azure-related tasks efficiently and transform your workflow for maximum productivity. Source: https://adamtheautomator.com/azure-runbook/ --- ATA Learning Tap to hide [ ATA Learning ](/) * [Home](/) * [Tutorials](/tutorials/) * [Instructors](/author/) * [Advertising](/advertising/) * [Recommended Resources](/resources/) * [About Adam](/about-adam/) Search for: * [](https://twitter.com/adbertram) * [](https://github.com/Adam-the-Automator) * [](https://www.linkedin.com/company/adam-the-automator-llc) * [](/feed/) ![Azure Runbooks: Your Complete Guide to Automated Solutions](https://adamtheautomator.com/wp-content/uploads/2022/08/How-to-Automate-with-Microsoft-Azure-RunbooksPractical-Linux-Unix-Tee-Commands-for-the-Linux-Admin-1200-×-675-px.jpg) # Azure Runbooks: Your Complete Guide to Automated Solutions [![](https://secure.gravatar.com/avatar/2788bb1a3f735603f81eca51d68daec56a9d97e805a10268fb2c20afcc76b81b?s=192&d=mm&r=g)Nicholas Xuan Nguyen](https://adamtheautomator.com/author/nicholas-xuan-nguyen/)9 January 202410 min. read Categories: [IT Ops](/category/it-ops/) Tags:[Microsoft Azure](/tag/microsoft-azure/) Table of Contents * [Prerequisites](#prerequisites) * [Creating an Azure Runbook Using the Portal](#creating-an-azure-runbook-using-the-portal) * [Creating an Automation Account](#creating-an-automation-account) * [Creating a PowerShell Runbook](#creating-a-powershell-runbook) * [Editing the Runbook](#editing-the-runbook) * [Testing the Runbook](#testing-the-runbook) * [Creating an Azure Runbook with PowerShell](#creating-an-azure-runbook-with-powershell) * [Creating an Automation Account](#creating-an-automation-account-1) * [Creating a PowerShell Runbook](#creating-a-powershell-runbook-1) * [Adding Code to the Runbook](#adding-code-to-the-runbook) * [Publishing the Runbook](#publishing-the-runbook) * [Starting the Runbook](#starting-the-runbook) * [Automating with Azure Runbook: Stopping Azure VMs on Schedule](#automating-with-azure-runbook-stopping-azure-vms-on-schedule) * [Importing an Azure Runbook from the Gallery](#importing-an-azure-runbook-from-the-gallery) * [Creating the ‘Run As Account’](#creating-the-run-as-account) * [Adding a Schedule](#adding-a-schedule) * [Running a Final Test](#running-a-final-test) * [Conclusion](#conclusion) Automation is crucial in the modern world of IT. Automation tools like Microsoft Azure Runbooks can help do tasks faster and more efficiently. Although the learning curve may be steep for some, especially for those new to Azure, the payoff is beneficial in the long run. Not a reader? Watch this related video tutorial! **_Not seeing the video? Make sure your ad blocker is disabled._** This tutorial will show you how to create and run a Microsoft Azure Runbook. You’ll also learn a typical real-world use case example of using an Azure runbook in your Azure environment. So keep reading and learn something new today! ## Prerequisites This tutorial will be a hands-on demonstration. If you’d like to follow along, be sure you have * An Azure account with an active subscription. If you don’t have an Azure subscription, [create a free account](https://azure.microsoft.com/en-us/free/) before you begin. Related:[Get Microsoft Azure Free: Your Goto Guide](https://adamtheautomator.com/azure-free/) * The [latest PowerShell version](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2) for your operating system. This tutorial uses PowerShell 7.2.5 on Windows 10. * The latest [Az PowerShell module](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps?view=azps-8.2.0) must be installed on your computer. This tutorial will use the Azure PowerShell module version 8.1.0. * A code editor, such as [Visual Studio Code](https://code.visualstudio.com/). ## Creating an Azure Runbook Using the Portal Whether you’re a new or seasoned user, the Azure Portal is the quickest way to create Azure Runbooks. This section will teach you how to create, edit, test, publish, and execute an Azure Runbook in the Azure Portal. ### Creating an Automation Account The primary requirement of a runbook is the automation account. An automation account is a container for your automation resources, like the modules, credentials, variables, and the runbook itself. Follow the below steps to create a new Automation account in the Azure Portal. 1\. Sign in to the [Azure Portal](https://portal.azure.com/#home) using your preferred web browser. 2\. Click the Create Resource → IT & Management Tools → Automation (create). ![Creating a new automation account](https://adamtheautomator.com/wp-content/uploads/2022/08/image-135.png) Creating a new automation account 3\. On the Create an Automation Account page, fill out the form under the Basics tab. Select the Subscription in which you wish to create the automation account. Click the Create new link under the Resource group box. Type the name for the new resource group and click OK. This example automation account’s name is _aa-rg-portal._ > _Note: Creating a new resource group is optional. Alternatively, you can select an existing resource group from the drop-down._ ![Selecting the subscription and creating a new resource group.](https://adamtheautomator.com/wp-content/uploads/2022/08/image-136.png) Selecting the subscription and creating a new resource group. 4\. Next, enter the Automation account name and select the Region. Typically, you would choose a region that’s geographically optimal to your location. In this example, the automation account name is _ata-automation-account,_ and the location is _East US_. Click the Review+Create button once you’ve completed the details. ![Configuring the automation account details](https://adamtheautomator.com/wp-content/uploads/2022/08/image-137.png) Configuring the automation account details 5\. The page validates your automation account details. If you see the message Validation passed, click the Create button to initiate the automation account creation. ![Reviewing and Creating the automation account](https://adamtheautomator.com/wp-content/uploads/2022/08/image-138.png) Reviewing and Creating the automation account After the automation account deployment, you’ll see a confirmation message similar to the screenshot below. ![Automation account deployment confirmation](https://adamtheautomator.com/wp-content/uploads/2022/08/image-139.png) Automation account deployment confirmation ### Creating a PowerShell Runbook You now have an automation account and can start creating an Azure Runbook in it. Follow the below steps to create a new runbook in the Azure Portal. 1\. Navigate back to the [Automation accounts blade](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.Automation%2FAutomationAccounts) and click on the name of your Automation account. ![Opening the automation account page](https://adamtheautomator.com/wp-content/uploads/2022/08/image-140.png) Opening the automation account page 2\. Under the Process Automation section, click Runbooks and the Create a runbook button near the top of the page. ![Clicking the Create a runbook button](https://adamtheautomator.com/wp-content/uploads/2022/08/image-141.png) Clicking the Create a runbook button 3\. On the Create a runbook page, fill out the runbook Name and choose the Azure Runbook type and Runtime version. This example will create a new [Graphical PowerShell](https://docs.microsoft.com/en-us/azure/automation/automation-runbook-types#graphical-runbooks) runbook called _azure-runbook-01_ based on Windows PowerShell _5.1_ runtime. > _The Graphical PowerShell runbook type means you are creating a PowerShell Runbook that you can only edit using the Automation graphical editor._ > > _Refer to the_ [_Azure Automation runbook types_](https://docs.microsoft.com/en-us/azure/automation/automation-runbook-types) _documentation to know more about the different runbook types._ After filling out the runbook information, click Create. ![Configuring and creating a new Azure runbook](https://adamtheautomator.com/wp-content/uploads/2022/08/image-142.png) Configuring and creating a new Azure runbook The graphical editor automatically opens the runbook for editing, as you can see below. The graphical editor has three panes: Library, Canvas, and Configuration. ![The Azure runbook graphical editor](https://adamtheautomator.com/wp-content/uploads/2022/08/image-143.png) The Azure runbook graphical editor ### Editing the Runbook You’ve created an empty runbook. Your next task is to edit the runbook to make it do something. In this example, you’ll modify the runbook to perform a simple logic_:_ output the message _Hello Wold_ using the Write-Output cmdlet. 1\. First, add the Write-Output cmdlet to the canvass. Type _Write-Output_ on the library pane’s search box to quickly do so. Once you see Write-Output under the CMDLETS tree, click the ellipsis (…) → Add to canvas. As you can see below, the Write-Output cmdlet is now inside the canvas. At this point, the Write-Output object you see on the canvass is called an _activity_. ![Adding a cmdlet to the canvas](https://adamtheautomator.com/wp-content/uploads/2022/08/image-144.png) Adding a cmdlet to the canvas 2\. On the Configuration pane, change the activity label to Display Hello World. Next, click on Parameters. ![Changing the label](https://adamtheautomator.com/wp-content/uploads/2022/08/image-145.png) Changing the label 3\. On the next page, you’ll see the list of the Write-Output cmdlet parameters. In this example, click the mandatory parameter INPUTOBJECT. ![Click the mandatory parameter](https://adamtheautomator.com/wp-content/uploads/2022/08/image-146.png) Click the mandatory parameter 4\. Now, choose the data source for the INPUTOBJECT parameter. Select the PowerShell expression option from the Data source drop-down in this example. In the Expression box, type the “Hello World” expression (including the quotes), and click OK. ![Selecting the parameter value](https://adamtheautomator.com/wp-content/uploads/2022/08/image-147.png) Selecting the parameter value 5\. On the Activity Parameter Configuration, you’ll see that the INPUTOBJECT now has a checkmark indicating that you’ve already added the mandatory parameters. Click OK. ![Click OK on the parameter configuration](https://adamtheautomator.com/wp-content/uploads/2022/08/image-148.png) Click OK on the parameter configuration ### Testing the Runbook You’ve created and configured a runbook, but does it work? To find out, the editor has a test pane where you can safely execute the runbook for testing. 1\. Click Test Pane at the top of the canvass. ![Click Test Pane at the top of the screen to open the Test Pane](https://adamtheautomator.com/wp-content/uploads/2022/08/image-149.png) Click Test Pane at the top of the screen to open the Test Pane 2\. Once the Test pane is open, click Start to run the runbook. > _Note: Performing a runbook testing in the test pane automatically saves the current runbook._ ![Running a runbook test](https://adamtheautomator.com/wp-content/uploads/2022/08/image-150.png) Running a runbook test 3\. Wait for the test execution until you see the Completed message. The output pane shows the expected result: the _Hello World_ message. Close the Test pane to go back to the editor. ![Viewing the runbook test result and closing the test page.](https://adamtheautomator.com/wp-content/uploads/2022/08/image-151.png) Viewing the runbook test result and closing the test page. 4\. When you’ve returned to the editor, click the Publish button → Yes, to publish this runbook version. ![Publishing the runbook](https://adamtheautomator.com/wp-content/uploads/2022/08/image-152.png) Publishing the runbook As a result, the runbook status changes to Published. ![Azure Runbook status](https://adamtheautomator.com/wp-content/uploads/2022/08/image-153.png) Azure Runbook status ## Creating an Azure Runbook with PowerShell You can also create a PowerShell runbook using PowerShell. This section will show you how to create a PowerShell runbook using the Az PowerShell module cmdlets. Related:[What is PowerShell and Why Use It?](https://adamtheautomator.com/what-is-powershell/) ### Creating an Automation Account First, you must create the Automation account that will later contain your runbooks. 1\. Open PowerShell with elevated privileges on your local machine. 2\. [Sign in to Azure PowerShell](https://docs.microsoft.com/en-us/powershell/azure/authenticate-azureps?view=azps-8.2.0) by running the following cmdlet. ```powershell Connect-AzAccount ``` 3\. If you have more than one Azure subscription, run the below command to select the correct subscription to use. ```powershell Get-AzSubscription Select-AzSubscription 'Subscription name or ID' ``` ![Selecting the Azure subscription](https://adamtheautomator.com/wp-content/uploads/2022/08/image-154.png) Selecting the Azure subscription 4\. Next, run the below command to create a resource group. This command creates a resource group with the name aa-rg-poweshell in the eastus region. ```powershell New-AzResourceGroup -Name aa-rg-powershell -Location eastus ``` ![aa-rg-poweshell in the eastus region](https://adamtheautomator.com/wp-content/uploads/2022/08/image-155.png) aa-rg-poweshell in the eastus region 5\. Now that you have a resource group run the below command to create the automation account. This command creates an automation account with the name az-automation-account in the eastus region. ```powershell New-AzAutomationAccount ` -Name 'az-automation-account' ` -Location 'eastus' ` -ResourceGroupName 'aa-rg-powershell' ``` ![az-automation-account](https://adamtheautomator.com/wp-content/uploads/2022/08/image-156.png) az-automation-account ### Creating a PowerShell Runbook To create a new runbook using PowerShell, the New-AzAutomationRunbook cmdlet is your go-to command. Follow these steps to create the runbook. Copy the following code snippet and run it in PowerShell to create a new Azure runbook. This code creates a runbook of type PowerShell named az-automation-runbook in the az-automation-account automation account. ```powershell $params = @{ AutomationAccountName = 'az-automation-account' Name = 'az-automation-runbook' ResourceGroupName = 'aa-rg-powershell' Type = 'PowerShell' } New-AzAutomationRunbook @params ``` Related:[PowerShell Splatting: What is it and How Does it Work?](https://adamtheautomator.com/powershell-splatting/) ![Creating a new Azure runbook in PowerShell](https://adamtheautomator.com/wp-content/uploads/2022/08/image-157.png) Creating a new Azure runbook in PowerShell ### Adding Code to the Runbook You have successfully created a PowerShell runbook with PowerShell, but it doesn’t have any code. This section will teach you how to add code to the PowerShell runbook. Related:[What You Need to Know about Visual Studio Code: A Tutorial](https://adamtheautomator.com/visual-studio-code-tutorial/) 1\. Open your code editor and create a new file called HelloWorld.ps1. 2\. Copy and paste the following code into the code editor and save the file afterward. ```powershell Write-Output -InputObject "Hello PowerShell" ``` ![HelloWorld.ps1.](https://adamtheautomator.com/wp-content/uploads/2022/08/image-158.png) HelloWorld.ps1. 3\. Now, import the PowerShell code into your Azure runbook by running the Import-AzAutomationRunbook command below. The command imports the code in HelloWorld.ps1 into the az-automation-runbook runbook. The -Force parameter overwrites the existing runbook with the same name. ```powershell Import-AzAutomationRunbook ` -ResourceGroupName aa-rg-powershell ` -AutomationAccountName az-automation-account ` -Path .\HelloWorld.ps1 ` -Type PowerShell ` -Name az-automation-runbook ` -Force ``` The below screenshot shows a successful automation runbook import. ![Importing the runbook code](https://adamtheautomator.com/wp-content/uploads/2022/08/image-159.png) Importing the runbook code ### Publishing the Runbook Unlike the graphical editor in the Azure Portal, there’s no **Test pane** equivalent in Azure PowerShell to test your Azure runbooks. The only way to start a runbook in PowerShell is to publish it first. To publish an Azure runbook, run the `Publish-AzAutomationRunbook` cmdlet, as shown below. This cmdlet publishes the `az-automation-runbook` runbook. ```powershell Publish-AzAutomationRunbook ` -Name az-automation-runbook ` -AutomationAccountName az-automation-account ` -ResourceGroup aa-rg-powershell ``` As you can see below, the runbook state is now published. ![Publish-AzAutomationRunbook ](https://adamtheautomator.com/wp-content/uploads/2022/08/image-160.png) `Publish-AzAutomationRunbook` ### Starting the Runbook After you’ve successfully published the Azure runbook, run it by executing the `Start-AzAutomationRunbook` command below ```powershell Start-AzAutomationRunbook ` -AutomationAccountName az-automation-account ` -Name az-automation-runbook ` -ResourceGroupName aa-rg-powershell ` -Wait ``` > _Note: The -Wait switch causes the Start-AzAutomationRunbook to wait for the runbook to finish running before returning the result._ ![Starting the Azure runbook](https://adamtheautomator.com/wp-content/uploads/2022/08/image-161.png) Starting the Azure runbook ## Automating with Azure Runbook: Stopping Azure VMs on Schedule So far, you have created an Azure Runbook from scratch and added code to it using the Portal and PowerShell. Which method do you feel comfortable exploring? In this example, you’ll create and configure a runbook that stops a selected Azure VM or all VMs in a resource group. But, instead of writing your own code, you’ll import an existing runbook from the [Azure Runbook Gallery](https://azure.microsoft.com/en-us/blog/introducing-the-azure-automation-runbook-gallery/). > _Note: This activity requires that you have at least one Azure VM running to be the target of the Azure runbook._ ### Importing an Azure Runbook from the Gallery 1\. First, navigate to the [Automation accounts](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.Automation%2FAutomationAccounts) blade in the Azure Portal. 2\. You should see the automation accounts you previously created in the Portal and PowerShell. Click the _ata-automation-account_ that’s in the _aa-rg-portal_ resource group. ![Open the automation account](https://adamtheautomator.com/wp-content/uploads/2022/08/image-162.png) Open the automation account 3\. Click Runbooks → Browse Gallery. ![Clicking Browse Gallery](https://adamtheautomator.com/wp-content/uploads/2022/08/image-163.png) Clicking Browse Gallery 4\. You’ll see many runbooks in the gallery, find the one named _Stop Azure V2 VMs_ and click it. ![Click the Stop Azure V2 VMs runbook](https://adamtheautomator.com/wp-content/uploads/2022/08/image-164.png) Click the Stop Azure V2 VMs runbook 5\. When the Stop Azure V2 VMs page opens, click Select. ![Click Select](https://adamtheautomator.com/wp-content/uploads/2022/08/image-165.png) Click Select 6\. On the Import a runbook page, enter _stop-az-vm_ as the runbook Name. Leave all other fields intact and click Import. ![Importing the runbook from the gallery](https://adamtheautomator.com/wp-content/uploads/2022/08/image-166.png) Importing the runbook from the gallery 7\. The runbook opens in the graphical editor automatically. At this point, you don’t need to make any changes yet. Click Publish, Yes, to publish this runbook version. ![Publishing the runbook](https://adamtheautomator.com/wp-content/uploads/2022/08/image-167.png) Publishing the runbook 8\. Click the Automation account link in the breadcrumbs to return to the automation account blade. ![Return to the Automation account](https://adamtheautomator.com/wp-content/uploads/2022/08/image-168.png) Return to the Automation account ### Creating the ‘Run As Account’ Your runbook involves a step to connect to Azure, which means there must be an account that has access to the target Azure resources, and here is where the Azure _RunAsAccount_ comes in. The _RunAsAccount_ is a service principal in Azure Active Directory (AAD) with the required permissions. The Automation service creates and maintains this account for you—but first, you must create it. 1\. Click the Run as accounts blade → Azure Run As Account. ![Click the Run as accounts blade](https://adamtheautomator.com/wp-content/uploads/2022/08/image-169.png) Click the Run as accounts blade 2\. On the Add Azure Run As Account dialog, click Create. ![Creating the Azure Run As Account](https://adamtheautomator.com/wp-content/uploads/2022/08/image-170.png) Creating the Azure Run As Account 3\. Click on the new Azure Run As Account to view its properties. ![Open the new Run As Account properties](https://adamtheautomator.com/wp-content/uploads/2022/08/image-171.png) Open the new Run As Account properties As you can see below, the Run As account also created other assets or shared resources in the automation accounts, such as Connection and Certificate. The Run As account is also tied to a service principal object in Azure that has a [Contributor](https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#contributor) role to the subscription. ![The Azure Run As Account properties](https://adamtheautomator.com/wp-content/uploads/2022/08/image-172.png) The Azure Run As Account properties > _Note: The Run As Account expires based on the certificate expiration date. Click the Renew certificate button to renew the Run As Account along._ ### Adding a Schedule To fully automate the task, the task has to run unattended at a specified interval. Suppose you require VMs to stop every Friday at 17:00; adding a schedule asset will help you achieve that goal. 1\. Under the Shared Resource, click Schedules → Add a schedule. ![Click Add a schedule](https://adamtheautomator.com/wp-content/uploads/2022/08/image-173.png) Click Add a schedule 2\. Next, configure the schedule as follows: * **Name**: _Stop VMs on Fridays EOB_ * **Starts**: _