ShareClient.GetPermission Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.20.1

Source:

ShareClient.cs

Gets the file permission in Security Descriptor Definition Language (SDDL). Note that this API is not applicable for Share Snapshots.

public virtual Azure.Response<Azure.Storage.Files.Shares.Models.ShareFilePermission> GetPermission (string filePermissionKey, Azure.Storage.Files.Shares.Models.FilePermissionFormat? filePermissionFormat = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetPermission : string * Nullable<Azure.Storage.Files.Shares.Models.FilePermissionFormat> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareFilePermission>
override this.GetPermission : string * Nullable<Azure.Storage.Files.Shares.Models.FilePermissionFormat> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareFilePermission>

Public Overridable Function GetPermission (filePermissionKey As String, Optional filePermissionFormat As Nullable(Of FilePermissionFormat) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ShareFilePermission)

Parameters

filePermissionKey

String

The file permission key.

filePermissionFormat

Nullable<FilePermissionFormat>

Optional. Available for version 2024-11-04 and later. Specifies the format in which the permission is returned. If filePermissionFormat is unspecified or explicityly set to Sddl, the permission will be returned in SSDL format. If filePermissionFormat is explicity set to Binary, the permission is returned as a base64 string representing the binary encoding of the permission in self-relative format.

cancellationToken

CancellationToken

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

Returns

Response<ShareFilePermission>

A Response<T> file permission.