Creates an instance of DataLakePathClient from url and pipeline.
A Client string pointing to Azure Storage data lake path (directory or file), such as "https://myaccount.dfs.core.windows.net/filesystem/directory" or "https://myaccount.dfs.core.windows.net/filesystem/file". You can append a SAS if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Encoded URL string value for corresponding blob endpoint.
Path context with blob endpoint.
Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity
package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
Encoded URL string value for corresponding dfs endpoint.
Request policy pipeline.
StorageClient is a reference to protocol layer operations entry, which is generated by AutoRest generator.
storageClientContextWithBlobEndpoint is a reference to protocol layer operations entry, which is generated by AutoRest generator, with its url pointing to the Blob endpoint.
Encoded URL string value.
Name of current file system.
Name of current path (directory or file).
Create a directory or path.
Resource type, "directory" or "file".
Optional. Options when creating path.
Create a directory or file. If the resource already exists, it is not changed.
Resource type, "directory" or "file".
-
Delete current path (directory or file).
Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
Optional. Options when deleting path.
Delete current path (directory or file) if it exists.
Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
-
Returns true if the Data Lake file represented by this client exists; false otherwise.
NOTE: use this function with care since an existing file might be deleted by other clients or applications. Vice versa new files might be added by other clients or applications after this function completes.
options to Exists operation.
Returns the access control data for a path (directory of file).
Optional. Options when getting file access control.
Get a DataLakeLeaseClient that manages leases on the path (directory or file).
Optional. Initial proposed lease Id.
Returns all user-defined metadata, standard HTTP properties, and system properties for the path (directory or file).
WARNING: The metadata
object returned in the response will have its keys in lowercase, even if
they originally contained uppercase characters. This differs from the metadata keys returned by
the methods of DataLakeFileSystemClient that list paths using the includeMetadata
option, which
will retain their original casing.
Optional. Options when getting path properties.
Move directory or file within same file system.
Destination directory path like "directory" or file path "directory/file". If the destinationPath is authenticated with SAS, add the SAS to the destination path like "directory/file?sasToken".
Optional. Options when moving directory or file.
Move directory or file to another file system.
Destination file system like "filesystem".
Destination directory path like "directory" or file path "directory/file" If the destinationPath is authenticated with SAS, add the SAS to the destination path like "directory/file?sasToken".
Optional. Options when moving directory or file.
Removes the Access Control on a path and sub paths.
The POSIX access control list for the file or directory.
Optional. Options
Set the access control data for a path (directory of file).
The POSIX access control list for the file or directory.
Optional. Options when setting path access control.
Sets the Access Control on a path and sub paths.
The POSIX access control list for the file or directory.
Optional. Options
Sets system properties on the path (directory or file).
If no value provided, or no value provided for the specified blob HTTP headers, these blob HTTP headers without a value will be cleared.
-
-
Sets user-defined metadata for the specified path (directory of file) as one or more name-value pairs.
If no option provided, or no metadata defined in the parameter, the path metadata will be removed.
Optional. Replace existing metadata with this value. If no value provided the existing metadata will be removed.
Optional. Options when setting path metadata.
Sets the file permissions on a path.
The POSIX access permissions for the file owner, the file owning group, and others.
Optional. Options when setting path permissions.
Convert current DataLakePathClient to DataLakeDirectoryClient if current path is a directory.
Convert current DataLakePathClient to DataLakeFileClient if current path is a file.
Modifies the Access Control on a path and sub paths.
The POSIX access control list for the file or directory.
Optional. Options
Generated using TypeDoc
A PathClientInternal represents a URL to the Azure Storage path (directory or file) to help to construct a path client to expose Path context with blob endpoint.