ShareSASPermissions class

Package:

@azure/storage-file-share

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a share. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a FileSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

Properties

create	Specifies Create access granted.
delete	Specifies Delete access granted.
list	Specifies List access granted.
read	Specifies Read access granted.
write	Specifies Write access granted.

Methods

parse(string)	Creates an ShareSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission.
toString()	Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service. The order of the characters should be as specified here to ensure correctness. See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

Property Details

create

Specifies Create access granted.

create: boolean

Property Value

boolean

delete

Specifies Delete access granted.

delete: boolean

Property Value

boolean

list

Specifies List access granted.

list: boolean

Property Value

boolean

read

Specifies Read access granted.

read: boolean

Property Value

boolean

write

Specifies Write access granted.

write: boolean

Property Value

boolean

Method Details

parse(string)

Creates an ShareSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission.

static function parse(permissions: string): ShareSASPermissions

Parameters

permissions

string

Returns

ShareSASPermissions

toString()

Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.

The order of the characters should be as specified here to ensure correctness.

See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function toString(): string

Returns

string