Remove-AzDataLakeStoreItemAclEntry

Module:

Az.DataLakeStore Module

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

Syntax

RemoveByACLObject (Default)

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

RemoveSpecificACE

Remove-AzDataLakeStoreItemAclEntry
    [-Account] <String>
    [-Path] <DataLakeStorePathInstance>
    [-AceType] <AceType>
    [[-Id] <Guid>]
    [-Default]
    [-PassThru]
    [-Recurse]
    [-Concurrency <Int32>]
    [-ShowProgress]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-AzDataLakeStoreItemAclEntry cmdlet removes an entry (ACE) from the access control list (ACL) of a file or folder in Data Lake Store.

Examples

Example 1: Remove a user entry

Remove-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId

This command removes the user ACE for Patti Fuller from the ContosoADL account.

Example 2: Remove a user entry recursively

Remove-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId -Recurse -Concurrency 128

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

$fullAcl="user:enterpriseObjectID:rwx,default:user:enterpriseObjectID:rwx"
$newFullAcl = $fullAcl.Split(",")
Remove-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -Acl $newFullAcl -Recurse -Concurrency 128 -ShowProgress -Verbose

This command removes the user ACE for Patti Fuller from the root and recursively from all it's subdirectories and files for account ContosoADL.

Parameters

-Account

Specifies the name of the Data Lake Store account.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AccountName

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AceType

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

• User
• Group
• Mask
• Other

Parameter properties

Type:	Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType
Default value:	None
Accepted values:	User, Group, Mask, Other
Supports wildcards:	False
DontShow:	False

Parameter sets

RemoveSpecificACE

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Acl

Specifies the ACL object that contains the entries to be removed.

Parameter properties

Type:	DataLakeStoreItemAce[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

RemoveByACLObject

Position:	2
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Concurrency

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

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Default

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

RemoveSpecificACE

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

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

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

RemoveSpecificACE

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PassThru

Indicates a boolean response should be returned indicating the result of the delete operation.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Path

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

Parameter properties

Type:	DataLakeStorePathInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Recurse

Indicates the ACL to be removed recursively to the child subdirectories and files

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ShowProgress

If passed then progress status is showed. Only applicable when recursive Acl remove is done.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

DataLakeStorePathInstance

DataLakeStoreItemAce

Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType

Guid

SwitchParameter

Int32

Outputs

Boolean

Related Links

• Set-AzDataLakeStoreItemAclEntry