az databoxedge device share
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
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 to be used by the share.
The device name.
Current monitoring status of the share.
The share name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Current status of the share.
Optional Parameters
Azure container mapping for the share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 of the share.
Description for the share.
Do not wait for the long-running operation to finish.
Details of the refresh job on this share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az databoxedge device share delete
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 nameOptional Parameters
The device name.
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.
The share name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az databoxedge device share list
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 nameRequired Parameters
The device name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az databoxedge device share show
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 nameOptional Parameters
The device name.
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.
The share name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az databoxedge device share update
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 testOptional Parameters
Access protocol to be used by the share.
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 mapping for the share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 of the share.
Description for the share.
The device name.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Current monitoring status of the share.
The share name.
Do not wait for the long-running operation to finish.
Details of the refresh job on this share. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Current status of the share.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for