ContainerSasPermissions Class
ContainerSasPermissions class to be used with the generate_container_sas function and for the AccessPolicies used with set_container_access_policy.
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
|
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
|
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
|
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
|
Delete the previous blob version for the versioning enabled storage account. Default value: False
|
|
list
|
List blobs in the container. Default value: False
|
|
tag
|
Set or get tags on the blobs in the container. Default value: False
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
add
|
Add a block to an append blob. |
|
create
|
Write a new blob, snapshot a blob, or copy a blob to a new blob. |
|
permanent_delete
|
To enable permanent delete on the blob is permitted. |
|
filter_by_tags
|
To enable finding blobs by tags. |
|
move
|
Move a blob or a directory and its contents to a new location. |
|
execute
|
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
|
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) -> ContainerSasPermissionsParameters
| Name | Description |
|---|---|
|
permission
Required
|
The string which dictates the read, write, delete, and list permissions. |
Returns
| Type | Description |
|---|---|
|
A ContainerSasPermissions object |
Attributes
add
Add a block to an append blob.
add: bool | Nonecreate
Write a new blob, snapshot a blob, or copy a blob to a new blob.
create: bool | Nonedelete
The delete permission for container SAS.
delete: bool = Falsedelete_previous_version
Permission to delete previous blob version for versioning enabled storage accounts.
delete_previous_version: bool = Falseexecute
Get the system properties and, if the hierarchical namespace is enabled for the storage account, get the POSIX ACL of a blob.
execute: bool | Nonelist
The list permission for container SAS.
list: bool = Falsemove
Move a blob or a directory and its contents to a new location.
move: bool | Nonepermanent_delete
To enable permanent delete on the blob is permitted.
permanent_delete: bool | Noneread
The read permission for container SAS.
read: bool = Falseset_immutability_policy
To get immutability policy, you just need read permission.
set_immutability_policy: bool | Nonetag
Set or get tags on the blobs in the container.
tag: bool = Falsewrite
The write permission for container SAS.
write: bool = False