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

az durabletask scheduler

Note

此引用是 Azure CLI 的 durabletask 扩展的一部分（版本 2.75.0 或更高版本）。 该扩展将在首次运行 az durabletask scheduler 命令时自动安装。 了解更多关于扩展的信息。

用于管理 Durabletask 计划程序命令。

命令

名称 说明 类型 Status
az durabletask scheduler attach

[实验性]将持久任务计划程序附加到函数应用或容器应用。

 Extension GA
az durabletask scheduler create

创建计划程序。

 Extension GA
az durabletask scheduler delete

删除计划程序。

 Extension GA
az durabletask scheduler list

按订阅列出计划程序。

 Extension GA
az durabletask scheduler show

获取计划程序。

 Extension GA
az durabletask scheduler update

更新计划程序。

 Extension GA
az durabletask scheduler wait

将 CLI 置于等待状态，直到满足条件。

 Extension GA

az durabletask scheduler attach

[实验性]将持久任务计划程序附加到函数应用或容器应用。

此命令是实验性的，将来的版本中可能会更改。

将 Durable Task 角色分配给目标资源的托管标识，并使用计划程序终结点和任务中心名称配置目标的应用程序设置或环境变量。

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

示例

将计划程序附加到具有辅助角色的函数应用

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

Durable Task 计划程序的名称。

--resource-group -g

包含计划程序的资源组的名称。

--role-type

要分配给目标托管标识的角色类型。

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

目标函数应用或容器应用的资源 ID。

--task-hub-name

Durable Task 任务中心的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--identity

用户分配的托管标识的资源 ID。 如果省略，则使用系统分配的托管标识。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--name -n

计划程序的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: 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> OR --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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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