az migrate runbook execution

Note

此參考文獻是Azure CLI版本 2.75.0 或更高版本的 migrate 擴充套件的一部分。 這個擴充功能會在你第一次執行 az migrate runbook 執行 指令時自動安裝。 深入了解擴充功能。

指令群組「migrate runbook」目前處於預覽階段並正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

管理 runbook 執行。

命令

名稱 Description 類型 狀態
az migrate runbook execution cancel

取消正在進行中或暫停的 runbook 執行。

擴充功能 Preview
az migrate runbook execution list

列出跑記的執行情況。

擴充功能 Preview
az migrate runbook execution parameter

下載、上傳並設定執行的輸入參數檔案。

擴充功能 Preview
az migrate runbook execution parameter configure

產生一個離線 HTML 編輯器來設定執行參數。

擴充功能 Preview
az migrate runbook execution parameter download

下載執行參數檔案。

擴充功能 Preview
az migrate runbook execution parameter upload

上傳執行的輸入參數檔案。

擴充功能 Preview
az migrate runbook execution pause

暫停正在進行中的跑手本執行。

擴充功能 Preview
az migrate runbook execution resume

繼續執行暫停的跑道本執行。

擴充功能 Preview
az migrate runbook execution show

展示(或觀看)runbook 執行的狀態。

擴充功能 Preview
az migrate runbook execution start

開始重新執行一本 runbook。

擴充功能 Preview
az migrate runbook execution step

在執行流程簿中執行單一步驟。

擴充功能 Preview
az migrate runbook execution step approve

在執行過程中提供批准階段的批准。

擴充功能 Preview
az migrate runbook execution step complete

在執行時標記一個手動步驟為完成。

擴充功能 Preview
az migrate runbook execution step retry

重新執行失敗步驟。

擴充功能 Preview
az migrate runbook execution visualize

將執行狀態渲染為自包含的 HTML 圖形。

擴充功能 Preview

az migrate runbook execution cancel

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

取消正在進行中或暫停的 runbook 執行。

取消是終點;取消的執行無法恢復。 改為重新執行一次。

az migrate runbook execution cancel --execution-id
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--yes]

範例

取消執行死刑。

az migrate runbook execution cancel -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

必要參數

--execution-id

執行流程本的ID。

--name --runbook-name -n

跑手冊名稱。

--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--yes -y

不提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az migrate runbook execution list

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列出跑記的執行情況。

az migrate runbook execution list --name --runbook-name
                                  --project-name
                                  --resource-group

範例

列出一本跑報簿的處決。

az migrate runbook execution list -g myRg \
  --project-name myProject --runbook-name myRunbook

必要參數

--name --runbook-name -n

跑手冊名稱。

--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az migrate runbook execution pause

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

暫停正在進行中的跑手本執行。

az migrate runbook execution pause --execution-id
                                   --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]

範例

暫停執行。

az migrate runbook execution pause -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

必要參數

--execution-id

執行流程本的ID。

--name --runbook-name -n

跑手冊名稱。

--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az migrate runbook execution resume

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

繼續執行暫停的跑道本執行。

az migrate runbook execution resume --execution-id
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]

範例

繼續執行死刑。

az migrate runbook execution resume -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

必要參數

--execution-id

執行流程本的ID。

--name --runbook-name -n

跑手冊名稱。

--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az migrate runbook execution show

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

展示(或觀看)runbook 執行的狀態。

az migrate runbook execution show --execution-id
                                  --name --runbook-name
                                  --project-name
                                  --resource-group
                                  [--interval]
                                  [--step-id]
                                  [--watch]

範例

顯示執行狀態。

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

顯示單一步驟的狀態。

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --step-id step1

自動刷新狀態表直到完成。

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --watch

必要參數

--execution-id

執行流程本的ID。

--name --runbook-name -n

跑手冊名稱。

--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--interval

--watch 的刷新間隔以秒為單位(預設:60)。

屬性 值
預設值: 60
--step-id

限制輸出到單一步驟。

--watch

在某個間隔內重新渲染狀態表,直到執行達到終端狀態。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az migrate runbook execution start

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

開始重新執行一本 runbook。

az migrate runbook execution start --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--no-visualize]
                                   [--no-wait]

範例

開始執行 runbook。

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name myRunbook

不要等完成再開始。

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name myRunbook --no-wait

必要參數

--name --runbook-name -n

跑手冊名稱。

--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--no-visualize

執行開始後,請勿開啟即時執行觀看視窗。 適合自動化和非互動環境。

屬性 值
預設值: False
--no-wait

請勿等候長時間執行的作業完成。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az migrate runbook execution visualize

預覽

指令群組「遷移 runbook 執行」目前處於預覽階段並開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

將執行狀態渲染為自包含的 HTML 圖形。

az migrate runbook execution visualize [--acquire-policy-token]
                                       [--change-reference]
                                       [--execution-id]
                                       [--file]
                                       [--from-file]
                                       [--interval]
                                       [--name --runbook-name]
                                       [--no-open]
                                       [--project-name]
                                       [--resource-group]
                                       [--watch]

範例

視覺化執行狀態(瀏覽器開啟)。

az migrate runbook execution visualize -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

在某個間隔內重新生成快照直到完成。

az migrate runbook execution visualize -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --watch

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--execution-id

我用 run book 執行來視覺化。

--file

產生的 HTML 檔案輸出路徑(預設:目前目錄)。

--from-file

從本地執行狀態的 JSON 檔案渲染,而不是從服務中擷取。

--interval

--watch 的刷新間隔以秒為單位(預設:60)。

屬性 值
預設值: 60
--name --runbook-name -n

跑手冊名稱。

--no-open

寫入 HTML 檔案,但不要在瀏覽器中開啟。

屬性 值
預設值: False
--project-name -p

Azure Migrate 專案名稱。 您可以使用 來設定預設值 az configure --defaults migrate_project=<name>。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--watch

在執行達到終端狀態前,以一定間隔重新生成 HTML 快照。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False