Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathListOptionalParams

Package version

Optional Parameters.

Hierarchy

  • any
    • PathListOptionalParams

Index

Properties

Optional continuation

continuation: undefined | string

The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.

Optional directory

directory: undefined | string

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

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 timeoutParameter

timeoutParameter: undefined | number

An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.

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 owner and group fields of each list entry 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.

Optional xMsClientRequestId

xMsClientRequestId: undefined | string

A UUID recorded in the analytics logs for troubleshooting and correlation.

Optional xMsDate

xMsDate: undefined | string

Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

Generated using TypeDoc