az databox

Reference

Note

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

Manage data box.

Commands

Name	Description	Type	Status
az databox available-skus	This method provides the list of available skus for the given subscription, resource group and ___location.	Extension	GA
az databox job	Manage data box job.	Extension	GA
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 mitigate	Request to mitigate for a given job.	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 available-skus

This method provides the list of available skus for the given subscription, resource group and ___location.

az databox available-skus --country
                          --resource-group
                          --transfer-type {ExportFromAzure, ImportToAzure}
                          [--___location]
                          [--max-items]
                          [--next-token]
                          [--sku-names]

Examples

AvailableSkusPost

az databox available-skus --g YourResourceGroupName --country US --l westus --transfer-type ImportToAzure

Required Parameters

--country

ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements.

--resource-group -g

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

--transfer-type

Type of the transfer.

Accepted values: ExportFromAzure, ImportToAzure

Optional Parameters

--___location -l

Location. Values from: az account list-locations. You can configure the default ___location using az configure --defaults ___location=<___location>. When not specified, the ___location of the resource group will be used.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--sku-names

Sku Names to filter for available skus Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.