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=False, write=False, delete=False, list=False, delete_previous_version=False, tag=False, **kwargs)

Parameters

read

bool

default value: False

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.

write

bool

default value: False

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.

delete

bool

default value: False

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

delete_previous_version

bool

default value: False

Delete the previous blob version for the versioning enabled storage account.

list

bool

default value: False

List blobs in the container.

tag

bool

default value: False

Set or get tags on the blobs in the container.

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)

Parameters

permission

str

Required

The string which dictates the read, write, delete, and list permissions.

permission

Required

Returns

A ContainerSasPermissions object

Return type

ContainerSasPermissions