Edit

Share via

Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry

  • Reference
Module:
AzureRM.DataLakeAnalytics

Deletes an entry from 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

Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry
      [-Account] <String>
      [-User]
      -ObjectId <Guid>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry
      [-Account] <String>
      [-User]
      -ObjectId <Guid>
      -ItemType <String>
      -Path <CatalogPathInstance>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry
      [-Account] <String>
      [-Group]
      -ObjectId <Guid>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry
      [-Account] <String>
      [-Group]
      -ObjectId <Guid>
      -ItemType <String>
      -Path <CatalogPathInstance>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Examples

Example 1: Remove the user ACL for a catalog

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

This command removes the catalog ACL for Patti Fuller of the contosoadla account.

Example 2: Remove the user ACL for a database

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

This command removes the database ACL for Patti Fuller of the contosoadla account.

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

Remove ACL entry of catalog for group.

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

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

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-User

Remove ACL entry of catalog for user.

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

Outputs

Boolean