ShareClient.GetAccessPolicyAsync Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.20.1

Source:

ShareClient.cs

The GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken) operation gets the permissions for this share. The permissions indicate whether share data may be accessed publicly.

For more information, see Get Share ACL.

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IEnumerable<Azure.Storage.Files.Shares.Models.ShareSignedIdentifier>>> GetAccessPolicyAsync (Azure.Storage.Files.Shares.Models.ShareFileRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAccessPolicyAsync : Azure.Storage.Files.Shares.Models.ShareFileRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<seq<Azure.Storage.Files.Shares.Models.ShareSignedIdentifier>>>
override this.GetAccessPolicyAsync : Azure.Storage.Files.Shares.Models.ShareFileRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<seq<Azure.Storage.Files.Shares.Models.ShareSignedIdentifier>>>

Public Overridable Function GetAccessPolicyAsync (Optional conditions As ShareFileRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IEnumerable(Of ShareSignedIdentifier)))

Parameters

conditions

ShareFileRequestConditions

Optional ShareFileRequestConditions to add conditions on getting share access policy.

cancellationToken

CancellationToken

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

Returns

Task<Response<IEnumerable<ShareSignedIdentifier>>>

A Response<T> of IEnumerable<T> describing the share's access policy.

Remarks

A RequestFailedException will be thrown if a failure occurs.