AccountSASPermissions class

Package:

@azure/storage-queue

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 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 queues, blobs and files granted.
delete	Permission to delete queues and messages granted.
list	Permission to list queues granted.
process	Permission to get and delete messages granted.
read	Permission to read resources granted.
update	Permissions to update messages and table entities granted.
write	Permission to write resources granted.

Methods

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. See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

Property Details

add

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

add: boolean

Property Value

boolean

create

Permission to create queues, blobs and files granted.

create: boolean

Property Value

boolean

delete

Permission to delete queues and messages granted.

delete: boolean

Property Value

boolean

list

Permission to list queues granted.

list: boolean

Property Value

boolean

process

Permission to get and delete messages granted.

process: boolean

Property Value

boolean

read

Permission to read resources granted.

read: 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

parse(string)

Parse initializes the AccountSASPermissions fields from a string.

static function parse(permissions: string): AccountSASPermissions

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.

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

function toString(): string

Returns

string