list_resources Method

Lists resources in a given folder.

Syntax

def list_resources(folder_path: str) -> None: ...

Remarks

This method lists the resources in the folder at the specified FolderPath in the share currently selected by share.

Before calling this method, the prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned.

Calling this method will fire the on_resource_list event once for each resource, and will also populate the Resource* properties.

If there are still more resources available to list when this method returns, the resource_marker property will be populated. Continue to call this method until resource_marker is empty to accumulate all pages of results in the Resource* properties.

Note that the server only returns the following resource properties when listing resources (use get_file_info or get_folder_info to retrieve all properties for a specific resource):

• resource_name
• resource_path (populated by the class automatically)
• resource_share (populated by the class automatically)
• resource_size
• resource_type

// ResourceList event handler.
azurefile.OnResourceList += (s, e) => {
  Console.WriteLine(e.Name);
};

azurefile.Share = "myshare";
do {
  azurefile.ListResources("/work_files/serious_business/cats");

  for (int i = 0; i < azurefile.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(azurefile.ResourceMarker));