FileSasPermissions Class
FileSasPermissions class to be used with the generate_file_sas function.
Constructor
FileSasPermissions(read: bool = False, create: bool = False, write: bool = False, delete: bool = False, **kwargs: Any)Parameters
| Name | Description |
|---|---|
|
read
|
Read the content, properties, metadata etc. Use the file as the source of a read operation. Default value: False
|
|
create
|
Write a new file. Default value: False
|
|
write
|
Create or write content, properties, metadata. Lease the file. Default value: False
|
|
delete
|
Delete the file. Default value: False
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
add
|
Append data to the file. |
|
move
|
Move any file in the directory to a new location. Note the move operation can optionally be restricted to the child file or directory owner or the parent directory owner if the said parameter is included in the token and the sticky bit is set on the parent directory. |
|
execute
|
Get the status (system defined properties) and ACL of any file in the directory. If the caller is the owner, set access control on any file in the directory. |
|
manage_ownership
|
Allows the user to set owner, owning group, or act as the owner when renaming or deleting a file or directory within a folder that has the sticky bit set. |
|
manage_access_control
|
Allows the user to set permissions and POSIX ACLs on files and directories. |
Methods
| from_string |
Create a FileSasPermissions from a string. To specify read, write, or delete permissions you need only to include the first letter of the word in the string. E.g. For read and write permissions, you would provide a string "rw". |
from_string
Create a FileSasPermissions from a string.
To specify read, write, or delete permissions you need only to include the first letter of the word in the string. E.g. For read and write permissions, you would provide a string "rw".
from_string(permission: str) -> SelfParameters
| Name | Description |
|---|---|
|
permission
Required
|
The string which dictates the read, add, create, write, or delete permissions. |
Returns
| Type | Description |
|---|---|
|
A FileSasPermissions object |
Attributes
add
Append data to the file.
add: bool | None = Nonecreate
Write a new file.
create: bool = Falsedelete
Delete the file.
delete: bool = Falseexecute
Get the status (system defined properties) and ACL of any file in the directory. If the caller is the owner, set access control on any file in the directory.
execute: bool | None = Nonemanage_access_control
Allows the user to set permissions and POSIX ACLs on files and directories.
manage_access_control: bool | None = Nonemanage_ownership
Allows the user to set owner, owning group, or act as the owner when renaming or deleting a file or directory within a folder that has the sticky bit set.
manage_ownership: bool | None = Nonemove
Move any file in the directory to a new location. Note the move operation can optionally be restricted to the child file or directory owner or the parent directory owner if the said parameter is included in the token and the sticky bit is set on the parent directory.
move: bool | None = Noneread
Read the content, properties, metadata etc. Use the file as the source of a read operation.
read: bool = Falsewrite
Create or write content, properties, metadata. Lease the file.
write: bool = False