az databox job

Commands to manage databox job.

Commands

az databox job cancel

Cancel a job.

az databox job create

Create a new job with the specified parameters.

az databox job delete

Delete a job.

az databox job list

List all the jobs available under the given resource group or the given subscription.

az databox job list-credentials

List the unencrypted secrets related to the job.

az databox job show

Get information about the specified job.

az databox job update

Update an existing job with the specified parameters.

az databox job cancel

Cancel a job.

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

Examples

Cancel the job "SdkJob3971" under resource group "SdkRg4981".

az databox job cancel --resource-group "SdkRg4981" --name "SdkJob3971" --reason "CancelTest"

Required Parameters

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

--reason

Reason for cancellation.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

az databox job create

Create a new job with the specified parameters.

az databox job create --city
                      --contact-name
                      --country
                      --email-list
                      --location
                      --name
                      --phone
                      --postal-code
                      --resource-group
                      --sku {DataBox, DataBoxDisk, DataBoxHeavy}
                      --state-or-province
                      --street-address1
                      [--company-name]
                      [--expected-data-size]
                      [--mobile]
                      [--resource-group-for-managed-disk]
                      [--staging-storage-account]
                      [--storage-accounts]
                      [--street-address2]
                      [--street-address3]
                      [--tags]

Examples

Create a databox job to use both storage account and managed disk as data destination.

az databox job create --resource-group "SdkRg4981" --name "SdkJob3971" --location \
"westus" --sku "DataBox" --contact-name "Public SDK Test" \
--phone "1234567890" --email-list "testing@microsoft.com" \
--street-address1 "16 TOWNSEND ST" --street-address2 "Unit 1" --city "San Francisco"  \
--state-or-province "CA" --country "US" --postal-code "94107" --company-name "Microsoft" \
--storage-account sa1 sa2 --staging-storage-account sa \
--resource-group-for-managed-disk /subscriptions/sub/resourceGroups/rg

Create a databoxdisk job to use storage account as data destination.

az databox job create --resource-group "SdkRg4981" --name "SdkJob3971" --location \
"westus" --sku "DataBoxDisk" --expected-data-size 1 --contact-name "Public SDK Test" \
--phone "1234567890" --email-list "testing@microsoft.com" --street-address1 "16 TOWNSEND ST" \
--street-address2 "Unit 1" --city "San Francisco" --state-or-province "CA" --country "US" \
--postal-code "94107" --company-name "Microsoft" --storage-account sa1

Required Parameters

--city

Name of the City.

--contact-name

Contact name of the person.

--country

Name of the Country. Ex: US.

--email-list

Space-separated list of Email addresses to be notified about job progress.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

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

--sku

The sku type of DataBox.

accepted values: DataBox, DataBoxDisk, DataBoxHeavy
--state-or-province

Name of the State or Province.

--street-address1

Street Address line 1.

Optional Parameters

--company-name

Name of the company.

--expected-data-size

The expected size of the data which needs to be transferred in this job, in terabytes.The maximum usable capacity is up to 35 TB. This is only needed when sku is DataBoxDisk.

--mobile

Mobile number of the contact person.

--resource-group-for-managed-disk

The name or ID of the destination resource group where the Compute disks should be created.

--staging-storage-account

The name or ID of the destination storage account that can be used to copy the vhd for staging.

--storage-accounts

Space-separated list of the destination storage account. It can be the name or resource ID of storage account.

--street-address2

Street Address line 2.

--street-address3

Street Address line 3.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az databox job delete

Delete a job.

az databox job delete --name
                      --resource-group
                      [--yes]

Examples

Delete the job "SdkJob3971" in resource group "SdkRg4981".

az databox job delete --resource-group "SdkRg4981" --name "SdkJob3971"

Required Parameters

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

az databox job list

List all the jobs available under the given resource group or the given subscription.

az databox job list [--resource-group]

Examples

List all the jobs available under the current subscription.

az databox job list

List all the jobs available under the resource group "SdkRg4981".

az databox job list --resource-group "SdkRg4981"

Optional Parameters

--resource-group -g

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

az databox job list-credentials

List the unencrypted secrets related to the job.

az databox job list-credentials --name
                                --resource-group

Examples

List the unencrypted secrets related to the job "TJ-636646322037905056".

az databox job list-credentials --resource-group "bvttoolrg6" --name "TJ-636646322037905056"

Required Parameters

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

az databox job show

Get information about the specified job.

az databox job show --name
                    --resource-group

Examples

Get the information about the job "SdkJob3971".

az databox job show --resource-group "SdkRg4981" --name "SdkJob3971"

Required Parameters

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

az databox job update

Update an existing job with the specified parameters.

az databox job update --name
                      --resource-group
                      [--city]
                      [--company-name]
                      [--contact-name]
                      [--country]
                      [--email-list]
                      [--mobile]
                      [--phone]
                      [--postal-code]
                      [--state-or-province]
                      [--street-address1]
                      [--street-address2]
                      [--street-address3]

Examples

Update the job "SdkJob3971" with the specified parameters.

az databox job update --resource-group "SdkRg4981" --name "SdkJob3971" \
--contact-name "Update Job" --phone "1234567890" \
--email-list "testing@microsoft.com" \
--street-address1 "16 TOWNSEND ST" \
--city "San Francisco" --state-or-province "CA" \
--country "US" --postal-code "94107" \
--company-name "Microsoft" \

Required Parameters

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

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. Ex: US.

--email-list

List of Email addresses to be notified about job progress.

--mobile

Mobile number of the contact person.

--phone

Phone number of the contact person.

--postal-code

Postal code.

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