Share via

az databoxedge device user

Manage device user.

Commands

Name Description Type Status
az databoxedge device user create

Create user on a Data Box Edge/Data Box Gateway device.

 Core GA
az databoxedge device user delete

Delete the user on a databox edge/gateway device.

 Core GA
az databoxedge device user list

List all the users registered on a Data Box Edge/Data Box Gateway device.

 Core GA
az databoxedge device user show

Show user.

 Core GA
az databoxedge device user update

Update user on a Data Box Edge/Data Box Gateway device.

 Core GA

az databoxedge device user create

Edit

Create user on a Data Box Edge/Data Box Gateway device.

az databoxedge device user create --device-name
                                  --name
                                  --resource-group
                                  --user-type {ARM, LocalManagement, Share}
                                  [--encrypted-password]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create user

az databoxedge device user create -g rg --device-name name --user-type Share -n username --encrypted-password "{value:xxx,encryptionCertThumbprint:xxx,encryptionAlgorithm:AES256}"

Required Parameters

--device-name

The device name.

--name -n

The user name.

--resource-group -g

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

--user-type

Type of the user.

Property Value
Parameter group: Properties Arguments
Accepted values: ARM, LocalManagement, Share

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--encrypted-password

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

Property Value
Parameter group: Properties Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az databoxedge device user delete

Edit

Delete the user on a databox edge/gateway device.

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

Examples

Delete user

az databoxedge device user delete -g rg --device-name name  -n username

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-name

The device name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The user name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az databoxedge device user list

Edit

List all the users registered on a Data Box Edge/Data Box Gateway device.

az databoxedge device user list --device-name
                                --resource-group
                                [--filter]
                                [--max-items]
                                [--next-token]

Examples

List user

az databoxedge device user list -g rg --device-name name

Required Parameters

--device-name

The device name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

Specify $filter='Type eq <type>' to filter on user type property.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az databoxedge device user show

Edit

Show user.

az databoxedge device user show [--device-name]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Show user

az databoxedge device user show -g rg --device-name name -n username

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-name

The device name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The user name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az databoxedge device user update

Edit

Update user on a Data Box Edge/Data Box Gateway device.

az databoxedge device user update [--add]
                                  [--device-name]
                                  [--encrypted-password]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--user-type {ARM, LocalManagement, Share}]

Examples

Update user

az databoxedge device user update -g rg --device-name name --user-type ARM-n username --encrypted-password "{value:xxx,encryptionCertThumbprint:xxx,encryptionAlgorithm:AES256}"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--device-name

The device name.

Property Value
Parameter group: Resource Id Arguments
--encrypted-password

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

Property Value
Parameter group: Properties Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The user name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--user-type

Type of the user.

Property Value
Parameter group: Properties Arguments
Accepted values: ARM, LocalManagement, Share
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False