• Public
  • Public/Protected
  • All

Interface ContainerListBlobFlatSegmentOptionalParams

Package version

Optional parameters.


  • any
    • ContainerListBlobFlatSegmentOptionalParams



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 ContinuationToken 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 maxPageSize

maxPageSize: undefined | number

Specifies the maximum number of containers to return. If the request does not specify maxresults, 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 maxresults, 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 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 timeoutInSeconds

timeoutInSeconds: undefined | number

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

Generated using TypeDoc