使用英语阅读

通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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.

Constructor

Python 
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.

Python 
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

Python 
get(key, default=None)

Parameters

Name Description
key
Required
default
Required
Default value: None

has_key

Python 
has_key(k)

Parameters

Name Description
k
Required

items

Python 
items()

keys

Python 
keys()

next

Python 
next() -> ReturnType

update

Python 
update(*args, **kwargs)

values

Python 
values()

Attributes

command

Function to retrieve the next page of items.

Python 
command: Callable

container

The name of the container.

Python 
container: str

current_page

The current page of listed results.

Python 
current_page: List[BlobProperties] | None

delimiter

A delimiting character used for hierarchy listing.

Python 
delimiter: str

location_mode

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

Python 
location_mode: str

marker

The continuation token of the current page of results.

Python 
marker: str | None

name

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

Python 
name: str

next_marker

The continuation token to retrieve the next page of results.

Python 
next_marker: str | None

prefix

A blob name prefix being used to filter the list.

Python 
prefix: str

results_per_page

The maximum number of results retrieved per API call.

Python 
results_per_page: int | None

service_endpoint

The service URL.

Python 
service_endpoint: str | None