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

az automation runbook

实验
参考

注意

此参考是 Azure CLI（版本 2.55.0 或更高版本）的自动化扩展的一部分。该扩展将在首次运行 az automation runbook 命令时自动安装。详细了解扩展。

此命令组是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

自动化 Runbook。

命令

名称	说明	类型	状态
az automation runbook create	创建 Runbook 名称标识的 Runbook。	扩展	实验
az automation runbook delete	按名称删除 Runbook。	扩展	实验
az automation runbook list	检索 Runbook 列表。	扩展	实验
az automation runbook publish	发布 Runbook 草稿。	扩展	实验
az automation runbook replace-content	替换 Runbook 的内容。	扩展	实验
az automation runbook revert-to-published	将 Runbook 内容还原到上次已知的已发布状态。	扩展	实验
az automation runbook show	检索 Runbook 名称标识的 Runbook。	扩展	实验
az automation runbook start	启动 Runbook。	扩展	实验
az automation runbook update	更新 Runbook 名称标识的 Runbook。	扩展	实验
az automation runbook wait	将 CLI 置于等待状态，直到满足自动化 Runbook 的条件。	扩展	实验

az automation runbook create

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

创建 Runbook 名称标识的 Runbook。

az automation runbook create --automation-account-name
                             --name
                             --resource-group
                             --type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script}
                             [--description]
                             [--location]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--tags]

示例

创建 Runbook

az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --type "PowerShell" --location "East US 2"

必需参数

--automation-account-name

自动化帐户的名称。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--type

Runbook 的类型。

接受的值: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

可选参数

--description

Runbook 的说明。

--location -l

Location。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。

--log-activity-trace

Runbook 的活动级别跟踪选项。

--log-progress

Runbook 的进度日志选项。

接受的值: false, true

--log-verbose

Runbook 的详细日志选项。

接受的值: false, true

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook delete

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

按名称删除 Runbook。

az automation runbook delete [--automation-account-name]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--yes]

示例

删除 Runbook

az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

可选参数

--automation-account-name

自动化帐户的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook list

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

检索 Runbook 列表。

az automation runbook list --automation-account-name
                           --resource-group

示例

按自动化帐户列出 Runbook

az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"

必需参数

--automation-account-name

自动化帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook publish

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

发布 Runbook 草稿。

az automation runbook publish [--automation-account-name]
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]

示例

发布 Runbook 草稿

az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook"

可选参数

--automation-account-name

自动化帐户的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --runbook-name -n

提供给发布 Runbook 操作的参数。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook replace-content

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

替换 Runbook 的内容。

az automation runbook replace-content --content
                                      [--automation-account-name]
                                      [--ids]
                                      [--name]
                                      [--no-wait]
                                      [--resource-group]
                                      [--subscription]

示例

替换 Runbook 的内容

az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook" --content @/path/to/script

必需参数

--content

Runbook 内容。

可选参数

--automation-account-name

自动化帐户的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --runbook-name -n

Runbook 名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook revert-to-published

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

将 Runbook 内容还原到上次已知的已发布状态。

az automation runbook revert-to-published [--automation-account-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

示例

替换 Runbook 的内容

az automation runbook revert-to-published --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "myRunbook"

可选参数

--automation-account-name

自动化帐户的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook show

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

检索 Runbook 名称标识的 Runbook。

az automation runbook show [--automation-account-name]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

示例

获取 Runbook

az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

可选参数

--automation-account-name

自动化帐户的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook start

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

启动 Runbook。

az automation runbook start [--automation-account-name]
                            [--ids]
                            [--name]
                            [--parameters]
                            [--resource-group]
                            [--run-on]
                            [--subscription]

示例

启动 Runbook

az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

可选参数

--automation-account-name

自动化帐户的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --runbook-name -n

Runbook 名称。

--parameters

作业的参数。预期值：KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--run-on

RunOn，指定要在其中执行作业的组名称。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook update

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

更新 Runbook 名称标识的 Runbook。

az automation runbook update [--automation-account-name]
                             [--description]
                             [--ids]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--tags]

示例

更新 Runbook

az automation runbook update --automation-account-name "myAutomationAccount" --description                "Runbook Description" --log-activity-trace 1 --log-progress true --log-verbose false                --resource-group "rg" --runbook-name "myRunbook"

可选参数

--automation-account-name

自动化帐户的名称。

--description

Runbook 的说明。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--log-activity-trace

Runbook 的活动级别跟踪选项。

--log-progress

Runbook 的进度日志选项。

接受的值: false, true

--log-verbose

Runbook 的详细日志选项。

接受的值: false, true

--name --runbook-name -n

Runbook 名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook wait

实验

命令组“自动化 Runbook”是实验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

将 CLI 置于等待状态，直到满足自动化 Runbook 的条件。

az automation runbook wait [--automation-account-name]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

示例

暂停执行下一行 CLI 脚本，直到成功创建自动化 Runbook。

az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --created

可选参数

--automation-account-name

自动化帐户的名称。

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name --runbook-name -n

Runbook 名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az automation runbook

命令

az automation runbook create

示例

必需参数

可选参数

az automation runbook delete

示例

可选参数

az automation runbook list

示例

必需参数

az automation runbook publish

示例

可选参数

az automation runbook replace-content

示例

必需参数

可选参数

az automation runbook revert-to-published

示例

可选参数

az automation runbook show

示例

可选参数

az automation runbook start

示例

可选参数

az automation runbook update

示例

可选参数

az automation runbook wait

示例

可选参数

反馈

其他资源