Set-AzureRmDataLakeStoreItemAclEntry

Reference

Module:: AzureRM.DataLakeStore

Modifies an entry in the ACL of a file or folder in Data Lake Store.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmDataLakeStoreItemAclEntry
   [-Account] <String>
   [-Path] <DataLakeStorePathInstance>
   [-Acl] <DataLakeStoreItemAce[]>
   [-PassThru]
   [-Recurse]
   [-Concurrency <Int32>]
   [-ShowProgress]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeStoreItemAclEntry
   [-Account] <String>
   [-Path] <DataLakeStorePathInstance>
   [-AceType] <AceType>
   [[-Id] <Guid>]
   [-Permissions] <Permission>
   [-Default]
   [-PassThru]
   [-Recurse]
   [-Concurrency <Int32>]
   [-ShowProgress]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmDataLakeStoreItemAclEntry cmdlet modifies an entry (ACE) in the access control list (ACL) of a file or folder in Data Lake Store.

Examples

Example 1: Modify permissions for an ACE

PS C:\>Set-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -Permissions All

This command modifies the ACE for Patti Fuller to have all permissions.

Example 2: Modify permissions for an ACE recursively

PS C:\>Set-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -Permissions All -Recurse -Concurrency 128

Example 3: Modify permissions for an ACE recursively using Acl object

PS C:\>$fullAcl="user:userid1:--x,default:user:userid1:--x"
PS C:\>$newFullAcl = $fullAcl.Split("{,}")
PS C:\>Set-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -Acl $newFullAcl -Recurse -Concurrency 128

This command recursively modifies the ACE for Patti Fuller to have all permissions to root and all its subdirectories and files.

Parameters

-Account

Specifies the name of the Data Lake Store account.

Type:	String
Aliases:	AccountName
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-AceType

Specifies the type of ACE to modify. The acceptable values for this parameter are:

User
Group
Mask
Other

Type:	Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType
Accepted values:	User, Group, Mask, Other
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Acl

Specifies the ACL object that contains the entries to modify.

Type:	DataLakeStoreItemAce[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Concurrency

Number of files/directories processed in parallel. Optional: a reasonable default will be selected

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Default

Indicates that this operation modifies the default ACE from the specified ACL.

Type:	SwitchParameter
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies the object ID of the AzureActive Directory user, group, or service principal for which to modify an ACE.

Type:	Guid
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Indicates the resulting ACL should be returned.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Path

Specifies the Data Lake Store path of the item for which to modify an ACE, starting with the root directory (/).

Type:	DataLakeStorePathInstance
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Permissions

Specifies the permissions for the ACE. The acceptable values for this parameter are:

None
Execute
Write
WriteExecute
Read
ReadExecute
ReadWrite
All

Type:	Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Permission
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False