az durabletask scheduler

Note

此參考是該Azure CLIdurabletask擴充功能(版本 2.75.0 或更高版本)的一部分。 擴充功能會在您第一次執行 az durabletask scheduler 命令時自動安裝 。 深入了解擴充功能。

用來管理 Durabletask 排程器的命令。

命令

名稱 Description 類型 狀態
az durabletask scheduler attach

[實驗性]將耐用任務排程器附加到函式應用程式或容器應用程式上。

Extension GA
az durabletask scheduler create

建立排程器。

Extension GA
az durabletask scheduler delete

刪除排程器。

Extension GA
az durabletask scheduler identity

管理身分識別。

Extension GA
az durabletask scheduler identity assign

指派用戶或系統受控識別。

Extension 預覽
az durabletask scheduler identity remove

拿掉使用者或系統受控識別。

Extension 預覽
az durabletask scheduler identity show

顯示受控識別的詳細數據。

Extension 預覽
az durabletask scheduler identity wait

將 CLI 置於等候狀態,直到符合條件為止。

Extension GA
az durabletask scheduler list

依訂用帳戶列出排程器。

Extension GA
az durabletask scheduler restart

[預告]重新啟動一個持久任務排程器。

Extension GA
az durabletask scheduler show

取得排程器。

Extension GA
az durabletask scheduler transparent-data-encryption

管理 透明資料加密。

Extension 預覽
az durabletask scheduler transparent-data-encryption create

建立 透明資料加密。

Extension 預覽
az durabletask scheduler transparent-data-encryption delete

刪除 透明資料加密。

Extension 預覽
az durabletask scheduler transparent-data-encryption show

取得 透明資料加密。

Extension 預覽
az durabletask scheduler transparent-data-encryption update

更新 透明資料加密。

Extension 預覽
az durabletask scheduler transparent-data-encryption wait

將 CLI 置於等候狀態,直到符合條件為止。

Extension 預覽
az durabletask scheduler update

更新排程器。

Extension GA
az durabletask scheduler wait

將 CLI 置於等候狀態,直到符合條件為止。

Extension GA

az durabletask scheduler attach

[實驗性]將耐用任務排程器附加到函式應用程式或容器應用程式上。

此指令為實驗性質,未來版本可能會有所調整。

為目標資源的管理身份指派一個持久任務角色,並以排程端點及任務中心名稱配置目標的應用程式設定或環境變數。

az durabletask scheduler attach --name
                                --resource-group
                                --role-type {contributor, reader, worker}
                                --target
                                --task-hub-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--identity]

範例

將排程器附加到帶有 Worker 角色的函式應用程式上

az durabletask scheduler attach -g myResourceGroup -n myScheduler \
    --task-hub-name myTaskHub --role-type worker \
    --target /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Web/sites/myFunctionApp

將排程器附加到具有資料貢獻者角色的容器應用程式上

az durabletask scheduler attach -g myResourceGroup -n myScheduler \
    --task-hub-name myTaskHub --role-type contributor \
    --target /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.App/containerApps/myContainerApp

使用 使用者指派的管理身份進行連結

az durabletask scheduler attach -g myResourceGroup -n myScheduler \
    --task-hub-name myTaskHub --role-type worker \
    --target /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Web/sites/myFunctionApp \
    --identity /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity

必要參數

--name -n

持久任務排程器的名稱。

--resource-group -g

包含排程器的資源群組名稱。

--role-type

目標管理身份應指派的角色類型。

屬性 值
接受的值: contributor, reader, worker
--target -t

目標功能應用程式或容器應用程式的資源 ID。

--task-hub-name

持久任務任務中心的名稱。

選擇性參數

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

--acquire-policy-token

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

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

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

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

使用者指派的管理身份的資源識別碼。 若省略,則使用系統指派的管理身份。

全域參數
--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 durabletask scheduler create

建立排程器。

az durabletask scheduler create --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--ip-allowlist]
                                [--location]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--public-network-access {Disabled, Enabled}]
                                [--sku-capacity]
                                [--sku-name {Consumption, Dedicated}]
                                [--tags]

範例

在eastus中建立排程器

az durabletask scheduler create --resource-group testrg --name testscheduler --location eastus --ip-allowlist "[0.0.0.0/0]" --sku-capacity 1, --sku-name "Dedicated" --tags "{}"

建立一個關閉公共網路存取的消耗 SKU 排程器

az durabletask scheduler create --resource-group rgopenapi --name testscheduler --location northcentralus --sku-name "Consumption" --public-network-access Disabled  --tags "{department:research,development:true}"

必要參數

--name -n

排程器的名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

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

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

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

屬性 值
參數群組: Global Policy Arguments
--ip-allowlist

長期工作排程器的IP允許清單。 值可以是 IPv4、IPv6 或 CIDR 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

屬性 值
參數群組: Properties Arguments
預設值: []
--location -l

未指定資源所在的地理位置,將會使用資源群組的位置。

屬性 值
參數群組: Resource Arguments
--no-wait

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

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

允許或禁止對持久任務排程器的公共網路存取。

屬性 值
參數群組: Properties Arguments
接受的值: Disabled, Enabled
--sku-capacity

SKU 容量。 這可讓資源相應放大/縮小,並影響區域備援。

屬性 值
參數群組: Sku Arguments
--sku-name

SKU 的名稱。

屬性 值
參數群組: Sku Arguments
接受的值: Consumption, Dedicated
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

屬性 值
參數群組: Resource 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 durabletask scheduler delete

刪除排程器。

az durabletask scheduler delete [--acquire-policy-token]
                                [--change-reference]
                                [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--subscription]
                                [--yes]

範例

刪除排程器

az durabletask scheduler delete --resource-group testrg --name testscheduler

選擇性參數

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

--acquire-policy-token

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

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

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

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

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--name -n

排程器的名稱。

屬性 值
參數群組: Resource Id Arguments
--no-wait

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

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id 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/。

--verbose

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

屬性 值
預設值: False

az durabletask scheduler list

依訂用帳戶列出排程器。

az durabletask scheduler list [--max-items]
                              [--next-token]
                              [--resource-group]

範例

列出資源群組中的所有排程器

az durabletask scheduler list -g testrg

選擇性參數

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

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值,則會在命令的輸出中提供令牌。 若要繼續分頁,請在後續命令的 --next-token 自變數中提供令牌值。

屬性 值
參數群組: Pagination Arguments
--next-token

標記,指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性 值
參數群組: Pagination Arguments
--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 durabletask scheduler restart

[預告]重新啟動一個持久任務排程器。

此指令目前仍處於預覽階段,未來版本可能會有所變動。

呼叫排程資源上的 POST /restart 操作來重新啟動。

az durabletask scheduler restart --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]

範例

重新啟動排程器

az durabletask scheduler restart -g myResourceGroup -n myScheduler

必要參數

--name -n

持久任務排程器的名稱。

--resource-group -g

包含排程器的資源群組名稱。

選擇性參數

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

--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 durabletask scheduler show

取得排程器。

az durabletask scheduler show [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

範例

顯示特定排程器的相關信息

az durabletask scheduler show --resource-group testrg --name testscheduler

選擇性參數

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

--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--name -n

排程器的名稱。

屬性 值
參數群組: Resource Id Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
全域參數
--debug

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az durabletask scheduler update

更新排程器。

az durabletask scheduler update [--acquire-policy-token]
                                [--add]
                                [--change-reference]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--ip-allowlist]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--public-network-access {Disabled, Enabled}]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--sku-capacity]
                                [--sku-name {Consumption, Dedicated}]
                                [--subscription]
                                [--tags]

範例

更新排程器的 IP 允許清單與標籤

az durabletask scheduler update --resource-group testrg --name testscheduler --ip-allowlist "[0.0.0.0/0]" --tags "{department:research}"

更新排程器以停用公共網路存取

az durabletask scheduler update --resource-group testrg --name testscheduler --public-network-access Disabled

選擇性參數

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

--acquire-policy-token

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

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

藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>.

屬性 值
參數群組: Generic Update Arguments
--change-reference

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

屬性 值
參數群組: Global Policy Arguments
--force-string

使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。

屬性 值
參數群組: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--ip-allowlist

長期工作排程器的IP允許清單。 值可以是 IPv4、IPv6 或 CIDR 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

屬性 值
參數群組: Properties Arguments
--name -n

排程器的名稱。

屬性 值
參數群組: Resource Id Arguments
--no-wait

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

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

允許或禁止對持久任務排程器的公共網路存取。

屬性 值
參數群組: Properties Arguments
接受的值: Disabled, Enabled
--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性 值
參數群組: Generic Update Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--set

指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>.

屬性 值
參數群組: Generic Update Arguments
--sku-capacity

SKU 容量。 這可讓資源相應放大/縮小,並影響區域備援。

屬性 值
參數群組: Sku Arguments
--sku-name

SKU 的名稱。

屬性 值
參數群組: Sku Arguments
接受的值: Consumption, Dedicated
--subscription

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

屬性 值
參數群組: Resource Id Arguments
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

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

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az durabletask scheduler wait

將 CLI 置於等候狀態,直到符合條件為止。

az durabletask scheduler wait [--acquire-policy-token]
                              [--change-reference]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--name]
                              [--resource-group]
                              [--subscription]
                              [--timeout]
                              [--updated]

選擇性參數

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

--acquire-policy-token

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

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

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

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

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

屬性 值
參數群組: Wait Condition Arguments
--deleted

等到刪除為止。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--exists

等候資源存在。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--interval

輪詢間隔以秒為單位。

屬性 值
參數群組: Wait Condition Arguments
預設值: 30
--name -n

排程器的名稱。

屬性 值
參數群組: Resource Id Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
--timeout

以秒為單位的等候上限。

屬性 值
參數群組: Wait Condition Arguments
預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
全域參數
--debug

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False