Share via

AccountSASServices class

  • Reference
Package:
@azure/storage-file

ONLY AVAILABLE IN NODE.JS RUNTIME. This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that service. Once all the values are set, this should be serialized with toString and set as the services field on an <xref:IAccountSASSignatureValues> object. It is possible to construct the services string without this class, but the order of the services is particular and this class guarantees correctness.

Properties

blob

Permission to access blob resources granted.
file

Permission to access file resources granted.
queue

Permission to access queue resources granted.
table

Permission to access table resources granted.

Methods

parse(string)

Creates an <xref:AccountSASServices> from the specified services string. This method will throw an Error if it encounters a character that does not correspond to a valid service.
toString()

Converts the given services to a string.

Property Details

blob

Permission to access blob resources granted.

blob: boolean

Property Value

boolean

file

Permission to access file resources granted.

file: boolean

Property Value

boolean

queue

Permission to access queue resources granted.

queue: boolean

Property Value

boolean

table

Permission to access table resources granted.

table: boolean

Property Value

boolean

Method Details

parse(string)

Creates an <xref:AccountSASServices> from the specified services string. This method will throw an Error if it encounters a character that does not correspond to a valid service.

static function parse(services: string)

Parameters

services

string

Returns

AccountSASServices

toString()

Converts the given services to a string.

function toString()

Returns

string