你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

教程:在自动化中创建 PowerShell 工作流 Runbook

本教程指导在 Azure 自动化中创建 PowerShell 工作流 Runbook。 PowerShell 工作流 Runbook 是基于 Windows PowerShell 工作流的文本 Runbook。 可以在 Azure 门户中使用文本编辑器创建和编辑 Runbook 的代码。

注意

本文适用于 PowerShell 5.1;PowerShell 7.1(预览版)不支持工作流。

在本教程中,你将了解:

  • 创建 PowerShell 工作流 Runbook
  • 测试并发布 Runbook
  • 运行 Runbook 作业并跟踪其状态
  • 添加身份验证来管理 Azure 资源
  • 更新 Runbook 参数以启动 Azure 虚拟机

如果没有 Azure 订阅,请在开始之前创建一个免费帐户

必备条件

向托管标识分配权限

向适当的托管标识分配权限,以允许它们停止虚拟机。 Runbook 可使用自动化帐户的系统分配的托管标识或用户分配的托管标识。 已提供为每个标识分配权限的步骤。 以下步骤使用 Azure 门户。 如果希望使用 PowerShell,请参阅使用 Azure PowerShell 分配 Azure 角色

  1. 登录到 Azure 门户,并导航到自动化帐户。

  2. 在“帐户设置”下选择“标识(预览)” 。

  3. 在“系统分配”选项卡中,选择“权限”下的“Azure 角色分配”,打开“Azure 角色分配”页面 。

    Selecting Azure role assignments in portal.

  4. 选择“+ 添加角色分配(预览)”,打开“添加角色分配(预览)”页面 。

    Add role assignments in portal.

  5. 选择适当的值。

    属性 说明
    作用域 范围是角色分配应用到的资源集。 从下拉列表中选择“资源组”。
    订阅 此字段应自动填充为你的订阅。
    资源组 在下拉列表中,选择要授予标识权限的资源组。
    角色 从下拉列表中选择“DevTest Labs 用户”。
  6. 选择“保存”,然后关闭“Azure 角色分配”页面,回到“系统分配”选项卡 。

  7. 选择“用户分配”选项卡。

  8. 从列表中选择用户分配的托管标识,打开“托管标识”页面。

    Selecting user-assigned managed identity in portal.

  9. 记下“客户端 ID”供以后使用。

    Showing Client ID for managed identity in portal

  10. 在左侧菜单中选择“Azure 角色分配”,然后选择“+ 添加角色分配(预览)”,打开“添加角色分配(预览)”页面 。

    Add role assignments in portal for user-assigned identity.

  11. 选择适当的值。

    属性 说明
    作用域 从下拉列表中选择“资源组”。
    订阅 此字段应自动填充为你的订阅。
    资源组 在下拉列表中,选择要授予标识权限的资源组。
    角色 从下拉列表中选择“DevTest Labs 用户”。
  12. 选择“保存”,然后关闭“Azure 角色分配”页面,回到“用户分配”选项卡 。

创建新的 Runbook

首先,创建一个简单的 PowerShell 工作流 Runbook。 Windows PowerShell 工作流的一个优点是能够与典型脚本一样并行而不是按顺序执行一组命令。

注意

随着发布,Runbook 创建在 Azure 门户中有了新的体验。 当选择“Runbook”边栏选项卡 >“创建 runbook”时,会打开一个包含适用选项的新页面“创建 runbook”。

  1. 在打开的自动化帐户页面中,选择“流程自动化”下的“Runbook”

    Create PowerShell workflow runbook from portal

  2. 选择“+ 创建 Runbook”。

    1. 命名 runbook。 例如测试。
    2. 从“Runbook 类型”下拉菜单中,选择“PowerShell 工作流” 。
    3. 从“运行时版本”下拉列表中,选择“5.1”。
    4. 输入适用的说明。
    5. 选择“创建” 。

    PowerShell workflow runbook options from portal

将代码添加到 Runbook

可以直接将代码键入 Runbook 中,或者从“库”控件中选择 cmdlet、Runbook 和资产,并使用任何相关的参数将它们添加到 Runbook。 在本教程中,我们将代码直接键入 Runbook。

Runbook 目前为空,只有必需的 Workflow 关键字、Runbook 名称以及括住整个工作流的大括号。

Workflow MyFirstRunbook-Workflow
{
}
  1. 你可以使用 Parallel 关键字创建一个包含将并发运行的多个命令的脚本块。 在大括号之间输入以下代码:

    Parallel {
         Write-Output "Parallel"
         Get-Date
         Start-Sleep -s 3
         Get-Date
     }
    
    Write-Output " `r`n"
    Write-Output "Non-Parallel"
    Get-Date
    Start-Sleep -s 3
    Get-Date  
    
  2. 选择“保存”来保存 Runbook。

测试 Runbook

在发布 Runbook 使其可在生产中使用之前,应对其进行测试,确保其能正常运行。 测试 Runbook 时将运行其“草稿”版本,你可以通过交互方式查看其输出。

  1. 选择“测试窗格”来打开“测试”页 。

  2. 选择“启动”以启动测试 。 这会创建一个 runbook 作业 并且在窗格中显示其状态。

    作业状态一开始为“排队”,表明作业正在等待云中的 Runbook 辅助角色变为可用状态。 在某个辅助角色认领该作业后,其状态会变为“正在启动”。 最后,当 Runbook 开始实际运行时,其状态会变为“正在运行”。

  3. Runbook 作业完成后,“测试”窗格会显示其输出。 输出内容应与下图类似:

    PowerShell workflow runbook parallel output

    查看输出。 同时执行 Parallel 块中的所有内容(包括 Start-Sleep 命令)。 Parallel 块外部的相同命令按顺序运行,如不同的日期时间戳所示。

  4. 关闭“测试”页返回到画布。

发布和启动 Runbook

你创建的 Runbook 仍处于“草稿”模式。 必须先发布它,然后才能在生产中运行它。 当发布 Runbook 时,可以用草稿版本覆盖现有的已发布版本。 在本例中,还没有已发布版本,因为刚刚创建 Runbook。

  1. 选择“发布”以发布该 Runbook,并在出现提示时选择“是” 。

  2. “状态”字段现在显示的是“已发布” 。 查看顶部的选项,可通过它们立即启动 Runbook、计划将来的启动时间,或者创建一个 Webhook 来通过 HTTP 调用启动 Runbook。 选择“启动”,并在出现提示时选择“是” 启动 runbook。

    PowerShell workflow runbook overview page

  3. 此时会为已创建的 Runbook 作业打开一个“作业”页面。 在此示例中,请让页面保持打开状态,以便观察作业的进度。 “状态”字段与测试 Runbook 时看到的状态相符。

    Screenshot of the runbook Job page.

  4. 在 runbook 状态显示为“已完成”后,选择“输出” 。 输出内容应与测试输出类似。

  5. 关闭“作业”页,返回到 Runbook 概述页面 。

  6. 选择“资源”下的“作业” 。 此页列出你的 Runbook 创建的所有作业。 由于只将该作业运行了一次,应该只会看到一个列出的作业。

  7. 选择作业,以打开你在启动 runbook 时查看过的同一“作业”页。 使用此页面可查看为 Runbook 创建的任何作业的详细信息。 关闭“作业”页,返回到 Runbook 概述页面 。

添加身份验证来管理 Azure 资源

已经测试并发布 Runbook,但到目前为止它不执行任何有用的操作。 需要让其管理 Azure 资源。 除非它使用该订阅的凭据进行身份验证,否则它不能执行该操作。 该 Runbook 使用自动化帐户的系统分配的托管标识向 Azure 进行身份验证,以便对 VM 执行管理操作。 可轻松修改 Runbook 以使用用户分配的托管标识。

  1. 选择“概述”,然后选择“编辑”以打开文本编辑器 。

  2. 将所有现有代码替换为以下内容:

    workflow MyFirstRunbook-Workflow
    {
    $resourceGroup = "resourceGroupName"
    
    # Ensures you do not inherit an AzContext in your runbook
    Disable-AzContextAutosave -Scope Process
    
    # Connect to Azure with system-assigned managed identity
    $AzureContext = (Connect-AzAccount -Identity).context
    
    # set and store context
    $AzureContext = Set-AzContext -SubscriptionName $AzureContext.Subscription -DefaultProfile $AzureContext   
    }
    

    使用表示资源组的有效值编辑 $resourceGroup 变量。

  3. 如果希望 Runbook 使用系统分配的托管标识执行,请按原样保留代码。 如果希望使用用户分配的托管标识,则执行以下操作:

    1. 从第 9 行中删除 $AzureContext = (Connect-AzAccount -Identity).context
    2. 将其替换为 $AzureContext = (Connect-AzAccount -Identity -AccountId <ClientId>).context,然后
    3. 输入之前获取的客户端 ID。
  4. 选择“保存”,然后选择“测试窗格” 。

  5. 选择“启动”以启动测试 。 完成后,你应该会看到类似以下内容的输出,它显示了帐户的基本信息。 此操作确认凭据有效。

    Basic information that confirms credentials.

  6. 关闭“测试”页返回到画布。

添加代码以启动虚拟机

现在,你的 Runbook 向 Azure 订阅进行身份验证,你可以管理资源。 添加一个命令以启动虚拟机。 你可以选取你的 Azure 订阅中的任何 VM,但现在,你将在 Runbook 中将该名称硬编码。

  1. 将下面的代码添加为恰好在右大括号前面的最后一行。 将 VMName 替换为 VM 的实际名称。

    Start-AzVM -Name "VMName" -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
    
  2. 测试 Runbook 并确认 VM 已启动。 然后返回到画布。

向 Runbook 添加输入参数

Runbook 当前启动的是已在 Runbook 中硬编码的 VM。 如果可以在启动 Runbook 时指定 VM,它会更有用。 将输入参数添加到 Runbook,以提供该功能。

  1. 请使用以下代码替换第 3 行 ($resourceGroup = "resourceGroupName"):

    Param(
        [string]$resourceGroup,
        [string]$VMName
    )
    
  2. 使用以下内容替换之前的 Start-AzVM 命令:

    Start-AzVM -Name $VMName -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
    
  3. 测试 Runbook 并确认 VM 已启动。 然后返回到画布。

同时管理多个 VM

可以使用 ForEach -Parallel 构造同时处理集合中每个项的命令。 修改代码,以便 Runbook 现在:

  • 接受虚拟机名称的集合,
  • 接受参数以停止或启动虚拟机,并且
  • 针对所有虚拟机并行执行操作
  1. 将所有现有代码替换为以下内容:

    workflow MyFirstRunbook-Workflow
    {
    Param(
        [string]$resourceGroup,
        [string[]]$VMs,
        [string]$action
    )
    
    # Ensures you do not inherit an AzContext in your runbook
    Disable-AzContextAutosave -Scope Process
    
    # Connect to Azure with system-assigned managed identity
    $AzureContext = (Connect-AzAccount -Identity).context
    
    # set and store context
    $AzureContext = Set-AzContext -SubscriptionName $AzureContext.Subscription -DefaultProfile $AzureContext   
    
    # Start or stop VMs in parallel
    if($action -eq "Start")
        {
            ForEach -Parallel ($vm in $VMs)
            {
                Start-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
            }
        }
    elseif ($action -eq "Stop")
        {
            ForEach -Parallel ($vm in $VMs)
            {
                Stop-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext -Force
            }
        }
    else {
    	    Write-Output "`r`n Action not allowed. Please enter 'stop' or 'start'."
    	}
    }
    
  2. 如果希望 Runbook 使用系统分配的托管标识执行,请按原样保留代码。 如果希望使用用户分配的托管标识,则执行以下操作:

    1. 从第 13 行中删除 $AzureContext = (Connect-AzAccount -Identity).context
    2. 将其替换为 $AzureContext = (Connect-AzAccount -Identity -AccountId <ClientId>).context,然后
    3. 输入之前获取的客户端 ID。
  3. 选择“保存”,然后选择“发布”,并在出现系统提示时选择“是” 。

  4. 在概述页面中选择“启动” 。

  5. 填充参数,然后选择“确定”。

    参数 说明
    RESOURCEGROUP 输入 VM 的资源组的名称。
    VM 使用下列语法输入虚拟机的名称:["VM1","VM2","VM3"]
    操作 输入 stopstart
  6. 导航到虚拟机列表,且每隔几秒钟刷新一次页面。 注意观察,每个 VM 的操作是并行发生的。 如果没有 -Parallel 关键字,这些操作将按顺序执行。 虽然 VM 将按顺序启动,但根据每个 VM 的特征,各个 VM 进入“正在运行”阶段的时间可能会略有不同。

清理资源

如果不打算继续使用此 Runbook,请按照以下步骤将其删除:

  1. 导航到自动化帐户。
  2. 在“过程自动化”下,选择“Runbook”。
  3. 选择 Runbook。
  4. 在 Runbook 概述页面中,选择“删除” 。

后续步骤

在本教程中,你创建了一个 PowerShell 工作流 runbook。 要查看 Python 3 runbook,请参阅: