AccountSASPermissions 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 an AccountSAS. 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 an <xref:AccountSASSignatureValues> 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	Permission to add messages, table entities, and append to blobs granted.
create	Permission to create blobs and files granted.
delete	Permission to create blobs and files granted.
deleteVersion	Permission to delete versions granted.
filter	Permission to filter blobs.
list	Permission to list blob containers, blobs, shares, directories, and files granted.
process	Permission to get and delete messages granted.
read	Permission to read resources and list queues and tables granted.
setImmutabilityPolicy	Permission to set immutability policy.
tag	Specfies Tag access granted.
update	Permissions to update messages and table entities granted.
write	Permission to write resources granted.

Methods

from(AccountSASPermissionsLike)	Creates a <xref:AccountSASPermissions> from a raw object which contains same keys as it and boolean values for them.
parse(string)	Parse initializes the AccountSASPermissions fields from a string.
toString()	Produces the SAS permissions string for an Azure Storage account. Call this method to set AccountSASSignatureValues Permissions field. Using this method will guarantee the resource types are in an order accepted by the service.

Property Details

add

Permission to add messages, table entities, and append to blobs granted.

add: boolean

Property Value

boolean

create

Permission to create blobs and files granted.

create: boolean

Property Value

boolean

delete

Permission to create blobs and files granted.

delete: boolean

Property Value

boolean

deleteVersion

Permission to delete versions granted.

deleteVersion: boolean

Property Value

boolean

filter

Permission to filter blobs.

filter: boolean

Property Value

boolean

list

Permission to list blob containers, blobs, shares, directories, and files granted.

list: boolean

Property Value

boolean

process

Permission to get and delete messages granted.

process: boolean

Property Value

boolean

read

Permission to read resources and list queues and tables granted.

read: boolean

Property Value

boolean

setImmutabilityPolicy

Permission to set immutability policy.

setImmutabilityPolicy: boolean

Property Value

boolean

tag

Specfies Tag access granted.

tag: boolean

Property Value

boolean

update

Permissions to update messages and table entities granted.

update: boolean

Property Value

boolean

write

Permission to write resources granted.

write: boolean

Property Value

boolean

Method Details

from(AccountSASPermissionsLike)

Creates a <xref:AccountSASPermissions> from a raw object which contains same keys as it and boolean values for them.

static function from(permissionLike: AccountSASPermissionsLike)

Parameters

permissionLike

AccountSASPermissionsLike

Returns

AccountSASPermissions

parse(string)

Parse initializes the AccountSASPermissions fields from a string.

static function parse(permissions: string)

Parameters

permissions

string

Returns

AccountSASPermissions

toString()

Produces the SAS permissions string for an Azure Storage account. Call this method to set AccountSASSignatureValues Permissions field. Using this method will guarantee the resource types are in an order accepted by the service.

function toString()

Returns

string