AccountSASPermissions class
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 blobs and files granted. |
| delete | Permission to delete blobs and files granted. |
| delete |
Permission to delete versions granted. |
| filter | Permission to filter blobs. |
| list | Permission to list blob containers, blobs, shares, directories, and files granted. |
| permanent |
Specifies that Permanent Delete is permitted. |
| process | Permission to get and delete messages granted. |
| read | Permission to read resources and list queues and tables granted. |
| set |
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(Account |
Creates a 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. |
| to |
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: booleanProperty Value
boolean
create
Permission to create blobs and files granted.
create: booleanProperty Value
boolean
delete
Permission to delete blobs and files granted.
delete: booleanProperty Value
boolean
deleteVersion
Permission to delete versions granted.
deleteVersion: booleanProperty Value
boolean
filter
Permission to filter blobs.
filter: booleanProperty Value
boolean
list
Permission to list blob containers, blobs, shares, directories, and files granted.
list: booleanProperty Value
boolean
permanentDelete
Specifies that Permanent Delete is permitted.
permanentDelete: booleanProperty Value
boolean
process
Permission to get and delete messages granted.
process: booleanProperty Value
boolean
read
Permission to read resources and list queues and tables granted.
read: booleanProperty Value
boolean
setImmutabilityPolicy
Permission to set immutability policy.
setImmutabilityPolicy: booleanProperty Value
boolean
tag
Specfies Tag access granted.
tag: booleanProperty Value
boolean
update
Permissions to update messages and table entities granted.
update: booleanProperty Value
boolean
write
Permission to write resources granted.
write: booleanProperty Value
boolean
Method Details
from(AccountSASPermissionsLike)
Creates a AccountSASPermissions from a raw object which contains same keys as it and boolean values for them.
static function from(permissionLike: AccountSASPermissionsLike): AccountSASPermissionsParameters
- permissionLike
- AccountSASPermissionsLike
Returns
parse(string)
Parse initializes the AccountSASPermissions fields from a string.
static function parse(permissions: string): AccountSASPermissionsParameters
- permissions
-
string
Returns
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(): stringReturns
string