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

管理运行时环境和关联的 Runbook

本文介绍如何创建运行时环境,并通过 Azure 门户和 REST API 执行各种操作。

先决条件

支持的公共区域(印度中部、德国北部、意大利北部、以色列中部、波兰中部、阿联酋中部和政府云除外)中的 Azure 自动化帐户。

在运行时环境和旧体验之间切换

运行时环境体验

  1. 选择“概述”,然后选择“试用运行时环境体验”

    屏幕截图显示了如何试用运行时环境体验。

  2. 在“流程自动化”下,显示了“运行时环境(预览版)”,而“共享资源”下的“模块”和“Python 包”已被删除,因为运行时环境允许管理 Runbook 执行期间所需的包

    屏幕截图显示了切换到运行时环境体验时的菜单选项。

  3. 若要重新使用旧体验来管理模块和包,请在左侧窗格中选择“概述”,然后选择“切换到旧体验”

    屏幕截图显示了如何导航到旧体验。

旧体验

  1. 转到你的自动化帐户,在“流程自动化”下,“运行时环境(预览版)”已被删除,而在“共享资源”下,可以看到“模块”和“Python 包”

    屏幕截图显示了还原默认设置时的菜单选项。

注意

runbook 更新在新运行时环境体验和旧体验之间持续存在。 在旧体验中,在与 Runbook 链接的运行时环境中所做的任何更改都将在 Runbook 执行期间予以保留。

管理运行时环境

创建运行时环境

  1. 登录到 Azure 门户并选择你的自动化帐户。

  2. 在“流程自动化”下,依次选择“运行时环境(预览版)”、“创建”

  3. 在“基本信息”中提供以下详细信息

    1. 运行时环境的名称。 该名称必须以字母开头,只能包含字母、数字、下划线和短划线。

    2. 从“语言”下拉列表中,选择运行时环境的脚本语言

      • 选择“PowerShell”作为 PowerShell 脚本语言,或选择“Python”作为 Python 脚本语言
    3. 选择脚本语言的运行时版本

      • 对于 PowerShell - 请选择 5.1、7.2
      • 对于 Python - 请选择 3.8、3.10(预览版)
    4. 提供适当的说明

      屏幕截图显示了基本信息选项卡中用于创建运行时环境的输入内容。

  4. 选择“下一步”,然后在“包”选项卡中上传 Runbook 执行期间所需的包。 默认情况下,将为所有 PowerShell 运行时环境上传 Az PowerShell 包,其中包括用于管理 Azure 资源的所有 cmdlet。 可以从下拉列表中选择 Az 包的版本。 如果你不想在 Runbook 执行期间上传包,请选择“无”

    屏幕截图显示了包选项卡中为创建运行时环境而做出的选择。

    注意

    在与 PowerShell 7.2 运行时环境关联的 Runbook 中,支持 Azure CLI 命令(预览版)。 Azure CLI 命令版本 2.56.0 可在 PowerShell 7.2 运行时环境中用作默认包。

  5. 上传 Runbook 执行期间所需的其他包。 选择“添加文件”以添加存储在计算机本地的文件,或选择“从库中添加”以从 PowerShell 库上传包

    屏幕截图显示了如何从本地计算机添加文件或从库上传。

    注意

    • 导入包可能需要几分钟时间。 可导入的文件的最大总大小为 100MB。
    • 此处所述,使用 .zip 文件作为 PowerShell Runbook 类型
    • 对于 Python 3.8 包,请使用面向 cp38-amd64 的 .whl 文件。
    • 对于 Python 3.10(预览版)包,请使用面向 cp310 Linux OS 的 .whl 文件。
  6. 选择“下一步”,然后在“查看 + 创建”选项卡中验证设置是否正确。 选择“创建”时,Azure 会针对你选择的运行时环境设置运行验证。 如果通过了验证,则你可以继续创建运行时环境,否则,门户将指出需要修改的设置。

在“运行时环境(预览版)”页面中,可以查看为自动化帐户新建的运行时环境。 如果在列表中找不到新建的运行时环境,请选择“刷新”

查看运行时环境

从自动化帐户获取运行时环境属性。

GET 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

列出运行时环境

若要列出自动化帐户中的所有运行时环境,请执行以下操作:

  1. 在自动化帐户中的“流程自动化”下,选择“运行时环境(预览版)”

    屏幕截图显示了如何查看所有运行时环境的列表。

查看 Az PowerShell 包的组件

若要查看 Az PowerShell 包的所有组件包,请在 PowerShell Runbook 中运行 Get-Module -ListAvailable cmdlet。

作业输出将显示所有组件包及其版本。

屏幕截图显示了 PowerShell 包的组件。

删除运行时环境

若要从自动化帐户中删除运行时环境,请执行以下步骤:

  1. 在自动化帐户中的“流程自动化”下,选择“运行时环境(预览版)”

  2. 选择要删除的运行时环境。

  3. 选择“删除”以删除运行时环境

    屏幕截图显示了如何删除运行时环境。

更新运行时环境

运行时语言和运行时版本是不可变属性。 但是,你可以在运行时环境中更新模块版本以及添加或删除包。 链接到运行时环境的 Runbook 将用新设置自动更新。

  1. 在自动化帐户中的“流程自动化”下,选择“运行时环境(预览版)”

  2. 选择要更新的运行时环境。

  3. 从下拉列表中选择版本以更新现有包的版本。

  4. 选择“保存”。

    屏幕截图显示了如何更新运行时环境。

  5. 选择“添加文件”以从本地计算机上传包,或选择“从库中添加”以从 PowerShell 库上传包

    屏幕截图显示了如何在更新运行时环境时上传包。

    注意

    一次最多可将 10 个包添加到运行时环境。 在添加 10 个包后,请务必选择“保存”

管理链接到运行时环境的 Runbook

创建 Runbook

可以创建一个配置了运行时环境的新 PowerShell Runbook。

先决条件

  • 请确保在创建 Runbook 之前已经创建了运行时环境。

若要创建链接到运行时环境的新 Runbook,请执行以下步骤:

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

  2. 选择创建

  3. 在“基本信息”选项卡中,可以创建新的 Runbook,或者从本地计算机或 PowerShell 库上传文件

    1. 为 Runbook 提供名称。 该名称必须以字母开头,且只能包含字母、数字、下划线和短划线。

    2. 从“Runbook 类型”下拉列表中,选择要创建的 Runbook 的类型

    3. 选择要为 Runbook 配置的运行时环境。 可以选择“从现有运行时环境中选择”,也可以选择“创建新的运行时环境并将其链接到 Runbook”。 将根据步骤 b 中选择的“Runbook 类型”填充运行时环境列表

    4. 提供适当的说明

      屏幕截图显示了如何在运行时环境中创建 Runbook。

    注意

    对于“PowerShell Runbook 类型”,只会列出 PowerShell 运行时环境以供选择。 对于“Python Runbook 类型”,只会列出 Python 运行时环境以供选择

  4. 为 Runbook 添加标记,检查设置,然后选择“创建”以创建新的 Runbook

此 Runbook 将链接到所选的运行时环境。 所选运行时环境中的所有包在 Runbook 执行期间均可用。

更新 Runbook

可以通过更改链接到 Runbook 的运行时环境来更新 Runbook。 可以选择一个或多个 Runbook 进行更新。 处于运行中状态的 Runbook 不会因更改与其链接的运行时环境而受到影响。

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

  2. 选中要更新的 Runbook 对应的复选框。

  3. 选择“更新”屏幕截图显示了如何在运行时环境中更新 Runbook。

  4. 从下拉列表中选择要将 Runbook 链接到的运行时环境。 屏幕截图显示了如何在运行时环境中链接 Runbook。

  5. 选择“更新”以使用新的运行时环境更新所选的 Runbook

检查 Runbook 在更新后是否按预期执行。 如果 Runbook 无法提供预期结果,你可以按照步骤 1-4 再次将运行时环境更新到旧体验。

注意

runbook 更新在新运行时环境体验和旧体验之间持续存在。 在链接到 Runbook 的运行时环境中完成的任何更改都将在旧体验中的 Runbook 执行期间持续存在。

测试 Runbook 更新

使用不同的运行时环境对 Runbook 运行测试作业。 当需要在更新之前使用运行时环境对 Runbook 进行测试时,此方案很有用。

可以通过更改链接到 Runbook 的运行时环境来更新该 Runbook。 建议在发布更改之前测试 Runbook 的执行。 这是为了确保 Runbook 能够按预期工作。

若要在发布运行时环境更改之前测试 Runbook 的执行,请执行以下步骤:

  1. 转到“Runbook”页面,然后选择要更新其运行时环境的 Runbook

    屏幕截图显示了如何转到“Runbook”页面来选择 Runbook。

  2. 在“编辑 Runbook”页面中,选择“在门户中编辑”打开文本编辑器

  3. “运行时环境”字段会显示现有配置。 从下拉列表中选择新的运行时环境。

    屏幕截图显示了如何选择新的运行时环境。

  4. 选择“测试”窗格,使用更新的运行时环境测试 Runbook 的执行。 选择“开始”以开始运行测试

  5. 关闭测试窗格,并根据需要在 Runbook 代码或运行时环境中进行所需的更改。

  6. 选择“发布”以更新链接到 Runbook 的运行时环境

  7. 选择“是”以替代先前发布的版本并确认更改

创建云作业

目前,链接到运行时环境的 Runbook 将在 Azure 中运行。

Azure 自动化帐户中的所有现有 Runbook 将自动链接到系统生成的运行时环境。 系统生成的这些运行时环境是基于相应 Azure 自动化帐户中存在的运行时语言、版本和模块/包创建的。 了解详细信息。 若要更新现有的 Runbook,请按照此处所述的步骤更改运行时环境。

后续步骤