Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlobSASPermissions

Package version

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. 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 a BlobSASSignatureValues 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.

Hierarchy

  • BlobSASPermissions

Index

Properties

add

add: boolean = false

Specifies Add access granted.

create

create: boolean = false

Specifies Create access granted.

delete

delete: boolean = false

Specifies Delete access granted.

deleteVersion

deleteVersion: boolean = false

Specifies Delete version access granted.

execute

execute: boolean = false

Specifies Execute access granted.

move

move: boolean = false

Specifies Move access granted.

permanentDelete

permanentDelete: boolean = false

Specifies that Permanent Delete is permitted.

read

read: boolean = false

Specifies Read access granted.

setImmutabilityPolicy

setImmutabilityPolicy: boolean = false

Specifies SetImmutabilityPolicy access granted.

tag

tag: boolean = false

Specfies Tag access granted.

write

write: boolean = false

Specifies Write access granted.

Methods

toString

  • toString(): string
  • Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.

    Returns string

    A string which represents the BlobSASPermissions

Static from

Static parse

Generated using TypeDoc