ShareClient.GetAccessPolicy Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.17.1

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareClient.cs

Source:: ShareClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The GetAccessPolicy(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 Azure.Response<System.Collections.Generic.IEnumerable<Azure.Storage.Files.Shares.Models.ShareSignedIdentifier>> GetAccessPolicy (Azure.Storage.Files.Shares.Models.ShareFileRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetAccessPolicy (Optional conditions As ShareFileRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

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.

Applies to