ContainerSASPermissions class
This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container. 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.
Properties
| add | Specifies Add access granted. |
| create | Specifies Create access granted. |
| delete | Specifies Delete access granted. |
| delete |
Specifies Delete version access granted. |
| execute | Specifies Execute access granted. |
| filter |
Specifies that Filter Blobs by Tags is permitted. |
| list | Specifies List access granted. |
| move | Specifies Move access granted. |
| permanent |
Specifies that Permanent Delete is permitted. |
| read | Specifies Read access granted. |
| set |
Specifies SetImmutabilityPolicy access granted. |
| tag | Specfies Tag access granted. |
| write | Specifies Write access granted. |
Methods
| from(Container |
Creates a ContainerSASPermissions from a raw object which contains same keys as it and boolean values for them. |
| parse(string) | Creates an ContainerSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission. |
| to |
Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service. The order of the characters should be as specified here to ensure correctness. See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
Property Details
add
Specifies Add access granted.
add: booleanProperty Value
boolean
create
Specifies Create access granted.
create: booleanProperty Value
boolean
delete
Specifies Delete access granted.
delete: booleanProperty Value
boolean
deleteVersion
Specifies Delete version access granted.
deleteVersion: booleanProperty Value
boolean
execute
Specifies Execute access granted.
execute: booleanProperty Value
boolean
filterByTags
Specifies that Filter Blobs by Tags is permitted.
filterByTags: booleanProperty Value
boolean
list
Specifies List access granted.
list: booleanProperty Value
boolean
move
Specifies Move access granted.
move: booleanProperty Value
boolean
permanentDelete
Specifies that Permanent Delete is permitted.
permanentDelete: booleanProperty Value
boolean
read
Specifies Read access granted.
read: booleanProperty Value
boolean
setImmutabilityPolicy
Specifies SetImmutabilityPolicy access granted.
setImmutabilityPolicy: booleanProperty Value
boolean
tag
Specfies Tag access granted.
tag: booleanProperty Value
boolean
write
Specifies Write access granted.
write: booleanProperty Value
boolean
Method Details
from(ContainerSASPermissionsLike)
Creates a ContainerSASPermissions from a raw object which contains same keys as it and boolean values for them.
static function from(permissionLike: ContainerSASPermissionsLike): ContainerSASPermissionsParameters
- permissionLike
- ContainerSASPermissionsLike
Returns
parse(string)
Creates an ContainerSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission.
static function parse(permissions: string): ContainerSASPermissionsParameters
- permissions
-
string
Returns
toString()
Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.
The order of the characters should be as specified here to ensure correctness.
See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function toString(): stringReturns
string