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

az automation runbook

注意

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

自动化 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 名称标识的 Runbook。

az automation runbook create --automation-account-name
                             --name
                             --resource-group
                             --type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, 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, Script

可选参数

--description

Runbook 的说明。

--location -l

位置。 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] ...]。使用“”清除现有标记。

az automation runbook delete

按名称删除 Runbook。

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

示例

删除 Runbook

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

必需参数

--automation-account-name

自动化帐户的名称。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

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

可选参数

--yes -y

不提示确认。

az automation runbook list

检索 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> 配置默认组。

az automation runbook publish

发布 Runbook 草稿。

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

示例

发布 Runbook 草稿

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

必需参数

--automation-account-name

自动化帐户的名称。

--name --runbook-name -n

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

--resource-group -g

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

可选参数

--no-wait

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

az automation runbook replace-content

替换 Runbook 的内容。

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

示例

替换 Runbook 的内容

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

必需参数

--automation-account-name

自动化帐户的名称。

--content

Runbook 内容。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

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

可选参数

--no-wait

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

az automation runbook revert-to-published

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

az automation runbook revert-to-published --automation-account-name
                                          --name
                                          --resource-group

示例

替换 Runbook 的内容

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

必需参数

--automation-account-name

自动化帐户的名称。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

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

az automation runbook show

检索 Runbook 名称标识的 Runbook。

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

示例

获取 Runbook

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

必需参数

--automation-account-name

自动化帐户的名称。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

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

az automation runbook start

启动 Runbook。

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

示例

启动 Runbook

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

必需参数

--automation-account-name

自动化帐户的名称。

--resource-group -g

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

可选参数

--name --runbook-name -n

Runbook 名称。

--parameters

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

--run-on

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

az automation runbook update

更新 Runbook 名称标识的 Runbook。

az automation runbook update --automation-account-name
                             --name
                             --resource-group
                             [--description]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--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

自动化帐户的名称。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

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

可选参数

--description

Runbook 的说明。

--log-activity-trace

Runbook 的活动级别跟踪选项。

--log-progress

Runbook 的进度日志选项。

接受的值: false, true
--log-verbose

Runbook 的详细日志选项。

接受的值: false, true
--tags

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

az automation runbook wait

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

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

示例

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

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

必需参数

--automation-account-name

自动化帐户的名称。

--name --runbook-name -n

Runbook 名称。

--resource-group -g

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

可选参数

--created

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

--custom

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

--deleted

等到删除。

--exists

等待资源存在。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--timeout

最大等待时间(以秒为单位)。

默认值: 3600
--updated

等待,直到使用 provisioningState 在“Succeeded”更新。