Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileSystemListPathsOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • FileSystemListPathsOptionalParams

Index

Properties

Optional continuation

continuation: undefined | string

Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.

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 path

path: undefined | string

Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist.

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.

Optional upn

upn: undefined | false | true

Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.

Generated using TypeDoc