list_shares Method

Lists shares in the file storage account.

Syntax

def list_shares() -> None: ...

Remarks

This method lists the shares in the file storage account specified by the account property.

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_share_list event once for each share, and will also populate the Share* properties.

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

Note that the server does not return the shares' share_space_used property when listing shares; use get_share_info to retrieve all properties for a specific share.

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

do {
  azurefile.ListShares();

  for (int i = 0; i < azurefile.Shares.Count; i++) {
    // Process shares here.
  }
} while (!string.IsNullOrEmpty(azurefile.ShareMarker));