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

在 Azure 自动化中通过 VS Code 创作 runbook

本文介绍可用于创建和管理 runbook 的 Visual Studio 扩展。

Azure 自动化提供了 VS Code 中的新扩展,用于创建和管理 runbook。 借助此扩展,可以执行所有 runbook 管理操作,例如创建和编辑 runbook、触发作业、跟踪最近的作业输出、链接计划、管理资产和进行本地调试。

先决条件

  • 具有活动订阅的 Azure 帐户。 免费创建帐户
  • Visual Studio Code
  • runbook 使用的 PowerShell 模块和 Python 包必须在计算机上本地安装,才能在本地运行 runbook。

支持的操作系统

测试矩阵包括以下操作系统:

  1. 使用 Windows PowerShell 5.1 和 PowerShell Core 7.2.7 的 Windows Server 2022
  2. 使用 Windows PowerShell 5.1 和 PowerShell Core 7.2.7 的 Windows Server 2019
  3. 使用 PowerShell Core 7.2.7 的 macOS 11
  4. 使用 PowerShell Core 7.2.7 的 Ubuntu 20.04

注意

  • 该扩展应在 VS Code 中的任意位置工作,它支持 PowerShell 7.2 或更高版本。 对于 Windows PowerShell,仅支持 5.1 版本。
  • PowerShell Core 6 已结束生命周期,并且不受支持。

关键功能

  • 加入更简单 - 可使用 Azure 帐户通过简单安全的方式进行登录。
  • 多种语言 - 支持所有自动化运行时堆栈,例如 PowerShell 5、PowerShell 7、Python 2 和 Python 3 runbook。
  • 可支持性 - 支持在 Azure 和混合辅助角色中测试作业执行、发布自动化作业和触发作业。 可以在本地执行 runbook。
  • 支持 Python 位置参数和 PowerShell 参数来触发作业。
  • Webhook 简化 - 可创建 Webhook,通过 Webhook 用更简单的方式启动作业。 此外,支持将计划链接到 runbook。
  • 管理自动化资产 - 可以对资产执行创建、更新和删除操作,包括证书、变量、凭据和连接。
  • 查看属性 - 可以查看属性并选择混合辅助角色组来执行混合作业,并查看最近执行的 10 个作业。
  • 在本地调试 - 可以在本地调试 PowerShell 脚本。
  • runbook 比较 - 可以将本地 runbook 与已发布的或草稿 runbook 副本进行比较。

v1.0.8 的主要功能

  • 本地目录配置设置 - 可以定义要在本地保存 runbook 的工作目录。

    • 更改 Directory:Base 目录 - 在重新打开 Visual Studio Code IDE 时使用已更改的目录路径。 若要使用命令面板更改目录,请使用 Ctrl+Shift+P -> 选择“更改目录”。 若要从扩展配置设置更改基本路径,请选择左侧活动栏中的“管理”图标,然后转到“设置”>“扩展”>“Azure 自动化”>Directory:Base 路径”。
    • 更改 Directory:Folder 结构 - 可以将本地目录文件夹结构从 vscodeAutomation/accHash 更改为 subscription/resourceGroup/automationAccount。 在左侧活动栏中选择“管理”图标,然后转到“设置”>“扩展”>“Azure 自动化”>“ Directory:Folder 结构”。 可以将默认配置设置从 vscodeAutomation/accHash 更改为 subscription/resourceGroupe/automationAccount 格式。

      注意

      如果自动化帐户与源代码管理集成,你可以将 GitHub 存储库的 runbook 文件夹路径作为目录路径提供。 例如:将目录更改为 C:\abc 会将 runbook 存储在 C:\abc\vscodeAutomation.. 或 C:\abc//subscriptionName//resourceGroupName//automationAccountName//runbookname.ps1 中。

  • runbook 管理操作 - 可以创建 runbook、提取草稿 runbook、提取已发布 runbook、在编辑器中打开本地 runbook、将本地 runbook 与已发布的或草稿 runbook 副本进行比较、上传为草稿、发布 runbook,以及从自动化帐户中删除 runbook。

  • runbook 执行操作 - 可以通过允许在脚本中添加断点来运行本地版本的自动化作业,例如启动自动化作业、启动自动化测试作业、查看作业输出,以及在调试模式下运行本地版本的 PowerShell runbook。

    注意

    目前,我们仅支持对非加密资产使用内部 cmdlet,例如 Get-AutomationVariable

  • 使用计划、资产和 Webhook - 可以查看计划的属性、删除计划、将计划链接到 runbook。

  • 添加 Webhook - 可以将 Webhook 添加到 runbook。

  • 更新资产属性 - 可以创建、更新和查看资产的属性,例如证书、连接、凭据、变量以及从扩展中删除资产。

限制

目前,尚不支持以下功能:

  • 创建新计划。
  • 在资产中添加新证书。
  • 从扩展上传模块(PowerShell 和 Python)包。
  • 将本地 runbook 自动同步到 Azure 自动化帐户。 必须执行操作才能提取或发布 runbook。
  • 管理混合辅助角色组。
  • 图形 runbook 和工作流。
  • 对于 Python,我们不提供任何调试选项。 建议在 Python 脚本中安装任何调试程序扩展。
  • 目前,我们仅支持本地运行中未加密的资产。

后续步骤