Share via

az dls fs access

  • Preview

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

Manage Data Lake Store filesystem access and permissions.

Commands

Name Description Type Status
az dls fs access remove-all

Remove the access control list for a file or folder.

 Core Preview
az dls fs access remove-entry

Remove entries for the access control list of a file or folder.

 Core Preview
az dls fs access set

Replace the existing access control list for a file or folder.

 Core Preview
az dls fs access set-entry

Update the access control list for a file or folder.

 Core Preview
az dls fs access set-owner

Set the owner information for a file or folder in a Data Lake Store account.

 Core Preview
az dls fs access set-permission

Set the permissions for a file or folder in a Data Lake Store account.

 Core Preview
az dls fs access show

Display the access control list (ACL).

 Core Preview

az dls fs access remove-all

Edit
Preview

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

Remove the access control list for a file or folder.

az dls fs access remove-all --path
                            [--account]
                            [--default-acl]
                            [--ids]
                            [--subscription]

Examples

Remove the access control list for a file or folder. (autogenerated)

az dls fs access remove-all --account dpreptestfiles --path / --subscription MySubscription

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

Property Value
Parameter group: Resource Id Arguments
--default-acl

A switch that, if specified, indicates that the remove ACL operation should remove the default ACL of the folder. Otherwise the regular ACL is removed.

Property Value
Default value: False
--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
--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 dls fs access remove-entry

Edit
Preview

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

Remove entries for the access control list of a file or folder.

az dls fs access remove-entry --acl-spec
                              --path
                              [--account]
                              [--ids]
                              [--subscription]

Examples

Remove entries for the access control list of a file or folder. (autogenerated)

az dls fs access remove-entry --account dpreptestfiles --acl-spec user:00000000-0000-0000-0000-000000000000:-w- --path /

Required Parameters

--acl-spec

The ACL specification to set on the path in the format '[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,...'.

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

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
--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 dls fs access set

Edit
Preview

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

Replace the existing access control list for a file or folder.

az dls fs access set --acl-spec
                     --path
                     [--account]
                     [--ids]
                     [--subscription]

Examples

Replace the existing access control list for a file or folder. (autogenerated)

az dls fs access set --account dpreptestfiles --acl-spec user:00000000-0000-0000-0000-000000000000:-w- --path / --subscription MySubscription

Required Parameters

--acl-spec

The ACL specification to set on the path in the format '[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,...'.

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

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
--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 dls fs access set-entry

Edit
Preview

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

Update the access control list for a file or folder.

az dls fs access set-entry --acl-spec
                           --path
                           [--account]
                           [--ids]
                           [--subscription]

Examples

Update the access control list for a file or folder. (autogenerated)

az dls fs access set-entry --account dpreptestfiles --acl-spec user:00000000-0000-0000-0000-000000000000:-w- --path /

Required Parameters

--acl-spec

The ACL specification to set on the path in the format '[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,...'.

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

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
--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 dls fs access set-owner

Edit
Preview

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

Set the owner information for a file or folder in a Data Lake Store account.

az dls fs access set-owner --path
                           [--account]
                           [--group]
                           [--ids]
                           [--owner]
                           [--subscription]

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

Property Value
Parameter group: Resource Id Arguments
--group

The group Azure Active Directory object ID or user principal name to set as the owning group.

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

The user Azure Active Directory object ID or user principal name to set as the owner.

--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 dls fs access set-permission

Edit
Preview

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

Set the permissions for a file or folder in a Data Lake Store account.

az dls fs access set-permission --path
                                --permission
                                [--account]
                                [--ids]
                                [--subscription]

Examples

Set the permissions for a file or folder in a Data Lake Store account. (autogenerated)

az dls fs access set-permission --account dpreptestfiles --path / --permission 777 --subscription MySubscription

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

--permission

The octal representation of the permissions for user, group and mask.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

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
--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 dls fs access show

Edit
Preview

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

Display the access control list (ACL).

az dls fs access show --path
                      [--account]
                      [--ids]
                      [--subscription]

Examples

Display the access control list (ACL). (autogenerated)

az dls fs access show --account {account} --path {path}

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

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

--account -n

Name of the Data Lake Store account.

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