Azure.Storage.Files.DataLake.DataLakeDirectoryClient

public class DataLakeDirectoryClient : DataLakePathClient

A DirectoryClient represents a URI to the Azure DataLake service allowing you to manipulate a directory.

protected DataLakeDirectoryClient()

Initializes a new instance of the DataLakeDirectoryClient class for mocking.

public DataLakeDirectoryClient(Uri directoryUri)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(Uri directoryUri, DataLakeClientOptions options)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(string connectionString, string fileSystemName, string directoryPath)

Initializes a new instance of the DataLakeDirectoryClient.

public DataLakeDirectoryClient(string connectionString, string fileSystemName, string directoryPath, DataLakeClientOptions options)

Initializes a new instance of the DataLakeDirectoryClient.

public DataLakeDirectoryClient(Uri directoryUri, StorageSharedKeyCredential credential)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(Uri directoryUri, StorageSharedKeyCredential credential, DataLakeClientOptions options)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(Uri directoryUri, AzureSasCredential credential)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(Uri directoryUri, AzureSasCredential credential, DataLakeClientOptions options)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(Uri directoryUri, TokenCredential credential)

Initializes a new instance of the DataLakeDirectoryClient class.

public DataLakeDirectoryClient(Uri directoryUri, TokenCredential credential, DataLakeClientOptions options)

Initializes a new instance of the DataLakeDirectoryClient class.

public virtual Response<PathInfo> Create(DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The Create operation creates a directory. If the directory already exists, it will be overwritten. If you don't intent to overwrite an existing directory, consider using the CreateIfNotExists API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Response<PathInfo> Create(PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, DataLakeRequestConditions conditions, CancellationToken cancellationToken)

public virtual Task<Response<PathInfo>> CreateAsync(DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateAsync operation creates a directory. If the directory already exists, it will be overwritten. If you don't intent to overwrite an existing directory, consider using the CreateIfNotExistsAsync API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<PathInfo>> CreateAsync(PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, DataLakeRequestConditions conditions, CancellationToken cancellationToken)

public virtual Response<DataLakeFileClient> CreateFile(string fileName, DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateFile operation creates a file in this directory. If the file already exists, it will be overwritten. If you don't intent to overwrite an existing file, consider using the CreateIfNotExistsAsync API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Response<DataLakeFileClient> CreateFile(string fileName, PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, DataLakeRequestConditions conditions, CancellationToken cancellationToken)

The CreateFile operation creates a file in this directory. If the file already exists, it will be overwritten. If you don't intent to overwrite an existing file, consider using the CreateIfNotExists API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<DataLakeFileClient>> CreateFileAsync(string fileName, DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateFileAsync operation creates a new file in this directory. If the file already exists, it will be overwritten. If you don't intent to overwrite an existing file, consider using the CreateIfNotExistsAsync API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<DataLakeFileClient>> CreateFileAsync(string fileName, PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, DataLakeRequestConditions conditions, CancellationToken cancellationToken)

public virtual Response<PathInfo> CreateIfNotExists(DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateIfNotExists operation creates a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Response<PathInfo> CreateIfNotExists(PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, CancellationToken cancellationToken)

The CreateIfNotExists operation creates a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<PathInfo>> CreateIfNotExistsAsync(DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateIfNotExistsAsync operation creates a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<PathInfo>> CreateIfNotExistsAsync(PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, CancellationToken cancellationToken)

The CreateIfNotExistsAsync operation creates a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Response<DataLakeDirectoryClient> CreateSubDirectory(string path, DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateSubDirectory operation creates a sub directory in this directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Response<DataLakeDirectoryClient> CreateSubDirectory(string path, PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, DataLakeRequestConditions conditions, CancellationToken cancellationToken)

The CreateSubDirectory operation creates a sub directory in this directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<DataLakeDirectoryClient>> CreateSubDirectoryAsync(string path, DataLakePathCreateOptions options = null, CancellationToken cancellationToken = default)

The CreateSubDirectoryAsync operation creates a sub directory in this directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<DataLakeDirectoryClient>> CreateSubDirectoryAsync(string path, PathHttpHeaders httpHeaders, IDictionary<string, string> metadata, string permissions, string umask, DataLakeRequestConditions conditions, CancellationToken cancellationToken)

The CreateSubDirectoryAsync operation creates a sub directory in this directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Response Delete(DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The Delete operation marks the specified path deletion. For more information, see Delete Path.

public virtual Task<Response> DeleteAsync(DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteAsync operation marks the specified path deletion. For more information, see Delete Path.

public virtual Response DeleteFile(string fileName, DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteFile operation deletes a file in this directory. For more information, see Delete Path.

public virtual Task<Response> DeleteFileAsync(string fileName, DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteFileAsync operation deletes a file in this directory. For more information, see Delete Path.

public virtual Response<bool> DeleteIfExists(DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteIfExists operation marks the specified directory for deletion, if the directory exists. For more information, see Delete Path.

public virtual Task<Response<bool>> DeleteIfExistsAsync(DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteIfExistsAsync operation marks the specified directory for deletion, if the directory exists. For more information, see Delete Path.

public virtual Response DeleteSubDirectory(string path, string continuation = null, DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteSubDirectory deletes a sub directory in this directory. For more information, see Delete Path.

public virtual Task<Response> DeleteSubDirectoryAsync(string path, string continuation = null, DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The DeleteSubDirectoryAsync deletes a sub directory in this directory. For more information, see Delete Path.

public virtual DataLakeFileClient GetFileClient(string fileName)

Creates a new DataLakeFileClient object by appending fileName to the end of Uri. The new DataLakeFileClient uses the same request policy pipeline as the DataLakeDirectoryClient.

public virtual Pageable<PathItem> GetPaths(bool recursive = false, bool userPrincipalName = false, CancellationToken cancellationToken = default)

The GetPaths operation returns an async sequence of paths in this directory. Enumerating the paths may make multiple requests to the service while fetching all the values. For more information, see List Path(s).

public virtual AsyncPageable<PathItem> GetPathsAsync(bool recursive = false, bool userPrincipalName = false, CancellationToken cancellationToken = default)

public virtual Response<PathProperties> GetProperties(DataLakeRequestConditions conditions = null, CancellationToken cancellationToken = default)

The GetProperties operation returns all user-defined metadata, standard HTTP properties, and system properties for the path. It does not return the content of the path. For more information, see Get Properties.

public virtual DataLakeDirectoryClient GetSubDirectoryClient(string subdirectoryName)

Creates a new DataLakeDirectoryClient object by appending subdirectoryName to the end of Uri. The new DataLakeDirectoryClient uses the same request policy pipeline as the DataLakeDirectoryClient.

public virtual Response<DataLakeDirectoryClient> Rename(string destinationPath, string destinationFileSystem = null, DataLakeRequestConditions sourceConditions = null, DataLakeRequestConditions destinationConditions = null, CancellationToken cancellationToken = default)

The Rename operation renames a Directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual Task<Response<DataLakeDirectoryClient>> RenameAsync(string destinationPath, string destinationFileSystem = null, DataLakeRequestConditions sourceConditions = null, DataLakeRequestConditions destinationConditions = null, CancellationToken cancellationToken = default)

The RenameAsync operation renames a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public DataLakeDirectoryClient WithCustomerProvidedKey(DataLakeCustomerProvidedKey? customerProvidedKey)

Initializes a new instance of the DataLakeDirectoryClient class with an identical Uri source but the specified customerProvidedKey.