Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry

Module:

AzureRM.DataLakeAnalytics

Modifies an entry in the ACL of a catalog or catalog item in Data Lake Analytics.

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-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-User]
   -ObjectId <Guid>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-User]
   -ObjectId <Guid>
   -ItemType <String>
   -Path <CatalogPathInstance>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-Group]
   -ObjectId <Guid>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-Group]
   -ObjectId <Guid>
   -ItemType <String>
   -Path <CatalogPathInstance>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-Other]
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-Other]
   -ItemType <String>
   -Path <CatalogPathInstance>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-UserOwner]
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-UserOwner]
   -ItemType <String>
   -Path <CatalogPathInstance>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-GroupOwner]
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry
   [-Account] <String>
   [-GroupOwner]
   -ItemType <String>
   -Path <CatalogPathInstance>
   -Permissions <PermissionType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry cmdlet adds or modifies an entry (ACE) in the access control list (ACL) of a catalog or catalog item in Data Lake Analytics.

Examples

Example 1: Modify user permissions for a catalog

PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").Id -Permissions Read

Type  Id                                   Permissions
----  --                                   -----------
User  90a6f74b-fd73-490e-900a-c4f0f9694d02        Read
Group 902b155a-5601-4ca8-8178-ad3289211f88   ReadWrite
Other 00000000-0000-0000-0000-000000000000        None
User  bd0b55bb-3a57-442a-b2f6-78c95c10ef86        Read

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

Example 2: Modify user Permissions for a database

PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").Id -ItemType Database -Path "databaseName" -Permissions Read

Type  Id                                   Permissions
----  --                                   -----------
User  90a6f74b-fd73-490e-900a-c4f0f9694d02        Read
Group 902b155a-5601-4ca8-8178-ad3289211f88   ReadWrite
Other 00000000-0000-0000-0000-000000000000        None
User  bd0b55bb-3a57-442a-b2f6-78c95c10ef86        Read

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

Example 3: Modify other permissions for a catalog

PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -Other -Permissions Read

Type  Id                                   Permissions
----  --                                   -----------
User  90a6f74b-fd73-490e-900a-c4f0f9694d02        Read
Group 902b155a-5601-4ca8-8178-ad3289211f88   ReadWrite
Other 00000000-0000-0000-0000-000000000000        Read
User  bd0b55bb-3a57-442a-b2f6-78c95c10ef86        Read

This command modifies the catalog ACE for other to have read permissions.

Example 4: Modify other Permissions for a database

PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -Other -ItemType Database -Path "databaseName" -Permissions Read

Type  Id                                   Permissions
----  --                                   -----------
User  90a6f74b-fd73-490e-900a-c4f0f9694d02        Read
Group 902b155a-5601-4ca8-8178-ad3289211f88   ReadWrite
Other 00000000-0000-0000-0000-000000000000        Read
User  bd0b55bb-3a57-442a-b2f6-78c95c10ef86        Read

Example 5: Modify user owner permissions for a catalog

PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -Permissions Read

Type      Id                                   Permissions
----      --                                   -----------
UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc        Read

This command sets the owner permission for the account to Read.

Example 6: Modify user owner Permissions for a database

PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -ItemType Database -Path "databaseName" -Permissions Read

Type       Id                                   Permissions
----       --                                   -----------
GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc        Read

This command sets the owner permission for the database to Read.

Parameters

-Account

Specifies the Data Lake Analytics account name.

Type:	String
Aliases:	AccountName
Position:	0
Default value:	None
Required:	True
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:	None
Required:	False
Accept pipeline input:	False
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

-Group

Set ACL entry of catalog for group.

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

-GroupOwner

Set ACL entry of catalog for group owner.

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

-ItemType

Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are:

• Catalog
• Database

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

-ObjectId

The identity of the user to set.

Type:	Guid
Aliases:	Id, UserId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Other

Set ACL entry of catalog for other.

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

-Path

Specifies the Data Lake Analytics path of an catalog or catalog item. The parts of the path should be separated by a period (.).

Type:	CatalogPathInstance
Position:	Named
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
• Read
• ReadWrite

Type:	Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType
Accepted values:	None, Read, ReadWrite
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-User

Set ACL entry of catalog for user.

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

-UserOwner

Set ACL entry of catalog for user owner.

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

-WhatIf

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

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

Inputs

String

Guid

CatalogPathInstance

Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType

Outputs

PSDataLakeAnalyticsAcl

Related Links

• Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry
• Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry
• U-SQL now offers database level access control