AccountSASResourceTypes class

Package:

@azure/storage-blob

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that resource type. Once all the values are set, this should be serialized with toString and set as the resources field on an AccountSASSignatureValues object. It is possible to construct the resources string without this class, but the order of the resources is particular and this class guarantees correctness.

Properties

container	Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
object	Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
service	Permission to access service level APIs granted.

Methods

parse(string)	Creates an AccountSASResourceTypes from the specified resource types string. This method will throw an Error if it encounters a character that does not correspond to a valid resource type.
toString()	Converts the given resource types to a string. See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

Property Details

container

Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.

container: boolean

Property Value

boolean

object

Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.

object: boolean

Property Value

boolean

service

Permission to access service level APIs granted.

service: boolean

Property Value

boolean

Method Details

parse(string)

Creates an AccountSASResourceTypes from the specified resource types string. This method will throw an Error if it encounters a character that does not correspond to a valid resource type.

static function parse(resourceTypes: string): AccountSASResourceTypes

Parameters

resourceTypes

string

Returns

AccountSASResourceTypes

toString()

Converts the given resource types to a string.

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

function toString(): string

Returns

string