Share via

az databoxedge device share

  • Preview
  • Reference

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage device share.

Commands

Name Description Type Status
az databoxedge device share create

Create share on the device.

 Core Preview
az databoxedge device share delete

Delete the share on the Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device share list

List all the shares in a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device share show

Show share.

 Core Preview
az databoxedge device share update

Update share on the device.

 Core Preview

az databoxedge device share create

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create share on the device.

az databoxedge device share create --access-protocol {NFS, SMB}
                                   --device-name
                                   --monitoring-status {Disabled, Enabled}
                                   --name
                                   --resource-group
                                   --share-status {NeedsAttention, OK, Offline, Unknown, Updating}
                                   [--azure-container-info]
                                   [--client-access-rights]
                                   [--data-policy {Cloud, Local}]
                                   [--description]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--refresh-details]
                                   [--user-access-rights]

Examples

Create share

az databoxedge device share create -g rg -n share-name --device-name name --access-protocol NFS --monitoring-status Enabled --share-status OK --azure-container-info '{containerName:testContainer,dataFormat:BlockBlob,storageAccountCredentialId:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/accountname}'

Required Parameters

--access-protocol

Access protocol to be used by the share.

Accepted values: NFS, SMB
--device-name

The device name.

--monitoring-status

Current monitoring status of the share.

Accepted values: Disabled, Enabled
--name -n

The share name.

--resource-group -g

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

--share-status

Current status of the share.

Accepted values: NeedsAttention, OK, Offline, Unknown, Updating

Optional Parameters

--azure-container-info

Azure container mapping for the share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--client-access-rights

List of IP addresses and corresponding access rights on the share(required for NFS protocol). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--data-policy

Data policy of the share.

Accepted values: Cloud, Local
--description

Description for the share.

--no-wait

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

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

Details of the refresh job on this share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-access-rights

Mapping of users and corresponding access rights on the share (required for SMB protocol). 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.

az databoxedge device share delete

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the share on the Data Box Edge/Data Box Gateway device.

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

Examples

Delete share

az databoxedge device share delete -g rg -n share-name --device-name name

Optional Parameters

--device-name

The device name.

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

--name -n

The share name.

--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 databoxedge device share list

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the shares in a Data Box Edge/Data Box Gateway device.

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

Examples

List share

az databoxedge device share 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

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

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 databoxedge device share show

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show share.

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

Examples

Show share

az databoxedge device share show -g rg -n share-name --device-name name

Optional Parameters

--device-name

The device name.

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

--name -n

The share name.

--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 databoxedge device share update

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update share on the device.

az databoxedge device share update [--access-protocol {NFS, SMB}]
                                   [--add]
                                   [--azure-container-info]
                                   [--client-access-rights]
                                   [--data-policy {Cloud, Local}]
                                   [--description]
                                   [--device-name]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--monitoring-status {Disabled, Enabled}]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--refresh-details]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--share-status {NeedsAttention, OK, Offline, Unknown, Updating}]
                                   [--subscription]
                                   [--user-access-rights]

Examples

Update share

az databoxedge device share update -g rg -n share-name --device-name name --description test

Optional Parameters

--access-protocol

Access protocol to be used by the share.

Accepted values: NFS, SMB
--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>.

--azure-container-info

Azure container mapping for the share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--client-access-rights

List of IP addresses and corresponding access rights on the share(required for NFS protocol). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--data-policy

Data policy of the share.

Accepted values: Cloud, Local
--description

Description for the share.

--device-name

The device name.

--force-string

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

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.

--monitoring-status

Current monitoring status of the share.

Accepted values: Disabled, Enabled
--name -n

The share name.

--no-wait

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

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

Details of the refresh job on this share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

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

--resource-group -g

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

--set

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

--share-status

Current status of the share.

Accepted values: NeedsAttention, OK, Offline, Unknown, Updating
--subscription

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

--user-access-rights

Mapping of users and corresponding access rights on the share (required for SMB protocol). 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.