ContainerSasPermissions Class

ContainerSasPermissions class to be used with the generate_container_sas function and for the AccessPolicies used with set_container_access_policy.

Inheritance

builtins.object

ContainerSasPermissions

Constructor

ContainerSasPermissions(read: bool = False, write: bool = False, delete: bool = False, list: bool = False, delete_previous_version: bool = False, tag: bool = False, **kwargs: Any)

Parameters

Name	Description
read	bool Read the content, properties, metadata or block list of any blob in the container. Use any blob in the container as the source of a copy operation. Default value: False
write	bool For any blob in the container, create or write content, properties, metadata, or block list. Snapshot or lease the blob. Resize the blob (page blob only). Use the blob as the destination of a copy operation within the same account. Note: You cannot grant permissions to read or write container properties or metadata, nor to lease a container, with a container SAS. Use an account SAS instead. Default value: False
delete	bool Delete any blob in the container. Note: You cannot grant permissions to delete a container with a container SAS. Use an account SAS instead. Default value: False
delete_previous_version	bool Delete the previous blob version for the versioning enabled storage account. Default value: False
list	bool List blobs in the container. Default value: False
tag	bool Set or get tags on the blobs in the container. Default value: False

Keyword-Only Parameters

Name	Description
add	bool Add a block to an append blob.
create	bool Write a new blob, snapshot a blob, or copy a blob to a new blob.
permanent_delete	bool To enable permanent delete on the blob is permitted.
filter_by_tags	bool To enable finding blobs by tags.
move	bool Move a blob or a directory and its contents to a new location.
execute	bool Get the system properties and, if the hierarchical namespace is enabled for the storage account, get the POSIX ACL of a blob.
set_immutability_policy	bool To enable operations related to set/delete immutability policy. To get immutability policy, you just need read permission.

Methods

from_string

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

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

Parameters

Name	Description
permission Required	str The string which dictates the read, write, delete, and list permissions.

Returns

Type	Description
ContainerSasPermissions	A ContainerSasPermissions object

Attributes

add

Add a block to an append blob.

add: bool | None

create

Write a new blob, snapshot a blob, or copy a blob to a new blob.

create: bool | None

delete

The delete permission for container SAS.

delete: bool = False

delete_previous_version

Permission to delete previous blob version for versioning enabled storage accounts.

delete_previous_version: bool = False

execute

Get the system properties and, if the hierarchical namespace is enabled for the storage account, get the POSIX ACL of a blob.

execute: bool | None

list

The list permission for container SAS.

list: bool = False

move

Move a blob or a directory and its contents to a new location.

move: bool | None

permanent_delete

To enable permanent delete on the blob is permitted.

permanent_delete: bool | None

read

The read permission for container SAS.

read: bool = False

set_immutability_policy

To get immutability policy, you just need read permission.

set_immutability_policy: bool | None

tag

Set or get tags on the blobs in the container.

tag: bool = False

write

The write permission for container SAS.

write: bool = False