FileSasPermissions Class

FileSasPermissions class to be used with the generate_file_sas function.

Inheritance

builtins.object

FileSasPermissions

Constructor

FileSasPermissions(read=False, create=False, write=False, delete=False, **kwargs)

Parameters

read

bool

default value: False

Read the content, properties, metadata etc. Use the file as the source of a read operation.

create

bool

default value: False

Write a new file.

write

bool

default value: False

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

delete

bool

default value: False

Delete the file.

add

bool

Append data to the file.

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 saoid 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 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)

Parameters

permission

str

Required

The string which dictates the read, add, create, write, or delete permissions.

permission

Required

Returns

A FileSasPermissions object

Return type

<xref:azure.storage.fildatalake.FileSasPermissions>