DataLakeFileClient Class

Initializes a new instance of the DataLakeFileClient class for mocking.

Initializes a new instance of the DataLakeDirectoryClient.

Initializes a new instance of the DataLakeDirectoryClient.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Initializes a new instance of the DataLakeFileClient class.

Gets the Storage account name corresponding to the directory client.

Indicates whether the client is able to generate a SAS uri. Client can generate a SAS url if it is authenticated with a StorageSharedKeyCredential.

Gets the file system name name corresponding to the directory client.

Gets the maximum number of bytes that can be sent in each append call in Azure.Storage.Files.DataLake.DataLakeFileClient.UploadAsync(System.IO.Stream,Azure.Storage.Files.DataLake.Models.PathHttpHeaders,Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions,System.IProgress{System.Int64},Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken).

Gets the name of the file or directory.

Gets the path corresponding to the path client.

Gets the directory's primary Uri endpoint.

The Append(Stream, Int64, DataLakeFileAppendOptions, CancellationToken) operation uploads data to be appended to a file. Data can only be appended to a file. To apply previously uploaded data to a file, call Flush Data. Append is currently limited to 4000 MB per request. To upload large files all at once, consider using Upload(Stream).

For more information, see Update Path.

The AppendAsync(Stream, Int64, DataLakeFileAppendOptions, CancellationToken) operation uploads data to be appended to a file. Data can only be appended to a file. To apply perviously uploaded data to a file, call Flush Data. Append is currently limited to 4000 MB per request. To upload large files all at once, consider using UploadAsync(Stream).

For more information, see Update Path.

The Create(DataLakePathCreateOptions, CancellationToken) operation creates a file. 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.

The Create(PathResourceType, DataLakePathCreateOptions, CancellationToken) operation creates a file or directory. If the path already exists, it will be overwritten. If you don't intent to overwrite an existing path, consider using the CreateIfNotExists(PathResourceType, DataLakePathCreateOptions, CancellationToken) API.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The CreateAsync(DataLakePathCreateOptions, CancellationToken) operation creates a file. 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.

The CreateAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken) operation creates a file or directory. If the path already exists, it will be overwritten. If you don't intent to overwrite an existing path, consider using the CreateIfNotExistsAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken) API.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The CreateIfNotExists(DataLakePathCreateOptions, CancellationToken) operation creates a file. If the file already exists, it is not changed.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The Azure.Storage.Files.DataLake.DataLakePathClient.CreateIfNotExists(Azure.Storage.Files.DataLake.Models.PathResourceType,Azure.Storage.Files.DataLake.Models.PathHttpHeaders,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.String,System.Threading.CancellationToken) operation creates a file or directory. If the file or directory already exists, it is not changed.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The CreateIfNotExistsAsync(DataLakePathCreateOptions, CancellationToken) operation creates a file. If the file already exists, it is not changed.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The Azure.Storage.Files.DataLake.DataLakePathClient.CreateIfNotExistsAsync(Azure.Storage.Files.DataLake.Models.PathResourceType,Azure.Storage.Files.DataLake.Models.PathHttpHeaders,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.String,System.Threading.CancellationToken) operation creates a file or directory. If the file or directory already exists, it is not changed.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The Delete(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.

The Delete(Nullable<Boolean>, 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.

The DeleteAsync(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.

The DeleteAsync(Nullable<Boolean>, 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.

The DeleteIfExists(DataLakeRequestConditions, CancellationToken) operation marks the specified file for deletion, if the file exists. The file is later deleted during garbage collection which could take several minutes.

For more information, see Delete Path.

The DeleteIfExists(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path for deletion, if the path exists. The path is later deleted during garbage collection which could take several minutes.

For more information, see Delete Path.

The DeleteIfExistsAsync(DataLakeRequestConditions, CancellationToken) operation marks the specified file for deletion, if the file exists. The file is later deleted during garbage collection which could take several minutes.

For more information, see Delete Path.

The DeleteIfExistsAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion, if the path exists. The path is later deleted during garbage collection which could take several minutes.

For more information, see Delete Path.

The Exists(CancellationToken) operation can be called on a DataLakePathClient to see if the associated file or director exists in the file system.

The ExistsAsync(CancellationToken) operation can be called on a DataLakePathClient to see if the associated file or directory exists in the file system.

The Flush(Int64, DataLakeFileFlushOptions, CancellationToken) operation flushes (writes) previously appended data to a file.

The FlushAsync(Int64, DataLakeFileFlushOptions, CancellationToken) operation flushes (writes) previously appended data to a file.

The GenerateSasUri(DataLakeSasBuilder) returns a Uri that generates a DataLake File Service Shared Access Signature (SAS) Uri based on the Client properties and and builder. 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.

The GenerateSasUri(DataLakeSasPermissions, DateTimeOffset) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client 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.

The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) returns a Uri that generates a DataLake Path 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.

The GenerateUserDelegationSasUri(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client properties and parameter passed. The SAS is signed by the user delegation key passed in.

For more information, see Creating an user delegation SAS.

The GetAccessControl(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation returns the access control data for a path.

For more information, see Get Properties.

The GetAccessControlAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation returns the access control data for a path.

For more information, see Get Properties.

Create a new DataLakeDirectoryClient that pointing to this DataLakePathClient's parent container. The new DataLakeDirectoryClient uses the same request policy pipeline as the DataLakePathClient.

Create a new DataLakeFileSystemClient that pointing to this DataLakePathClient's parent container. The new DataLakeFileSystemClient uses the same request policy pipeline as the DataLakePathClient.

The GetProperties(DataLakeRequestConditions, CancellationToken) 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.

The GetPropertiesAsync(DataLakeRequestConditions, CancellationToken) 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.

Opens a stream for reading from the file. The stream will only download the file as the stream is read from.

Opens a stream for reading from the file. The stream will only download the file as the stream is read from.

Opens a stream for writing to the file.

Opens a stream for writing to the file..

The Query(String, DataLakeQueryOptions, CancellationToken) API returns the result of a query against the file.

The Query(String, DataLakeQueryOptions, CancellationToken) API returns the result of a query against the file.

The ReadContent() operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadContent(CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadContent(DataLakeFileReadOptions, CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadContentAsync() operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadContentAsync(CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadContentAsync(DataLakeFileReadOptions, CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadStreaming() operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadStreaming(CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadStreaming(DataLakeFileReadOptions, CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadStreamingAsync() operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadStreamingAsync(CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadStreamingAsync(DataLakeFileReadOptions, CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

The ReadTo(Stream, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided stream.

The ReadTo(String, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided file path.

The ReadToAsync(Stream, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided destination stream.

The ReadToAsync(String, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided file path.

The RemoveAccessControlRecursive(IList<RemovePathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation removes the Access Control on a path and subpaths

For more information, see Update Path.

The RemoveAccessControlRecursiveAsync(IList<RemovePathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation removes the Access Control on a path and subpaths

For more information, see Update Path.

The Rename(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken) operation renames a Directory.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

The RenameAsync(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken) operation renames a file or directory.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

Schedules the file for deletion.

Schedules the file for deletion.

The SetAccessControlList(IList<PathAccessControlItem>, String, String, DataLakeRequestConditions, CancellationToken) operation sets the Access Control on a path

For more information, see Update Path.

The SetAccessControlListAsync(IList<PathAccessControlItem>, String, String, DataLakeRequestConditions, CancellationToken) operation sets the Access Control on a path

For more information, see Update Path.

The SetAccessControlRecursive(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation sets the Access Control on a path and subpaths

For more information, see Update Path.

The SetAccessControlRecursiveAsync(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation sets the Access Control on a path and subpaths

For more information, see Update Path.

The SetHttpHeaders(PathHttpHeaders, DataLakeRequestConditions, CancellationToken) operation sets system properties on the path.

For more information, see Set Blob Properties.

The SetHttpHeadersAsync(PathHttpHeaders, DataLakeRequestConditions, CancellationToken) operation sets system properties on the PATH.

For more information, see Set Blob Properties.

The SetMetadata(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets user-defined metadata for the specified path as one or more name-value pairs.

For more information, see Set Metadata.

The SetMetadataAsync(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets user-defined metadata for the specified path as one or more name-value pairs.

For more information, see Set Metadata.

The SetPermissions(PathPermissions, String, String, DataLakeRequestConditions, CancellationToken) operation sets the file permissions on a path.

For more information, see Update Path.

The SetPermissionsAsync(PathPermissions, String, String, DataLakeRequestConditions, CancellationToken) operation sets the file permissions on a path.

For more information, see Update Path.

The UpdateAccessControlRecursive(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation modifies the Access Control on a path and subpaths

For more information, see Update Path.

The UpdateAccessControlRecursiveAsync(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation modifies the Access Control on a path and subpaths

For more information, see Update Path.

The Upload(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the overwrite parameter is not specified and the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The Upload(Stream, DataLakeFileUploadOptions, CancellationToken) operation creates and uploads content to a file. If the file already exists, its content will be overwritten, unless otherwise specified in the Conditions or alternatively use Upload(Stream), Upload(Stream, Boolean, CancellationToken).

For more information, see Update Path.

The Upload(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The Upload(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the overwrite parameter is not specified and the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The Upload(String, DataLakeFileUploadOptions, CancellationToken) operation creates and uploads content to a file.If the file already exists, its content will be overwritten, unless otherwise specified in the Conditions or alternatively use Upload(Stream), Upload(Stream, Boolean, CancellationToken).

For more information, see Update Path.

The Upload(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The UploadAsync(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the overwrite parameter is not specified and the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The UploadAsync(Stream, DataLakeFileUploadOptions, CancellationToken) operation creates and uploads content to a file. If the file already exists, its content will be overwritten, unless otherwise specified in the Conditions or alternatively use UploadAsync(Stream), UploadAsync(Stream, Boolean, CancellationToken).

For more information, see Update Path.

The UploadAsync(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The UploadAsync(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the overwrite parameter is not specified and the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

The UploadAsync(String, DataLakeFileUploadOptions, CancellationToken) operation creates and uploads content to a file. If the file already exists, its content will be overwritten, unless otherwise specified in the Conditions or alternatively use UploadAsync(Stream), UploadAsync(Stream, Boolean, CancellationToken).

For more information, see Update Path.

The UploadAsync(Stream, Boolean, CancellationToken) operation creates and uploads content to a file.

If the file already exists, then its content will not be overwritten. The request will be sent with If-None-Match Header with the value of the special wildcard. So if the file already exists a RequestFailedException is expected to be thrown.

For more information, see Update Path.

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

Initializes a new instance of the DataLakeLeaseClient class.

Create a new DataLakeDirectoryClient that pointing to this DataLakePathClient's parent directory. The new DataLakeDirectoryClient uses the same request policy pipeline as the DataLakePathClient.

Create a new DataLakeFileSystemClient that pointing to this DataLakePathClient's parent container. The new DataLakeFileSystemClient uses the same request policy pipeline as the DataLakePathClient.