DataLakeFileSystemClient Class

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

Package:: Azure.Storage.Files.DataLake v12.21.0

Package:: Azure.Storage.Files.DataLake v12.21.0-beta.2

Source:: DataLakeFileSystemClient.cs

Source:: DataLakeFileSystemClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The DataLakeFileSystemClient allows you to manipulate Azure Data Lake file systems and their directories and files.

public class DataLakeFileSystemClient

type DataLakeFileSystemClient = class

Public Class DataLakeFileSystemClient

Inheritance: Object
DataLakeFileSystemClient

Constructors

DataLakeFileSystemClient()	Initializes a new instance of the DataLakeFileSystemClient class for mocking.
DataLakeFileSystemClient(String, String, DataLakeClientOptions)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(String, String)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, AzureSasCredential, DataLakeClientOptions)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, AzureSasCredential)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, DataLakeClientOptions)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, StorageSharedKeyCredential, DataLakeClientOptions)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, StorageSharedKeyCredential)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, TokenCredential, DataLakeClientOptions)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri, TokenCredential)	Initializes a new instance of the DataLakeFileSystemClient class.
DataLakeFileSystemClient(Uri)	Initializes a new instance of the DataLakeFileSystemClient class.

Properties

AccountName	Gets the Storage account name corresponding to the share client.
CanGenerateSasUri	Indicates whether the client is able to generate a SAS uri. Client can generate a SAS url if it is authenticated with a StorageSharedKeyCredential.
Name	Gets the name of the file system.
Uri	Gets the file systems's primary Uri endpoint.

Methods

Create(DataLakeFileSystemCreateOptions, CancellationToken)	The Create(DataLakeFileSystemCreateOptions, CancellationToken) operation creates a new file system under the specified account. If the file system with the same name already exists, the operation fails. For more information, see Create Container.
CreateAsync(DataLakeFileSystemCreateOptions, CancellationToken)	The CreateAsync(DataLakeFileSystemCreateOptions, CancellationToken) operation creates a new file system under the specified account. If the file system with the same name already exists, the operation fails. For more information, see Create Container.
CreateDirectory(String, DataLakePathCreateOptions, CancellationToken)	The CreateDirectory(String, DataLakePathCreateOptions, CancellationToken) operation creates a directory in this file system. If the directory already exists, it will be overwritten. If you don't intent to overwrite an existing directory, consider using the CreateIfNotExists(DataLakePathCreateOptions, CancellationToken) API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateDirectoryAsync(String, DataLakePathCreateOptions, CancellationToken)	The CreateDirectoryAsync(String, DataLakePathCreateOptions, CancellationToken) operation creates a directory in this file system. If the directory already exists, it will be overwritten. If you don't intent to overwrite an existing directory, consider using the CreateIfNotExistsAsync(DataLakePathCreateOptions, CancellationToken) API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateFile(String, DataLakePathCreateOptions, CancellationToken)	The CreateFile(String, DataLakePathCreateOptions, CancellationToken) operation creates a file in this file system. If the file already exists, it will be overwritten. If you don't intent to overwrite an existing file, consider using the CreateIfNotExists(DataLakePathCreateOptions, CancellationToken) API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateFileAsync(String, DataLakePathCreateOptions, CancellationToken)	The CreateFileAsync(String, DataLakePathCreateOptions, CancellationToken) creates a file in this file system. If the file already exists, it will be overwritten. If you don't intent to overwrite an existing file, consider using the CreateIfNotExistsAsync(DataLakePathCreateOptions, CancellationToken) API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateIfNotExists(DataLakeFileSystemCreateOptions, CancellationToken)	The CreateIfNotExistsAsync(DataLakeFileSystemCreateOptions, CancellationToken) operation creates a new file system under the specified account. If the file system with the same name already exists, the operation fails. For more information, see Create Container.
CreateIfNotExistsAsync(DataLakeFileSystemCreateOptions, CancellationToken)	The CreateIfNotExistsAsync(DataLakeFileSystemCreateOptions, CancellationToken) operation creates a new file system under the specified account. If the file system with the same name already exists, the operation fails. For more information, see Create Container.
Delete(DataLakeRequestConditions, CancellationToken)	The Delete(DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion. The file system and any paths contained within it are later deleted during garbage collection which could take several minutes. For more information, see Delete Container.
DeleteAsync(DataLakeRequestConditions, CancellationToken)	The DeleteAsync(DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion. The file system and any paths contained within it are later deleted during garbage collection which could take several minutes. For more information, see Delete Container.
DeleteDirectory(String, DataLakeRequestConditions, CancellationToken)	The DeleteDirectory(String, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion. The path is later deleted during garbage collection which could take several minutes. For more information, see Delete Path.
DeleteDirectoryAsync(String, DataLakeRequestConditions, CancellationToken)	The DeleteDirectoryAsync(String, DataLakeRequestConditions, CancellationToken) deletes a directory in this file system. garbage collection which could take several minutes. For more information, see Delete Path.
DeleteFile(String, DataLakeRequestConditions, CancellationToken)	The DeleteFile(String, DataLakeRequestConditions, CancellationToken) deletes a file in this file system. For more information, see Delete Path.
DeleteFileAsync(String, DataLakeRequestConditions, CancellationToken)	The DeleteFileAsync(String, DataLakeRequestConditions, CancellationToken) deletes a file in this file system. For more information, see Delete Path.
DeleteIfExists(DataLakeRequestConditions, CancellationToken)	The DeleteIfExists(DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion if it exists. The file system and any files and directories contained within it are later deleted during garbage collection which could take several minutes. For more information, see Delete Container.
DeleteIfExistsAsync(DataLakeRequestConditions, CancellationToken)	The DeleteIfExistsAsync(DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion if it exists. The file system and any files and directories contained within it are later deleted during garbage collection which could take several minutes. For more information, see Delete Container.
Exists(CancellationToken)	The Exists(CancellationToken) operation can be called on a DataLakeFileClient to see if the associated file system exists on the storage account in the storage service.
ExistsAsync(CancellationToken)	The ExistsAsync(CancellationToken) operation can be called on a DataLakeFileSystemClient to see if the associated file system exists on the storage account in the storage service.
GenerateSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset)	The GenerateSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the BlobContainerClient properties and parameters passed. The SAS is signed by the shared key credential of the client. To check if the client is able to sign a Service Sas see CanGenerateSasUri. For more information, see Constructing a service SAS.
GenerateSasUri(DataLakeSasBuilder)	The GenerateSasUri(DataLakeSasBuilder) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the shared key credential of the client. To check if the client is able to sign a Service Sas see CanGenerateSasUri. For more information, see Constructing a Service SAS.
GenerateUserDelegationSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset, UserDelegationKey)	The GenerateUserDelegationSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key passed in. For more information, see Creating an user delegation SAS.
GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey)	The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the user delegation key passed in. For more information, see Creating an user delegation SAS.
GetAccessPolicy(DataLakeRequestConditions, CancellationToken)	The GetAccessPolicy(DataLakeRequestConditions, CancellationToken) operation gets the permissions for this file system. The permissions indicate whether file system data may be accessed publicly. For more information, see Get Container ACL.
GetAccessPolicyAsync(DataLakeRequestConditions, CancellationToken)	The GetAccessPolicyAsync(DataLakeRequestConditions, CancellationToken) operation gets the permissions for this file system. The permissions indicate whether file system data may be accessed publicly. For more information, see Get Container ACL.
GetDeletedPaths(String, CancellationToken)	Gets the paths that have recently been soft deleted in this file system.
GetDeletedPathsAsync(String, CancellationToken)	Gets the paths that have recently been soft deleted in this file system.
GetDirectoryClient(String)	Create a new DataLakeDirectoryClient object by appending `directoryName` to the end of Uri. The new DataLakeDirectoryClient uses the same request policy pipeline as the DataLakeFileSystemClient.
GetFileClient(String)	Create a new DataLakeFileClient object by appending `fileName` to the end of Uri. The new DataLakeFileClient uses the same request policy pipeline as the DataLakeFileClient.
GetParentServiceClientCore()	Create a new DataLakeServiceClient that pointing to this DataLakeFileSystemClient's parent container. The new DataLakeServiceClient uses the same request policy pipeline as the DataLakeFileSystemClient.
GetPaths(String, Boolean, Boolean, CancellationToken)	The GetPaths(String, Boolean, Boolean, CancellationToken) operation returns an async sequence of paths in this file system. Enumerating the paths may make multiple requests to the service while fetching all the values. For more information, see List Path(s).
GetPathsAsync(String, Boolean, Boolean, CancellationToken)	The GetPathsAsync(String, Boolean, Boolean, CancellationToken) operation returns an async sequence of paths in this file system. Enumerating the paths may make multiple requests to the service while fetching all the values. For more information, see List Path(s).
GetProperties(DataLakeRequestConditions, CancellationToken)	The GetProperties(DataLakeRequestConditions, CancellationToken) operation returns all user-defined metadata and system properties for the specified file system. The data returned does not include the file system's list of paths. For more information, see Get Container Properties.
GetPropertiesAsync(DataLakeRequestConditions, CancellationToken)	The GetPropertiesAsync(DataLakeRequestConditions, CancellationToken) operation returns all user-defined metadata and system properties for the specified file system. The data returned does not include the file system's list of paths. For more information, see Get Container Properties.
SetAccessPolicy(PublicAccessType, IEnumerable<DataLakeSignedIdentifier>, DataLakeRequestConditions, CancellationToken)	The SetAccessPolicy(PublicAccessType, IEnumerable<DataLakeSignedIdentifier>, DataLakeRequestConditions, CancellationToken) operation sets the permissions for the specified file system. The permissions indicate whether file system data may be accessed publicly. For more information, see Set Container ACL.
SetAccessPolicyAsync(PublicAccessType, IEnumerable<DataLakeSignedIdentifier>, DataLakeRequestConditions, CancellationToken)	The SetAccessPolicyAsync(PublicAccessType, IEnumerable<DataLakeSignedIdentifier>, DataLakeRequestConditions, CancellationToken) operation sets the permissions for the specified file system. The permissions indicate whether the file system data may be accessed publicly. For more information, see Set Container ACL.
SetMetadata(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken)	The SetMetadata(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets one or more user-defined name-value pairs for the specified file system. For more information, see Set Container Metadata.
SetMetadataAsync(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken)	The SetMetadataAsync(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets one or more user-defined name-value pairs for the specified file system. For more information, see Set Container Metadata.
UndeletePath(String, String, CancellationToken)	Restores a soft deleted path.
UndeletePathAsync(String, String, CancellationToken)	Restores a soft deleted path.

Extension Methods

GetDataLakeLeaseClient(DataLakeFileSystemClient, String)	Initializes a new instance of the DataLakeLeaseClient class.
GetParentServiceClient(DataLakeFileSystemClient)	Create a new DataLakeFileSystemClient that pointing to this DataLakePathClient's parent container. The new DataLakeFileSystemClient uses the same request policy pipeline as the DataLakePathClient.

Applies to