ContainerListBlobsSegmentOptions | @azure/storage-blob

Options to configure Container - List Segment operations.

See:

{@link ContainerClient.listSegments}
{@link ContainerClient.listBlobFlatSegment}
{@link ContainerClient.listBlobHierarchySegment}
{@link ContainerClient.listHierarchySegments}
{@link ContainerClient.listItemsByHierarchy}

interface: ContainerListBlobsSegmentOptions

Hierarchy

CommonOptions
- ContainerListBlobsSegmentOptions

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

memberof: ContainerListBlobsSegmentOptions

Optional include

include: ListBlobsIncludeItem[]

Include this parameter to specify one or more datasets to include in the response.

Optional maxPageSize

maxPageSize: undefined | number

Specifies the maximum number of containers to return. If the request does not specify maxPageSize, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxPageSize, or than the default of 5000.

Optional prefix

prefix: undefined | string

Filters the results to return only containers whose name begins with the specified prefix.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.