Skip to content

Latest commit

 

History

History
317 lines (245 loc) · 7.86 KB

Set-AzureRmDataLakeStoreItemAclEntry.md

File metadata and controls

317 lines (245 loc) · 7.86 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml
AzureRM.DataLakeStore
0671D833-8B3A-4480-A576-92F1A9E8CE92
2.0.0

Set-AzureRmDataLakeStoreItemAclEntry

SYNOPSIS

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

SYNTAX

SetByACLObject (Default)

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

SetSpecificACE

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: System.String
Parameter Sets: (All)
Aliases: AccountName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: SetSpecificACE
Aliases:
Accepted values: User, Group, Mask, Other

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Acl

Specifies the ACL object that contains the entries to modify.

Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[]
Parameter Sets: SetByACLObject
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Concurrency

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

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Default

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: SetSpecificACE
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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: System.Guid
Parameter Sets: SetSpecificACE
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PassThru

Indicates the resulting ACL should be returned.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: SetSpecificACE
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Recurse

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ShowProgress

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance

Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[]

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

System.Guid

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

System.Management.Automation.SwitchParameter

System.Int32

OUTPUTS

Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce

If PassThru is specified, will return the resulting list of ACL entries.

NOTES

RELATED LINKS

Remove-AzureRmDataLakeStoreItemAclEntry