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

az storage-actions task

Note

此参考是 Azure CLI(版本 2.70.0 或更高版本)的 存储作 扩展的一部分。 该扩展会在首次运行 az storage-actions task 命令时自动安装。 了解更多关于扩展的信息。

管理 StorageTask。

命令

名称 说明 类型 Status
az storage-actions task create

使用指定的参数创建新的存储任务资源。 如果已创建存储任务,并发出具有不同属性的后续创建请求,则会更新存储任务属性。 如果已创建存储任务,并且后续创建请求使用完全相同的属性集发出,则请求将成功。

Extension GA
az storage-actions task delete

删除存储任务资源。

Extension GA
az storage-actions task list

列出订阅下可用的所有存储任务。

Extension GA
az storage-actions task list-assignment

列出给定资源组下可用的所有存储任务分配。

Extension GA
az storage-actions task list-report

列出每个分配的存储任务运行报告摘要。

Extension GA
az storage-actions task preview-action

针对输入对象元数据属性运行输入条件,并在响应中指定匹配的对象。

Extension GA
az storage-actions task show

获取存储任务属性。

Extension GA
az storage-actions task update

使用指定的参数更新存储任务资源。 如果已创建存储任务并发出具有不同属性的后续更新请求,则会更新存储任务属性。 如果已创建存储任务,并且后续更新请求使用完全相同的属性集发出,则请求将成功。

Extension GA
az storage-actions task wait

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

Extension GA

az storage-actions task create

使用指定的参数创建新的存储任务资源。 如果已创建存储任务,并发出具有不同属性的后续创建请求,则会更新存储任务属性。 如果已创建存储任务,并且后续创建请求使用完全相同的属性集发出,则请求将成功。

az storage-actions task create --action
                               --description
                               --enabled {0, 1, f, false, n, no, t, true, y, yes}
                               --identity
                               --name --storage-task-name
                               --resource-group
                               [--location]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--tags]

示例

存储作任务创建

az storage-actions task create -g rgteststorageactions -n testtask1 --identity "{type:SystemAssigned}" --tags "{key1:value1}" --action "{if:{condition:'[[equals(AccessTier,'/Cool'/)]]',operations:[{name:'SetBlobTier',parameters:{tier:'Hot'},onSuccess:'continue',onFailure:'break'}]},else:{operations:[{name:'DeleteBlob',onSuccess:'continue',onFailure:'break'}]}}" --description StorageTask1 --enabled true

必需参数

--action

执行的存储任务作支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--description

描述存储任务用途的文本。

属性
参数组: Properties Arguments
--enabled

将存储任务设置为 true 时启用,设置为 false 时禁用。

属性
参数组: Properties Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--identity

资源的托管服务标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Parameters Arguments
--name --storage-task-name -n

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

--resource-group -g

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

可选参数

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

--location -l

未指定资源所在的地理位置,将使用资源组的位置。

属性
参数组: Parameters Arguments
--no-wait

不等待长时间运行的操作完成。

属性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Parameters 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 storage-actions task delete

删除存储任务资源。

az storage-actions task delete [--ids]
                               [--name --storage-task-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--subscription]
                               [--yes]

示例

storage-actions 任务删除

az storage-actions task delete -g rgteststorageactions -n testtask1

可选参数

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

--ids

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

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

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

属性
参数组: 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 storage-actions task list

列出订阅下可用的所有存储任务。

az storage-actions task list [--max-items]
                             [--next-token]
                             [--resource-group]

示例

storage-actions 任务列表

az storage-actions task list -g rgteststorageactions

可选参数

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

--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 storage-actions task list-assignment

列出给定资源组下可用的所有存储任务分配。

az storage-actions task list-assignment --name --storage-task-name
                                        --resource-group
                                        [--max-items]
                                        [--maxpagesize]
                                        [--next-token]

示例

storage-actions 任务列表分配

az storage-actions task list-assignment -g rgteststorageactions -n testtask1

必需参数

--name --storage-task-name -n

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

--resource-group -g

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

可选参数

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

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的 --next-token 参数中提供令牌值。

属性
参数组: Pagination Arguments
--maxpagesize

可选,指定要包含在列表响应中的存储任务分配 ID 的最大数目。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性
参数组: Pagination 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 storage-actions task list-report

列出每个分配的存储任务运行报告摘要。

az storage-actions task list-report --name --storage-task-name
                                    --resource-group
                                    [--filter]
                                    [--max-items]
                                    [--maxpagesize]
                                    [--next-token]

示例

storage-actions 任务列表-报表

az storage-actions task list-report -g rgteststorageactions -n testtask1

必需参数

--name --storage-task-name -n

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

--resource-group -g

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

可选参数

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

--filter

Optional. 指定后,它可用于使用报告属性进行查询。

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的 --next-token 参数中提供令牌值。

属性
参数组: Pagination Arguments
--maxpagesize

可选,指定要包含在列表响应中的存储任务分配 ID 的最大数目。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性
参数组: Pagination 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 storage-actions task preview-action

针对输入对象元数据属性运行输入条件,并在响应中指定匹配的对象。

az storage-actions task preview-action --action
                                       --blobs
                                       --container
                                       [--ids]
                                       [--location]
                                       [--subscription]

示例

storage-actions 任务预览作

az storage-actions task preview-action -l eastus2euap --action "{if:{condition:'[[equals(AccessTier,'/Cool'/)]]'},else-block-exists:True}" --blobs "[{name:'folder2/file1.txt',properties:[{key:'Creation-Time',value:'Wed, 06 Jun 2023 05:23:29 GMT'},{key:'Last-Modified',value:'Wed, 06 Jun 2023 05:23:29 GMT'},{key:'Etag',value:'0x6FB67175454D36D'}],metadata:[{key:'mKey2',value:'mValue2'}],tags:[{key:'tKey2',value:'tValue2'}]}]" --container "{name:'firstContainer',metadata:[{key:'mContainerKey1',value:'mContainerValue1'}]}"

必需参数

--action

预览作容器属性,以便针对提供的匹配项进行测试。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--blobs

预览作容器属性,以便针对提供的匹配项进行测试。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--container

预览作容器属性,以便针对提供的匹配项进行测试。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments

可选参数

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

--ids

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

属性
参数组: Resource Id Arguments
--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

属性
参数组: 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 storage-actions task show

获取存储任务属性。

az storage-actions task show [--ids]
                             [--name --storage-task-name]
                             [--resource-group]
                             [--subscription]

示例

存储作任务显示

az storage-actions task show -g rgteststorageactions -n testtask1

可选参数

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

--ids

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

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

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

属性
参数组: 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 storage-actions task update

使用指定的参数更新存储任务资源。 如果已创建存储任务并发出具有不同属性的后续更新请求,则会更新存储任务属性。 如果已创建存储任务,并且后续更新请求使用完全相同的属性集发出,则请求将成功。

az storage-actions task update [--action]
                               [--add]
                               [--description]
                               [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--identity]
                               [--ids]
                               [--name --storage-task-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--tags]

示例

storage-actions 任务更新

az storage-actions task update -g rgteststorageactions -n testtask1 --identity "{type:SystemAssigned}" --tags "{key2:value2}" --action "{if:{condition:'[[equals(BlobType,'/BlockBlob'/)]]',operations:[{name:'SetBlobTags',parameters:{Archive-Status:'Archived'},onSuccess:'continue',onFailure:'break'}]},else:{operations:[{name:'UndeleteBlob',onSuccess:'continue',onFailure:'break'}]}}" --description StorageTask1Update --enabled true

可选参数

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

--action

执行的存储任务作支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>

属性
参数组: Generic Update Arguments
--description

描述存储任务用途的文本。

属性
参数组: Properties Arguments
--enabled

将存储任务设置为 true 时启用,设置为 false 时禁用。

属性
参数组: Properties Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

属性
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--identity

资源的托管服务标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Parameters Arguments
--ids

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

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

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

属性
参数组: Resource Id Arguments
--no-wait

不等待长时间运行的操作完成。

属性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--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
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Parameters 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 storage-actions task wait

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

az storage-actions task wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name --storage-task-name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

可选参数

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

--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 --storage-task-name -n

指定资源组中的存储任务的名称。 存储任务名称长度必须介于 3 到 18 个字符之间,并且仅使用数字和小写字母。

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