Share via

ShareSasPermissions Class

  • Reference

ShareSasPermissions class to be used to be used with generating shared access signature and access policy operations.

Inheritance
builtins.object
ShareSasPermissions

Constructor

ShareSasPermissions(read: bool = False, write: bool = False, delete: bool = False, list: bool = False, create: bool = False)

Parameters

Name Description
read
bool

Read the content, properties or metadata of any file in the share. Use any file in the share as the source of a copy operation.

Default value: False
write
bool

For any file in the share, create or write content, properties or metadata. Resize the file. Use the file as the destination of a copy operation within the same account. Note: You cannot grant permissions to read or write share properties or metadata with a service SAS. Use an account SAS instead.

Default value: False
delete
bool

Delete any file in the share. Note: You cannot grant permissions to delete a share with a service SAS. Use an account SAS instead.

Default value: False
list
bool

List files and directories in the share.

Default value: False
create
bool

Create a new file in the share, or copy a file to a new file in the share.

Default value: False

Methods

from_string

Create a ShareSasPermissions from a string.

To specify read, create, write, delete, or list 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 ShareSasPermissions from a string.

To specify read, create, write, delete, or list 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, create, write, delete, or list permissions

Returns

Type Description
ShareSasPermissions

A ShareSasPermissions object

Attributes

create

The create permission for share SAS.

create: bool = False

delete

The delete permission for share SAS.

delete: bool = False

list

The list permission for share SAS.

list: bool = False

read

The read permission for share SAS.

read: bool = False

write

The write permission for share SAS.

write: bool = False