DataLakePathClient | @azure/storage-file-datalake

A DataLakePathClient represents a URL to the Azure Storage path (directory or file).

Hierarchy

StorageClient
- DataLakePathClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions): DataLakePathClient
new DataLakePathClient(url: string, pipeline: Pipeline): DataLakePathClient

Overrides StorageClient.constructor
- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:208
Creates an instance of DataLakePathClient from url and credential.

Parameters
- url: 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".
- Optional credential: 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.
- Optional options: StoragePipelineOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns DataLakePathClient
Overrides StorageClient.constructor
- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:223
Creates an instance of DataLakePathClient from url and pipeline.

Parameters
- url: 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".
- pipeline: Pipeline
  
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Returns DataLakePathClient

Properties

accountName

accountName: string

Protected blobEndpointUrl

blobEndpointUrl: string

Encoded URL string value for corresponding blob endpoint.

credential

credential: 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.

Protected dfsEndpointUrl

dfsEndpointUrl: string

Encoded URL string value for corresponding dfs endpoint.

Protected isHttps

isHttps: boolean

Protected pipeline

pipeline: Pipeline

Request policy pipeline.

internal

Protected storageClientContext

storageClientContext: StorageClientContext

StorageClient is a reference to protocol layer operations entry, which is generated by AutoRest generator.

Protected storageClientContextToBlobEndpoint

storageClientContextToBlobEndpoint: StorageClientContext

storageClientContextWithBlobEndpoint is a reference to protocol layer operations entry, which is generated by AutoRest generator, with its url pointing to the Blob endpoint.

url

url: string

Encoded URL string value.

Accessors

fileSystemName

get fileSystemName(): string

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:268
Name of current file system.

readonly

Returns string

name

get name(): string

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:277
Name of current path (directory or file).

readonly

Returns string

Methods

create

create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:314
Create a directory or path.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

Parameters
- resourceType: PathResourceTypeModel
  
  Resource type, "directory" or "file".
- Default value options: PathCreateOptions = {}
  
  Optional. Options when creating path.
Returns Promise<PathCreateResponse>

createIfNotExists

createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:348
Create a directory or file. If the resource already exists, it is not changed.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

Parameters
- resourceType: PathResourceTypeModel
  
  Resource type, "directory" or "file".
- Default value options: PathCreateIfNotExistsOptions = {}
  
  -
Returns Promise<PathCreateIfNotExistsResponse>

delete

delete(recursive?: undefined | false | true, options?: PathDeleteOptions): Promise<PathDeleteResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:418
Delete current path (directory or file).

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

Parameters
- Optional recursive: undefined | false | true
  
  Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
- Default value options: PathDeleteOptions = {}
  
  Optional. Options when deleting path.
Returns Promise<PathDeleteResponse>

deleteIfExists

deleteIfExists(recursive?: undefined | false | true, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:461
Delete current path (directory or file) if it exists.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

Parameters
- Optional recursive: undefined | false | true
  
  Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
- Default value options: PathDeleteOptions = {}
  
  -
Returns Promise<PathDeleteIfExistsResponse>

exists

exists(options?: PathExistsOptions): Promise<boolean>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:395
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.

Parameters
- Default value options: PathExistsOptions = {}
  
  options to Exists operation.
Returns Promise<boolean>

getAccessControl

getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:502
Returns the access control data for a path (directory of file).

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

Parameters
- Default value options: PathGetAccessControlOptions = {}
  
  Optional. Options when getting file access control.
Returns Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient

getDataLakeLeaseClient(proposeLeaseId?: undefined | string): DataLakeLeaseClient

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:302
Get a DataLakeLeaseClient that manages leases on the path (directory or file).

Parameters
- Optional proposeLeaseId: undefined | string
  
  Optional. Initial proposed lease Id.
Returns DataLakeLeaseClient

getProperties

getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:694
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://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

Parameters
- Default value options: PathGetPropertiesOptions = {}
  
  Optional. Options when getting path properties.
Returns Promise<PathGetPropertiesResponse>

move

move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:796
Move directory or file within same file system.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

Parameters
- destinationPath: 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".
- Optional options: PathMoveOptions
  
  Optional. Options when moving directory or file.
Returns Promise<PathMoveResponse>
- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:808
Move directory or file to another file system.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

Parameters
- destinationFileSystem: string
  
  Destination file system like "filesystem".
- destinationPath: 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".
- Optional options: PathMoveOptions
  
  Optional. Options when moving directory or file.
Returns Promise<PathMoveResponse>

removeAccessControlRecursive

removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:627
Removes the Access Control on a path and sub paths.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Parameters
- acl: RemovePathAccessControlItem[]
  
  The POSIX access control list for the file or directory.
- Default value options: PathChangeAccessControlRecursiveOptions = {}
  
  Optional. Options
Returns Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl

setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:536
Set the access control data for a path (directory of file).

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Parameters
- acl: PathAccessControlItem[]
  
  The POSIX access control list for the file or directory.
- Default value options: PathSetAccessControlOptions = {}
  
  Optional. Options when setting path access control.
Returns Promise<PathSetAccessControlResponse>

setAccessControlRecursive

setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:569
Sets the Access Control on a path and sub paths.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Parameters
- acl: PathAccessControlItem[]
  
  The POSIX access control list for the file or directory.
- Default value options: PathChangeAccessControlRecursiveOptions = {}
  
  Optional. Options
Returns Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders

setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:725
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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

Parameters
- httpHeaders: PathHttpHeaders
  
  -
- Default value options: PathSetHttpHeadersOptions = {}
  
  -
Returns Promise<PathSetHttpHeadersResponse>

setMetadata

setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:765
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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

Parameters
- Optional metadata: Metadata
  
  Optional. Replace existing metadata with this value. If no value provided the existing metadata will be removed.
- Default value options: PathSetMetadataOptions = {}
  
  Optional. Options when setting path metadata.
Returns Promise<PathSetMetadataResponse>

setPermissions

setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:656
Sets the file permissions on a path.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Parameters
- permissions: PathPermissions
  
  The POSIX access permissions for the file owner, the file owning group, and others.
- Default value options: PathSetPermissionsOptions = {}
  
  Optional. Options when setting path permissions.
Returns Promise<PathSetPermissionsResponse>

toDirectoryClient

toDirectoryClient(): DataLakeDirectoryClient

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:285
Convert current DataLakePathClient to DataLakeDirectoryClient if current path is a directory.

Returns DataLakeDirectoryClient

toFileClient

toFileClient(): DataLakeFileClient

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:293
Convert current DataLakePathClient to DataLakeFileClient if current path is a file.

Returns DataLakeFileClient

updateAccessControlRecursive

updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

- Defined in mnt/vss/_work/1/s/sdk/storage/storage-file-datalake/src/clients.ts:598
Modifies the Access Control on a path and sub paths.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Parameters
- acl: PathAccessControlItem[]
  
  The POSIX access control list for the file or directory.
- Default value options: PathChangeAccessControlRecursiveOptions = {}
  
  Optional. Options
Returns Promise<PathChangeAccessControlRecursiveResponse>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns DataLakePathClient

Parameters

url: string

pipeline: Pipeline

Returns DataLakePathClient

Properties

accountName

Protected blobEndpointUrl

credential

Protected dfsEndpointUrl

Protected isHttps

Protected pipeline

Protected storageClientContext

Protected storageClientContextToBlobEndpoint

url

Accessors

fileSystemName

Returns string

name

Returns string

Methods

create

Parameters

resourceType: PathResourceTypeModel

Default value options: PathCreateOptions = {}

Returns Promise<PathCreateResponse>

createIfNotExists

Parameters

resourceType: PathResourceTypeModel

Default value options: PathCreateIfNotExistsOptions = {}

Returns Promise<PathCreateIfNotExistsResponse>

delete

Parameters

Optional recursive: undefined | false | true

Default value options: PathDeleteOptions = {}

Returns Promise<PathDeleteResponse>

deleteIfExists

Parameters

Optional recursive: undefined | false | true

Default value options: PathDeleteOptions = {}

Returns Promise<PathDeleteIfExistsResponse>

exists

Parameters

Default value options: PathExistsOptions = {}

Returns Promise<boolean>

getAccessControl

Parameters

Default value options: PathGetAccessControlOptions = {}

Returns Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient

Parameters

Optional proposeLeaseId: undefined | string

Returns DataLakeLeaseClient

getProperties

Parameters

Default value options: PathGetPropertiesOptions = {}

Returns Promise<PathGetPropertiesResponse>

move

Parameters

destinationPath: string

Optional options: PathMoveOptions

Returns Promise<PathMoveResponse>

Parameters

destinationFileSystem: string

destinationPath: string

Optional options: PathMoveOptions

Returns Promise<PathMoveResponse>

removeAccessControlRecursive