az batch task
管理 Batch 工作。
命令
名稱 | Description | 類型 | 狀態 |
---|---|---|---|
az batch task create |
建立 Batch 工作。 |
核心 | 加語 |
az batch task delete |
從指定的作業刪除工作。 |
核心 | 加語 |
az batch task file |
管理 Batch 工作檔案。 |
核心 | 加語 |
az batch task file delete |
從執行工作的計算節點刪除指定的工作檔案。 |
核心 | 加語 |
az batch task file download |
下載 Batch 工作檔案的內容。 |
核心 | 加語 |
az batch task file list |
列出工作目錄中其計算節點上的檔案。 |
核心 | 加語 |
az batch task file show |
取得指定之 Task 檔案的屬性。 |
核心 | 加語 |
az batch task list |
列出與指定之作業相關聯的所有工作。 |
核心 | 加語 |
az batch task reactivate |
重新啟用工作,即使重試計數已用盡,仍允許它再次執行。 |
核心 | 加語 |
az batch task reset |
重設 Batch 工作的屬性。 |
核心 | 加語 |
az batch task show |
取得指定之工作的相關信息。 |
核心 | 加語 |
az batch task stop |
終止指定的工作。 |
核心 | 加語 |
az batch task subtask |
管理 Batch 工作的子工作資訊。 |
核心 | 加語 |
az batch task subtask list |
列出與指定之多重實例工作相關聯的所有子工作。 |
核心 | 加語 |
az batch task create
建立 Batch 工作。
az batch task create --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--affinity-id]
[--application-package-references]
[--command-line]
[--environment-settings]
[--json-file]
[--max-task-retry-count]
[--max-wall-clock-time]
[--resource-files]
[--retention-time]
[--task-id]
範例
建立 1 分鐘睡眠的工作。
az batch task create --task-id task1 --job-id job1 --command-line "sleep 60"
必要參數
包含工作的作業標識碼。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 只需要環境變數設定:AZURE_BATCH_ACCOUNT。
必填。 您可以傳遞 Node 的 affinityId,以指出此工作必須在該計算節點上執行。 請注意,這隻是軟親和性。 如果目標計算節點在排程工作時忙碌或無法使用,則會將工作排程到別處。
指定要安裝之應用程式套件的空間分隔標識碼清單。 以 'id[#version]' 格式的選擇性版本分隔應用程式識別碼。
工作的命令行。 命令行不會在殼層下執行,因此無法利用殼層功能,例如環境變數擴充。 如果您想要利用這些功能,您應該在命令行中叫用殼層,例如在 Windows 中使用 “cmd /c MyCommand”,或在 Linux 中使用 “/bin/sh -c MyCommand”。
工作的環境變數設定清單。 以 『key=value』 格式分隔的空間值。
包含 JSON 中建立之工作(格式為符合 REST API 要求本文的檔案)。 提交多個工作時,接受工作陣列或TaskAddCollectionParamater。 如果指定此參數,則會忽略所有其他參數。
重試工作的最大次數。 如果 Batch 服務結束代碼為非零,則會重試工作。 請注意,這個值會特別控制工作可執行檔的重試次數,因為非零結束代碼。 Batch 服務會嘗試工作一次,然後可能會重試到此限制。 例如,如果重試計數上限為 3,Batch 會嘗試工作最多 4 次(一次初始嘗試,3 次重試)。 如果重試計數上限為0,Batch服務就不會在第一次嘗試之後重試工作。 如果重試計數上限為 -1,Batch 服務會不限制地重試工作,但不建議用於啟動工作或任何工作。 預設值為 0(沒有重試)。
如果未指定此專案,則工作執行的時間長度沒有限制。
Batch 服務在執行命令行之前,會先下載到計算節點的檔案清單。 filename=httpurl 格式的空間分隔資源參考,httpurl 是具有公用存取權的任何 HTTP URL 或具有讀取許可權的 SAS URL。
默認值為 7 天,也就是工作目錄將保留 7 天,除非移除計算節點或刪除作業。
工作的標識碼。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。
az batch task delete
從指定的作業刪除工作。
刪除工作時,也會刪除其所在計算節點上其目錄中的所有檔案(不論保留時間為何)。 針對多重實例工作,刪除工作作業會同步套用至主要工作;子工作及其檔案接著會在背景以異步方式刪除。
az batch task delete --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--yes]
必要參數
要從中刪除工作的作業標識碼。 必填。
要刪除之工作的識別碼。 必填。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 或者,由環境變數設定:AZURE_BATCH_ACCOUNT。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時,才會執行此作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時,才會執行作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
請勿提示確認。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。
az batch task list
列出與指定之作業相關聯的所有工作。
針對多重實例工作,affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關信息。
az batch task list --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--filter]
[--select]
必要參數
作業的標識碼。 必填。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 或者,由環境變數設定:AZURE_BATCH_ACCOUNT。
OData $expand 子句。
OData $filter 子句。 如需建構此篩選的詳細資訊,請參閱 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch。
OData $select 子句。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。
az batch task reactivate
重新啟用工作,即使重試計數已用盡,仍允許它再次執行。
重新啟用可讓工作重新重試,最多達到重試計數上限。 工作的狀態會變更為作用中。 由於工作已不再處於已完成狀態,任何先前的結束代碼或失敗資訊都無法在重新啟用之後再使用。 每次重新啟動工作時,其重試計數會重設為 0。 未完成或先前成功完成的工作將會重新啟動失敗(結束代碼為 0)。 此外,如果作業已完成(或正在終止或刪除),它將會失敗。
az batch task reactivate --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
必要參數
包含工作之作業的識別碼。 必填。
要重新啟用之工作的識別碼。 必填。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 或者,由環境變數設定:AZURE_BATCH_ACCOUNT。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時,才會執行此作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時,才會執行作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。
az batch task reset
重設 Batch 工作的屬性。
az batch task reset --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--json-file]
[--max-task-retry-count]
[--max-wall-clock-time]
[--retention-time]
範例
將重試計數上限設定為 3,並將其他屬性重設為預設值
az batch task reset --task-id task1 --job-id job1 --max-task-retry-count 3
必要參數
包含工作之作業的識別碼。
要更新之工作的識別碼。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 只需要環境變數設定:AZURE_BATCH_ACCOUNT。
只有在資源的目前 ETag 完全符合指定的值時,才會執行作業。
只有在資源自指定的時間戳之後修改過時,才會執行此作業。
只有在資源的目前 ETag 完全符合指定的值時,才會執行作業。
只有在資源自指定的時間戳之後修改過時,才會執行此作業。
包含 JSON 中集區更新屬性參數規格的檔案(格式為符合 REST API 要求本文)。 如果指定此參數,則會忽略所有 「集區更新屬性參數自變數」。
重試工作的最大次數。 如果 Batch 服務結束代碼為非零,則會重試工作。 請注意,這個值會特別控制工作可執行檔的重試次數,因為非零結束代碼。 Batch 服務會嘗試工作一次,然後可能會重試到此限制。 例如,如果重試計數上限為 3,Batch 會嘗試工作最多 4 次(一次初始嘗試,3 次重試)。 如果重試計數上限為0,Batch服務就不會在第一次嘗試之後重試工作。 如果重試計數上限為 -1,Batch 服務會不限制地重試工作,但不建議用於啟動工作或任何工作。 預設值為 0(沒有重試)。
如果未指定此專案,則工作執行的時間長度沒有限制。 預期格式為 ISO-8601 持續時間。
默認值為 7 天,也就是工作目錄將保留 7 天,除非移除計算節點或刪除作業。 預期格式為 ISO-8601 持續時間。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。
az batch task show
取得指定之工作的相關信息。
針對多重實例工作,affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關信息。
az batch task show --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--select]
必要參數
包含工作之作業的識別碼。 必填。
要取得相關信息之工作的標識碼。 必填。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 或者,由環境變數設定:AZURE_BATCH_ACCOUNT。
OData $expand 子句。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時,才會執行此作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時,才會執行作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
OData $select 子句。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。
az batch task stop
終止指定的工作。
當工作終止時,它會移至已完成狀態。 針對多重實例工作,終止工作作業會同步套用至主要工作;子工作接著會在背景以異步方式終止。
az batch task stop --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
必要參數
包含工作之作業的識別碼。 必填。
要終止之工作的標識碼。 必填。
選擇性參數
Batch 服務端點。 或者,由環境變數設定:AZURE_BATCH_ENDPOINT。
Batch 帳戶金鑰。 或者,由環境變數設定:AZURE_BATCH_ACCESS_KEY。
Batch 帳戶名稱。 或者,由環境變數設定:AZURE_BATCH_ACCOUNT。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時,才會執行此作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時,才會執行作業。
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。
全域參數
增加記錄詳細信息以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。