A DataLakePathClient represents a URL to the Azure Storage path (directory or file).
Properties fileSystemNameName of current file system.
nameName of current path (directory or file).
Inherited Properties accountName credentialSuch 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.
Methods create(PathResourceType, PathCreateOptions)Create a directory or path.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)Create a directory or file. If the resource already exists, it is not changed.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)Delete current path (directory or file).
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)Delete current path (directory or file) if it exists.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)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.
getAccessControl(PathGetAccessControlOptions)Returns the access control data for a path (directory of file).
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)Get a DataLakeLeaseClient that manages leases on the path (directory or file).
getProperties(PathGetPropertiesOptions)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.
See https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)Move directory or file within same file system.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)Move directory or file to another file system.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)Removes the Access Control on a path and sub paths.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)Set the access control data for a path (directory of file).
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)Sets the Access Control on a path and sub paths.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)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.
See https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)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.
See https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)Sets the file permissions on a path.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()Convert current DataLakePathClient to DataLakeDirectoryClient if current path is a directory.
toFileClient()Convert current DataLakePathClient to DataLakeFileClient if current path is a file.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)Modifies the Access Control on a path and sub paths.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
Constructor Details DataLakePathClient(string, Pipeline)Creates an instance of DataLakePathClient from url and pipeline.
new DataLakePathClient(url: string, pipeline: Pipeline)
Parameters
string
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.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)Creates an instance of DataLakePathClient from url and credential.
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parameters
string
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".
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
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.
Name of current file system.
string fileSystemName
Property Value
string
nameName of current path (directory or file).
string name
Property Value
string
Inherited Property Details accountNameaccountName: string
Property Value
string
Inherited From StorageClient.accountName
credentialSuch 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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Property Value
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Inherited From StorageClient.credential
urlEncoded URL string value.
url: string
Property Value
string
Inherited From StorageClient.url
Method Details create(PathResourceType, PathCreateOptions) createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions) delete(boolean, PathDeleteOptions) deleteIfExists(boolean, PathDeleteOptions) exists(PathExistsOptions)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.
function exists(options?: PathExistsOptions): Promise<boolean>
Parameters Returns
Promise<boolean>
getAccessControl(PathGetAccessControlOptions) getDataLakeLeaseClient(string)Get a DataLakeLeaseClient that manages leases on the path (directory or file).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parameters
string
Optional. Initial proposed lease Id.
Returns getProperties(PathGetPropertiesOptions)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.
See https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>
Parameters Returns
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions) move(string, string, PathMoveOptions)Move directory or file to another file system.
See https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Parameters
string
Destination file system like "filesystem".
string
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".
ReturnsPromise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions) setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions) setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions) setMetadata(Metadata, PathSetMetadataOptions)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.
See https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>
Parameters
Optional. Replace existing metadata with this value. If no value provided the existing metadata will be removed.
ReturnsPromise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions) toDirectoryClient()Convert current DataLakePathClient to DataLakeDirectoryClient if current path is a directory.
function toDirectoryClient(): DataLakeDirectoryClient
Returns toFileClient()
Convert current DataLakePathClient to DataLakeFileClient if current path is a file.
function toFileClient(): DataLakeFileClient
Returns updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4