prefix Property

A prefix used to restrict the results returned when listing blobs or containers.

Syntax

def get_prefix() -> str: ...
def set_prefix(value: str) -> None: ...

prefix = property(get_prefix, set_prefix)

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by list_blobs or list_containers to only the items whose names begin with the given value.

Blob Namespace Traversal

By using the blob_delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With blob_delimiter set to /, we can set prefix to successively "deeper" values before calling list_blobs for the following effect: