DirectorySasPermissions Class

DirectorySasPermissions class to be used with the generate_directory_sas function.

Constructor

DirectorySasPermissions(read: bool = False, create: bool = False, write: bool = False, delete: bool = False, **kwargs: Any)

Parameters

Name	Description
read	bool Read the content, properties, metadata etc. Default value: False
create	bool Create a new directory. Default value: False
write	bool Create or write content, properties, metadata. Lease the directory. Default value: False
delete	bool Delete the directory. Default value: False

Keyword-Only Parameters

Name	Description
add	bool Append data to a file in the directory.
list	bool List any files in the directory. Implies Execute.
move	bool 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	bool 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	bool 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	bool Allows the user to set permissions and POSIX ACLs on files and directories.

Methods

from_string

Create a DirectorySasPermissions from a string. To specify read, create, 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 DirectorySasPermissions from a string.

To specify read, create, 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) -> Self

Parameters

Name	Description
permission Required	str The string which dictates the read, add, create, write, or delete permissions.

Returns

Type	Description
DirectorySasPermissions	A DirectorySasPermissions object

Attributes

add

Append data to a file in the directory.

add: bool | None = False

create

Create a new directory.

create: bool = False

delete

Delete the directory.

delete: bool = False

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.

execute: bool | None = False

list

List any files in the directory. Implies Execute.

list: bool | None = False

manage_access_control

Allows the user to set permissions and POSIX ACLs on files and directories.

manage_access_control: bool | None = False

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_ownership: bool | None = False

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.

move: bool | None = False

read

Read the content, properties, metadata etc.

read: bool = False

write

Create or write content, properties, metadata. Lease the directory.

write: bool = False