DataLakeFileClient.GetAccessControlAsync Method

  • Reference

Definition

Namespace:
Azure.Storage.Files.DataLake
Assembly:
Azure.Storage.Files.DataLake.dll
Package:
Azure.Storage.Files.DataLake v12.20.1
Package:
Azure.Storage.Files.DataLake v12.21.0-beta.2
Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

The GetAccessControlAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation returns the access control data for a path.

For more information, see Get Properties.

public override System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.PathAccessControl>> GetAccessControlAsync (bool? userPrincipalName = default, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);
override this.GetAccessControlAsync : Nullable<bool> * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.PathAccessControl>>
Public Overrides Function GetAccessControlAsync (Optional userPrincipalName As Nullable(Of Boolean) = Nothing, Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PathAccessControl))

Parameters

userPrincipalName
Nullable<Boolean>

Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs.The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.

conditions
DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on getting the path's access control.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<PathAccessControl>>

A Response<T> describing the path's access control.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to