Share via

BlobPrefix Class

  • Reference

An Iterable of Blob properties.

Returned from walk_blobs when a delimiter is used. Can be thought of as a virtual blob directory.

Inheritance
ItemPaged
BlobPrefix
azure.storage.blob._shared.models.DictMixin
BlobPrefix

Constructor

BlobPrefix(*args: Any, **kwargs: Any)

Methods

by_page

Get an iterator of pages of objects, instead of an iterator of objects.
get
has_key
items
keys
next
update
values

by_page

Get an iterator of pages of objects, instead of an iterator of objects.

by_page(continuation_token: str | None = None) -> Iterator[Iterator[ReturnType]]

Parameters

Name Description
continuation_token
str

An opaque continuation token. This value can be retrieved from the continuation_token field of a previous generator object. If specified, this generator will begin returning results from this point.

Default value: None

Returns

Type Description
<xref:iterator>[<xref:iterator>[<xref:ReturnType>]]

An iterator of pages (themselves iterator of objects)

get 

get(key, default=None)

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k)

Parameters

Name Description
k
Required

items 

items()

keys 

keys()

next 

next() -> ReturnType

update 

update(*args, **kwargs)

values 

values()

Attributes

command

Function to retrieve the next page of items.

command: Callable

container

The name of the container.

container: str

current_page

The current page of listed results.

current_page: List[BlobProperties] | None

delimiter

A delimiting character used for hierarchy listing.

delimiter: str

location_mode

The location mode being used to list results. The available options include "primary" and "secondary".

location_mode: str

marker

The continuation token of the current page of results.

marker: str | None

name

The prefix, or "directory name" of the blob.

name: str

next_marker

The continuation token to retrieve the next page of results.

next_marker: str | None

prefix

A blob name prefix being used to filter the list.

prefix: str

results_per_page

The maximum number of results retrieved per API call.

results_per_page: int | None

service_endpoint

The service URL.

service_endpoint: str | None