Skip to content

Latest commit

 

History

History
99 lines (59 loc) · 4.12 KB

automation-quickstart-create-runbook.md

File metadata and controls

99 lines (59 loc) · 4.12 KB
title description services author ms.author ms.date ms.topic ms.service ms.component ms.custom
Azure Quickstart - Create an Azure Automation runbook | Microsoft Docs
Learn how to create an Azure Automation runbook
automation
csand-msft
csand
12/14/2017
quickstart
automation
process-automation
mvc

Create an Azure Automation runbook

Azure Automation runbooks can be created through Azure. This method provides a browser-based user interface for creating Automation runbooks. In this quickstart you walk through creating, editing, testing, and publishing an Automation PowerShell runbook.

If you don't have an Azure subscription, create a free Azure account before you begin.

Log in to Azure

Log in to Azure at https://portal.azure.com

Create runbook

First, create a runbook. The sample runbook created in this quickstart outputs Hello World by default.

  1. Open your Automation account.

  2. Click Runbooks under PROCESS AUTOMATION. The list of runbooks is displayed.

  3. Click the Add a runbook button found at the top of the list. On the Add Runbook page, select Quick Create.

  4. Enter "Hello-World" for the runbook Name, and select PowerShell for Runbook type. Click Create.

    Enter information about your Automation runbook in the page

  5. The runbook is created and the Edit PowerShell Runbook page opens.

    Author PowerShell script in the runbook editor

  6. Type or copy and paste the following code into the edit pane. It creates an optional input parameter called "Name" with a default value of "World", and outputs a string that uses this input value:

    param
    (
        [Parameter(Mandatory=$false)]
        [String] $Name = "World"
    )
    
    "Hello $Name!"
    
  7. Click Save, to save a draft copy of the runbook.

    Author PowerShell script in the runbook editor

Test the runbook

Once the runbook is created, you test the runbook to validate that it works.

  1. Click Test pane to open the Test page.

  2. Enter a value for Name, and click Start. The test job starts and the job status and output display.

    Runbook test job

  3. Close the Test page by clicking the X in the upper right corner. Select OK in the popup that appears.

  4. In the Edit PowerShell Runbook page, click Publish to publish the runbook as the official version of the runbook in the account.

    Runbook test job

Run the runbook

Once the runbook is published, the overview page is shown.

  1. In the runbook overview page, click Start to open the Start Runbook configuration page for this runbook.

    Runbook test job

  2. Leave Name blank, so that the default value is used, and click OK. The runbook job is submitted, and the job page appears.

    Runbook test job

  3. When the Job status is Running or Completed, click Output to open the Output pane and view the runbook output.

    Runbook test job

Clean up resources

When no longer needed, delete the runbook. To do so, select the runbook in the runbook list, and click Delete.

Next steps

In this quickstart, you’ve created, edited, tested, and published a runbook and started a runbook job. To learn more about Automation runbooks, continue to the article on the different runbook types that you can create and use in Automation.

[!div class="nextstepaction"] Automation How To - Runbook Types