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'。