Edit

Share via


Set-AzDataLakeAnalyticsCatalogItemAclEntry

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

Syntax

SetCatalogAclEntryForUser (Default)

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

SetCatalogItemAclEntryForUser

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

SetCatalogAclEntryForGroup

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

SetCatalogItemAclEntryForGroup

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

SetCatalogAclEntryForOther

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

SetCatalogItemAclEntryForOther

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

SetCatalogAclEntryForUserOwner

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

SetCatalogItemAclEntryForUserOwner

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

SetCatalogAclEntryForGroupOwner

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

SetCatalogItemAclEntryForGroupOwner

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

Description

The Set-AzDataLakeAnalyticsCatalogItemAclEntry 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

Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzADUser -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

Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzADUser -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

Set-AzDataLakeAnalyticsCatalogItemAclEntry -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

Set-AzDataLakeAnalyticsCatalogItemAclEntry -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

Set-AzDataLakeAnalyticsCatalogItemAclEntry -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

Set-AzDataLakeAnalyticsCatalogItemAclEntry -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.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
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

-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

-Group

Set ACL entry of catalog for group.

Parameter properties

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

Parameter sets

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

-GroupOwner

Set ACL entry of catalog for group owner.

Parameter properties

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

Parameter sets

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

-ItemType

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

  • Catalog
  • Database

Parameter properties

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

Parameter sets

SetCatalogItemAclEntryForUser
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForOther
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForUserOwner
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForGroupOwner
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ObjectId

The identity of the user to set.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id, UserId

Parameter sets

SetCatalogAclEntryForUser
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForUser
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogAclEntryForGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Other

Set ACL entry of catalog for other.

Parameter properties

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

Parameter sets

SetCatalogAclEntryForOther
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetCatalogItemAclEntryForOther
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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 (.).

Parameter properties

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

Parameter sets

SetCatalogItemAclEntryForUser
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForOther
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForUserOwner
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
SetCatalogItemAclEntryForGroupOwner
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Permissions

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

  • None
  • Read
  • ReadWrite

Parameter properties

Type:Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType
Default value:None
Accepted values:None, Read, ReadWrite
Supports wildcards:False
DontShow:False

Parameter sets

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

-User

Set ACL entry of catalog for user.

Parameter properties

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

Parameter sets

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

-UserOwner

Set ACL entry of catalog for user owner.

Parameter properties

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

Parameter sets

SetCatalogAclEntryForUserOwner
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetCatalogItemAclEntryForUserOwner
Position:Named
Mandatory:True
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:None
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

Guid

CatalogPathInstance

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

Outputs

PSDataLakeAnalyticsAcl