Puppet Task: datalakestorage_azure_path_list
- Defined in:
-
tasks/datalakestorage_azure_path_list.json,
tasks/datalakestorage_azure_path_list.rb
Overview
List filesystem paths and their properties.
Supports noop? false
Parameters
- directory (Optional[String[1]]) — Filters results to paths within the specified directory. An error occurs if the directory does not exist.
- continuation (Optional[String[1]]) — 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.
- upn (Optional[String[1]]) — 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.
- filesystem (Optional[String[1]]) — The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters.
- resource (Optional[String[1]]) — The value must be 'filesystem' for all filesystem operations.
- timeout (Optional[String[1]]) — 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.
- x_ms_date (Optional[String[1]]) — Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.
- paths (Optional[String[1]]) —
- recursive (Optional[String[1]]) — If 'true', all paths are listed; otherwise, only paths at the root of the filesystem are listed. If 'directory' is specified, the list will only include paths that share the same root.
- max_results (Optional[String[1]]) — 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.
- x_ms_client_request_id (Optional[String[1]]) — A UUID recorded in the analytics logs for troubleshooting and correlation.
- x_ms_version (Optional[String[1]]) — Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.