Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileSystemListBlobHierarchySegmentOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • FileSystemListBlobHierarchySegmentOptionalParams

Index

Properties

Optional delimiter

delimiter: undefined | string

When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all 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.

Optional include

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

Optional marker

marker: undefined | string

A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.

Optional maxResults

maxResults: undefined | number

An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.

Optional prefix

prefix: undefined | string

Filters results to filesystems within the specified prefix.

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional timeout

timeout: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Generated using TypeDoc