az databox job

注意

此參考是 Azure CLI 的 Databox 延伸模組的一部分 (2.48.0 版或更高版本)。 擴充功能會在您第一次執行 az databox job 命令時自動安裝。 深入了解擴充功能。

管理資料箱作業。

命令

名稱 Description 類型 狀態
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

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

--job-name --name -n

指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間,且只使用任何英數位元和底線。

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

要通知作業進度的電子郵件識別碼清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--expected-data-size

此作業中需要以 TB 為單位傳輸的資料預期大小。

--identity

資源的 Msi 身分識別支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--kek-identity

用於金鑰加密的受控識別屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--kek-type

用於金鑰加密的加密金鑰類型。

接受的值: CustomerManaged, MicrosoftManaged
預設值: MicrosoftManaged
--kek-url

金鑰加密金鑰。 如果是客戶管理的 KekType,則為必要專案。

--kek-vault-resource-id

Kek 保存庫資源識別碼。如果是客戶管理的 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

計算磁片的資源群組識別碼。

--staging-storage-account

可用來複製 vhd 以進行預備的儲存體帳戶資源識別碼。

--state-or-province

州或省的名稱。

--storage-account

目的地儲存體帳戶的空間分隔清單。 它可以是儲存體帳戶的名稱或資源識別碼。 支援速記語法、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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

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

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

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

--job-name --name -n

指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間,且只使用任何英數位元和底線。

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

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

--job-name --name -n

指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間,且只使用任何英數位元和底線。

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

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

--job-name --name -n

指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間,且只使用任何英數位元和底線。

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

要通知作業進度的電子郵件識別碼清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--ids

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

--job-name --name -n

指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間,且只使用任何英數位元和底線。

--kek-identity

用於金鑰加密的受控識別屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--kek-type

用於金鑰加密的加密金鑰類型。

接受的值: CustomerManaged, MicrosoftManaged
--kek-url

金鑰加密金鑰。 如果是客戶管理的 KekType,則為必要專案。

--kek-vault-resource-id

Kek 保存庫資源識別碼。如果是客戶管理的 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。