az databox job

  • Reference

Note

This reference is part of the databox extension for the Azure CLI (version 2.48.0 or higher). The extension will automatically install the first time you run an az databox job command. Learn more about extensions.

Manage data box job.

Commands

Name Description Type Status
az databox job cancel

CancelJob.

 Extension GA
az databox job create

Create a new job with the specified parameters.

 Extension GA
az databox job delete

Delete a job.

 Extension GA
az databox job list

List all the jobs available under the subscription.

 Extension GA
az databox job list-credential

This method gets the unencrypted secrets related to the job.

 Extension GA
az databox job mark-devices-shipped

Request to mark devices for a given job as shipped.

 Extension GA
az databox job show

Get information about the specified job.

 Extension GA
az databox job update

Update the properties of an existing job.

 Extension GA

az databox job cancel

CancelJob.

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

Examples

Cancel job

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

Required Parameters

--reason

Reason for cancellation.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job create

Create a new job with the specified parameters.

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]

Examples

Create job

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

Required Parameters

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

The sku name.

Accepted values: DataBox, DataBoxCustomerDisk, DataBoxDisk, DataBoxHeavy
--transfer-type

Type of the data transfer.

Accepted values: ExportFromAzure, ImportToAzure

Optional Parameters

--city

Name of the city.

--company-name

Name of the company.

--contact-name

Contact name of the person.

--country

Name of the Country.

--data-box-customer-disk

Customer disk job details. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--email-list

List of Email-ids to be notified about job progress. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--expected-data-size

The expected size of the data, which needs to be transferred in this job, in terabytes.

--identity

Msi identity of the resource Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--kek-identity

Managed identity properties used for key encryption. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--kek-type

Type of encryption key used for key encryption.

Accepted values: CustomerManaged, MicrosoftManaged
Default value: MicrosoftManaged
--kek-url

Key encryption key. It is required in case of Customer managed KekType.

--kek-vault-resource-id

Kek vault resource id. It is required in case of Customer managed KekType.

--location -l

The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed. When not specified, the location of the resource group will be used.

--mobile

Mobile number of the contact person.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--phone

Phone number of the contact person.

--postal-code

Postal code.

--resource-group-for-managed-disk

Resource Group Id of the compute disks.

--staging-storage-account

Resource Id of the storage account that can be used to copy the vhd for staging.

--state-or-province

Name of the State or Province.

--storage-account

Space-separated list of the destination storage account. It can be the name or resource ID of storage account. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--street-address1

Street Address line 1.

--street-address2

Street Address line 2.

--street-address3

Street Address line 3.

--tags

The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--transfer-all-blobs

To indicate if all Azure blobs have to be transferred.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Default value: False
--transfer-all-files

To indicate if all Azure files have to be transferred.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Default value: False
--transfer-configuration-type

Type of the configuration for transfer.

Accepted values: TransferAll, TransferUsingFilter
--transfer-filter-details

Path to the map of filter type and the details to filter. Support json-file and yaml-file.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job delete

Delete a job.

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

Examples

Delete job

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job list

List all the jobs available under the subscription.

az databox job list [--resource-group]

Examples

List job by resource group

az databox job list -g rg

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job list-credential

This method gets the unencrypted secrets related to the job.

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

Examples

List credential

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job mark-devices-shipped

Request to mark devices for a given job as shipped.

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

Examples

Mark devices shipped

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

Required Parameters

--deliver-package-details

Delivery package details Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job show

Get information about the specified job.

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

Examples

Show job

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databox job update

Update the properties of an existing job.

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]

Examples

Update job

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

Optional Parameters

--city

Name of the city.

--company-name

Name of the company.

--contact-name

Contact name of the person.

--country

Name of the Country.

--email-list

List of Email-ids to be notified about job progress. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--job-name --name -n

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--kek-identity

Managed identity properties used for key encryption. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--kek-type

Type of encryption key used for key encryption.

Accepted values: CustomerManaged, MicrosoftManaged
--kek-url

Key encryption key. It is required in case of Customer managed KekType.

--kek-vault-resource-id

Kek vault resource id. It is required in case of Customer managed KekType.

--mobile

Mobile number of the contact person.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--phone

Phone number of the contact person.

--postal-code

Postal code.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--state-or-province

Name of the State or Province.

--street-address1

Street Address line 1.

--street-address2

Street Address line 2.

--street-address3

Street Address line 3.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.