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

az databox job

注意

此参考是 Azure CLI（版本 2.48.0 或更高版本）的 Databox 扩展的一部分。 该扩展将在首次运行 az databox job 命令时自动安装。 详细了解扩展。

管理 Data Box 作业。

命令

名称	说明	类型	状态
az databox job cancel	CancelJob。	扩展	GA
az databox job create	使用指定的参数创建新作业。	分机	GA
az databox job delete	删除作业。	分机	GA
az databox job list	列出订阅下可用的所有作业。	分机	GA
az databox job list-credential	此方法获取与作业相关的未加密机密。	扩展	GA
az databox job mark-devices-shipped	请求将给定作业的设备标记为已发货。	分机	GA
az databox job show	获取有关指定作业的信息。	分机	GA
az databox job update	更新现有作业的属性。	扩展	GA

az databox job cancel

CancelJob。

az databox job cancel --reason
                      [--ids]
                      [--job-name]
                      [--resource-group]
                      [--subscription]
                      [--yes]

示例

取消作业

az databox job cancel -g rg --job-name name --reason reason

必需参数

--reason

取消的原因。

可选参数

--ids

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

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job create

使用指定的参数创建新作业。

az databox job create --job-name
                      --resource-group
                      --sku {DataBox, DataBoxCustomerDisk, DataBoxDisk, DataBoxHeavy}
                      --transfer-type {ExportFromAzure, ImportToAzure}
                      [--city]
                      [--company-name]
                      [--contact-name]
                      [--country]
                      [--data-box-customer-disk]
                      [--email-list]
                      [--expected-data-size]
                      [--identity]
                      [--kek-identity]
                      [--kek-type {CustomerManaged, MicrosoftManaged}]
                      [--kek-url]
                      [--kek-vault-resource-id]
                      [--location]
                      [--mobile]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--phone]
                      [--postal-code]
                      [--resource-group-for-managed-disk]
                      [--staging-storage-account]
                      [--state-or-province]
                      [--storage-account]
                      [--street-address1]
                      [--street-address2]
                      [--street-address3]
                      [--tags]
                      [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}]
                      [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}]
                      [--transfer-configuration-type {TransferAll, TransferUsingFilter}]
                      [--transfer-filter-details]

示例

创建作业

az databox job create -g rg -n job-name --sku databox --contact-name 'test' --phone 14258828080 --email-list testing@microsoft.com --street-address1 "1 MICROSOFT WAY" --city Redmond --state-or-province WA --country US --postal-code 98052 --company-name Microsoft --storage-account account-id --staging-storage-account account-id --resource-group-for-managed-disk rg --transfer-type ImportToAzure --kek-type MicrosoftManaged

必需参数

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--resource-group -g

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

--sku

SKU 名称。

接受的值: DataBox, DataBoxCustomerDisk, DataBoxDisk, DataBoxHeavy

--transfer-type

数据传输的类型。

接受的值: ExportFromAzure, ImportToAzure

可选参数

--city

城市的名称。

--company-name

公司的名称。

--contact-name

联系人的联系人姓名。

--country

国家/地区的名称。

--data-box-customer-disk

客户磁盘作业详细信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--email-list

要通知有关作业进度的电子邮件 ID 的列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--expected-data-size

需要在此作业中传输的数据的预期大小（以 TB 为单位）。

--identity

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

--kek-identity

用于密钥加密的托管标识属性。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--kek-type

用于密钥加密的加密密钥的类型。

接受的值: CustomerManaged, MicrosoftManaged

默认值: MicrosoftManaged

--kek-url

密钥加密密钥。 如果客户管理的 KekType，则需要它。

--kek-vault-resource-id

Kek 保管库资源 ID。如果客户管理的 KekType，则需要它。

--location -l

资源的位置。 这是受支持和注册的 Azure 区域之一（例如美国西部、美国东部、东南亚等）。 创建资源后，无法更改资源的区域，但如果在更新请求时指定了相同的区域，则请求将成功。 如果未指定，将使用资源组的位置。

--mobile

联系人的手机号码。

--no-wait

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

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

--phone

电话联系人的号码。

--postal-code

邮政编码。

--resource-group-for-managed-disk

计算磁盘的资源组 ID。

--staging-storage-account

可用于复制 vhd 进行暂存的存储帐户的资源 ID。

--state-or-province

州或省的名称。

--storage-account

目标存储帐户的空间分隔列表。 它可以是存储帐户的名称或资源 ID。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--street-address1

街道地址行 1。

--street-address2

街道地址行 2。

--street-address3

街道地址行 3。

--tags

描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--transfer-all-blobs

若要指示是否需要传输所有 Azure Blob。

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

默认值: False

--transfer-all-files

若要指示是否必须传输所有 Azure 文件。

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

默认值: False

--transfer-configuration-type

传输的配置类型。

接受的值: TransferAll, TransferUsingFilter

--transfer-filter-details

筛选器类型映射的路径和要筛选的详细信息。 支持 json-file 和 yaml-file。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job delete

删除作业。

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

示例

删除作业

az databox job delete -n job-name -g rg

可选参数

--ids

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

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--no-wait

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

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

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job list

列出订阅下可用的所有作业。

az databox job list [--resource-group]

示例

按资源组列出作业

az databox job list -g rg

可选参数

--resource-group -g

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job list-credential

此方法获取与作业相关的未加密机密。

az databox job list-credential [--ids]
                               [--job-name]
                               [--resource-group]
                               [--subscription]

示例

列出凭据

az databox job list-credential -g rg -n job-name

可选参数

--ids

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

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job mark-devices-shipped

请求将给定作业的设备标记为已发货。

az databox job mark-devices-shipped --deliver-package-details
                                    [--ids]
                                    [--job-name]
                                    [--resource-group]
                                    [--subscription]

示例

标记已发货的设备

az databox job mark-devices-shipped -g rg -n job-name

必需参数

--deliver-package-details

传递包详细信息支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

可选参数

--ids

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

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job show

获取有关指定作业的信息。

az databox job show [--ids]
                    [--job-name]
                    [--resource-group]
                    [--subscription]

示例

显示作业

az databox job show -g rg -n job-name

可选参数

--ids

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

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az databox job update

更新现有作业的属性。

az databox job update [--city]
                      [--company-name]
                      [--contact-name]
                      [--country]
                      [--email-list]
                      [--ids]
                      [--job-name]
                      [--kek-identity]
                      [--kek-type {CustomerManaged, MicrosoftManaged}]
                      [--kek-url]
                      [--kek-vault-resource-id]
                      [--mobile]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--phone]
                      [--postal-code]
                      [--resource-group]
                      [--state-or-province]
                      [--street-address1]
                      [--street-address2]
                      [--street-address3]
                      [--subscription]

示例

更新作业

az databox job update -g rg -n job-name --contact-name 'name --email-list email --phone phone-number

可选参数

--city

城市的名称。

--company-name

公司的名称。

--contact-name

联系人的联系人姓名。

--country

国家/地区的名称。

--email-list

要通知有关作业进度的电子邮件 ID 的列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--ids

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

--job-name --name -n

指定资源组中作业资源的名称。 作业名称的长度必须介于 3 到 24 个字符之间，并且仅使用任何字母数字和下划线。

--kek-identity

用于密钥加密的托管标识属性。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--kek-type

用于密钥加密的加密密钥的类型。

接受的值: CustomerManaged, MicrosoftManaged

--kek-url

密钥加密密钥。 如果客户管理的 KekType，则需要它。

--kek-vault-resource-id

Kek 保管库资源 ID。如果客户管理的 KekType，则需要它。

--mobile

联系人的手机号码。

--no-wait

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

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

--phone

电话联系人的号码。

--postal-code

邮政编码。

--resource-group -g

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

--state-or-province

州或省的名称。

--street-address1

街道地址行 1。

--street-address2

街道地址行 2。

--street-address3

街道地址行 3。

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。