BlobPrefix Class

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, **kwargs)

Parameters

command

callable

Required

Function to retrieve the next page of items.

prefix

str

Required

Filters the results to return only blobs whose names begin with the specified prefix.

results_per_page

int

Required

The maximum number of blobs to retrieve per call.

marker

str

Required

An opaque continuation token.

delimiter

str

Required

Used to capture blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.

location_mode

Required

Specifies the location the request should be sent to. This mode only applies for RA-GRS accounts which allow secondary read access. Options include 'primary' or 'secondary'.

Variables

name

str

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

service_endpoint

str

The service URL.

prefix

str

A blob name prefix being used to filter the list.

marker

str

The continuation token of the current page of results.

results_per_page

int

The maximum number of results retrieved per API call.

next_marker

str

The continuation token to retrieve the next page of results.

location_mode

str

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

current_page

list(BlobProperties)

The current page of listed results.

container

str

The container that the blobs are listed from.

delimiter

str

A delimiting character used for hierarchy listing.