az databoxedge device share

Manage device share.

Commands

Name	Description	Type	Status
az databoxedge device share create	Create share on the device.	Core	GA
az databoxedge device share delete	Delete the share on the Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device share list	List all the shares in a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device share show	Show share.	Core	GA
az databoxedge device share update	Update share on the device.	Core	GA

Edit

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]

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}'

--access-protocol

Access protocol to be used by the share.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	NFS, SMB

--device-name

The device name.

--monitoring-status

Current monitoring status of the share.

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	NeedsAttention, OK, Offline, Unknown, Updating

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

--azure-container-info

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

--data-policy

Data policy of the share.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Cloud, Local

--description

Description for the share.

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

--refresh-details

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties 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

Edit

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]

Delete share

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

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

Edit

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]

List share

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

--device-name

The device name.

--resource-group -g

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

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

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

Edit

Show share.

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

Show share

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

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The share 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

Edit

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]

Update share

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

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

--access-protocol

Access protocol to be used by the share.

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

Property	Value
Parameter group:	Generic Update Arguments

--azure-container-info

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

--data-policy

Data policy of the share.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Cloud, Local

--description

Description for the share.

Property	Value
Parameter group:	Properties Arguments

--device-name

The device name.

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

Property	Value
Parameter group:	Resource Id Arguments

--monitoring-status

Current monitoring status of the share.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--name -n

The share 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

--refresh-details

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

Property	Value
Parameter group:	Properties Arguments

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

--share-status

Current status of the share.

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Properties 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

Feedback

Was this page helpful?

Share via

az databoxedge device share

Commands

az databoxedge device share create

Examples

Required Parameters

Optional Parameters

az databoxedge device share delete

Examples

Optional Parameters

az databoxedge device share list

Examples

Required Parameters

Optional Parameters

az databoxedge device share show

Examples

Optional Parameters

az databoxedge device share update

Examples

Optional Parameters

Feedback