Skip to main content
Skip table of contents

Operation: EnumerateDirectory

With the EnumerateDirectory operation, you list all files and folders from a specific folder path.

For more information on other operations of the Microsoft Azure Data Lake Gen 1 Storage Connector, see Microsoft Azure Data Lake Gen 1 Storage Connector.

Parameters

Adapter

Main class of the adapter (do not change!)

Possible values:

de.softproject.integration.adapter.microsoft.azure.datalake.MicrosoftAzureDataLakeStoreConnector: Main Class (Standard)

authEndpoint

This parameter is required.

OAuth 2.0 Token Endpoint (v1)

Possible values:

String with a valid endpoint, e.g.:

https://login.microsoftonline.com/<DirectoryID>/oauth2/token

clientID

This parameter is required.

Client ID of the Azure Active Directory application

Possible values:

Any string with the client ID, e.g.:

10925xxx-1111-4444-bd3d-82165c0d3841

clientSecret

This parameter is required.

Secret client key of the Azure Active Directory application

Possible values:

String containing the secret client key.

accountName

This parameter is required.

Fully qualified Data Lake Storage Account Name (FQDN)

Possible values:

String containing the FQDN, e.g.:

<your_account_name>.azuredatalakestore.net

folderPath

Folder path. Can start and end with a slash.

Possible values:

  • /: Root folder

  • Any valid path, e.g. root/subfolder/.../lastFolder

maxEntriesToRetrieve

This parameter is optional for the EnumerateDirectory operation and is ignored if the entriesRecursively parameter is set to true.

Maximum number of entries to retrieve.

Note:

Please note that the server can limit the number of retrieved entries to a smaller number than the number specified here.

Possible values:

Integer greater than 0.

startAfterPathName

This parameter is optional for the EnumerateDirectory operation and is ignored if the entriesRecursively parameter is set to true.

File or folder name after which you want to begin enumeration.

Possible values:

String containing the path name of the file or folder.

entriesRecursively

This parameter is optional.

Allows you to extract entries recursively.

Note:

If the parameter is set to true, the maxEntriesToRetrieve and startAfterPathName parameters are ignored.

Possible values:

  • true: All entries of the specified folder path are retrieved recursively.

  • false: All entries of the specified folder path are retrieved so that only direct child items are retrieved.

Status values

1

The adapter operation was executed successfully

-1

The operation failed due to a technical error.

Input

This operation does not require specific input XML.

Output

If the EnumerateDirectory operation is successful (Status 1), the adapter outputs an XML document containing a list of all files and folders, e.g.:

image-20250130-123321.png

Note:

Each Entry element corresponds to a file or folder. The following attributes describe the Entry element:

  • LastAccessTime: Time of last access

  • LastModifiedTime: Time of the last change

  • Group: ID of the group that owns the file or folder

  • User: ID of the user who owns the file or folder

  • Permission: Permission string for the file in UNIX syntax

  • Name: File name

  • FullName: Full file or folder path

If the operation was unsuccessful, i.e. in the event of an error (status -1⁣), the adapter returns an XML document with the error description, e.g.:

image-20250130-123421.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.