az databox job
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 reasonRequired Parameters
Reason for cancellation.
Optional Parameters
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.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 MicrosoftManagedRequired Parameters
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The sku name.
Type of the data transfer.
Optional Parameters
Name of the city.
Name of the company.
Contact name of the person.
Name of the Country.
Customer disk job details. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of Email-ids to be notified about job progress. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The expected size of the data, which needs to be transferred in this job, in terabytes.
Msi identity of the resource Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Managed identity properties used for key encryption. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Type of encryption key used for key encryption.
Key encryption key. It is required in case of Customer managed KekType.
Kek vault resource id. It is required in case of Customer managed KekType.
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 number of the contact person.
Do not wait for the long-running operation to finish.
Phone number of the contact person.
Postal code.
Resource Group Id of the compute disks.
Resource Id of the storage account that can be used to copy the vhd for staging.
Name of the State or Province.
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 Address line 1.
Street Address line 2.
Street Address line 3.
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.
To indicate if all Azure blobs have to be transferred.
To indicate if all Azure files have to be transferred.
Type of the configuration for transfer.
Path to the map of filter type and the details to filter. Support json-file and yaml-file.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 rgOptional Parameters
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.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 rgOptional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-nameOptional Parameters
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.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-nameRequired Parameters
Delivery package details Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
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.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-nameOptional Parameters
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.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-numberOptional Parameters
Name of the city.
Name of the company.
Contact name of the person.
Name of the Country.
List of Email-ids to be notified about job progress. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
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.
Managed identity properties used for key encryption. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Type of encryption key used for key encryption.
Key encryption key. It is required in case of Customer managed KekType.
Kek vault resource id. It is required in case of Customer managed KekType.
Mobile number of the contact person.
Do not wait for the long-running operation to finish.
Phone number of the contact person.
Postal code.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the State or Province.
Street Address line 1.
Street Address line 2.
Street Address line 3.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for