BlobSASPermissions class

Package:

@azure/storage-blob

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. 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 BlobSASSignatureValues 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

add	Specifies Add access granted.
create	Specifies Create access granted.
delete	Specifies Delete access granted.
deleteVersion	Specifies Delete version access granted.
execute	Specifies Execute access granted.
move	Specifies Move access granted.
permanentDelete	Specifies that Permanent Delete is permitted.
read	Specifies Read access granted.
setImmutabilityPolicy	Specifies SetImmutabilityPolicy access granted.
tag	Specfies Tag access granted.
write	Specifies Write access granted.

Methods

from(BlobSASPermissionsLike)	Creates a BlobSASPermissions from a raw object which contains same keys as it and boolean values for them.
parse(string)	Creates a BlobSASPermissions 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.

Property Details

add

Specifies Add access granted.

add: boolean

Property Value

boolean

create

Specifies Create access granted.

create: boolean

Property Value

boolean

delete

Specifies Delete access granted.

delete: boolean

Property Value

boolean

deleteVersion

Specifies Delete version access granted.

deleteVersion: boolean

Property Value

boolean

execute

Specifies Execute access granted.

execute: boolean

Property Value

boolean

move

Specifies Move access granted.

move: boolean

Property Value

boolean

permanentDelete

Specifies that Permanent Delete is permitted.

permanentDelete: boolean

Property Value

boolean

read

Specifies Read access granted.

read: boolean

Property Value

boolean

setImmutabilityPolicy

Specifies SetImmutabilityPolicy access granted.

setImmutabilityPolicy: boolean

Property Value

boolean

tag

Specfies Tag access granted.

tag: boolean

Property Value

boolean

write

Specifies Write access granted.

write: boolean

Property Value

boolean

Method Details

from(BlobSASPermissionsLike)

Creates a BlobSASPermissions from a raw object which contains same keys as it and boolean values for them.

static function from(permissionLike: BlobSASPermissionsLike): BlobSASPermissions

Parameters

permissionLike

BlobSASPermissionsLike

Returns

BlobSASPermissions

parse(string)

Creates a BlobSASPermissions 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): BlobSASPermissions

Parameters

permissions

string

Returns

BlobSASPermissions

toString()

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

function toString(): string

Returns

string

A string which represents the BlobSASPermissions