Class DataLakeFileSystemClient

Package version

Hierarchy

StorageClient
- DataLakeFileSystemClient

Index

Constructors

constructor

Properties

Accessors

name

Methods

Constructors

constructor

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

Overrides StorageClient.constructor
- Defined in DataLakeFileSystemClient.ts:67
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns DataLakeFileSystemClient
Overrides StorageClient.constructor
- Defined in DataLakeFileSystemClient.ts:83
Parameters
- url: string
- pipeline: Pipeline
Returns DataLakeFileSystemClient

Properties

accountName

accountName: string

Protected blobEndpointUrl

blobEndpointUrl: string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Protected dfsEndpointUrl

dfsEndpointUrl: string

Protected isHttps

isHttps: boolean

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

name

name:

Methods

create

create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>

- Defined in DataLakeFileSystemClient.ts:190
Parameters
- Default value options: FileSystemCreateOptions = {}
Returns Promise<FileSystemCreateResponse>

delete

delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>

- Defined in DataLakeFileSystemClient.ts:221
Parameters
- Default value options: FileSystemDeleteOptions = {}
Returns Promise<FileSystemDeleteResponse>

getAccessPolicy

getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>

- Defined in DataLakeFileSystemClient.ts:342
Parameters
- Default value options: FileSystemGetAccessPolicyOptions = {}
Returns Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient

getDataLakeLeaseClient(proposeLeaseId: undefined | string): DataLakeLeaseClient

- Defined in DataLakeFileSystemClient.ts:176
Parameters
- Optional proposeLeaseId: undefined | string
Returns DataLakeLeaseClient

getDirectoryClient

getDirectoryClient(directoryName: string): DataLakeDirectoryClient

- Defined in DataLakeFileSystemClient.ts:148
Parameters
- directoryName: string
Returns DataLakeDirectoryClient

getFileClient

getFileClient(fileName: string): DataLakeFileClient

- Defined in DataLakeFileSystemClient.ts:162
Parameters
- fileName: string
Returns DataLakeFileClient

getProperties

getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>

- Defined in DataLakeFileSystemClient.ts:257
Parameters
- Default value options: FileSystemGetPropertiesOptions = {}
Returns Promise<FileSystemGetPropertiesResponse>

listPaths

listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse>

- Defined in DataLakeFileSystemClient.ts:494
Parameters
- Default value options: ListPathsOptions = {}
Returns PagedAsyncIterableIterator<Path, FileSystemListPathsResponse>

setAccessPolicy

setAccessPolicy(access: PublicAccessType, fileSystemAcl: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>

- Defined in DataLakeFileSystemClient.ts:392
Parameters
- Optional access: PublicAccessType
- Optional fileSystemAcl: SignedIdentifier<AccessPolicy>[]
- Default value options: FileSystemSetAccessPolicyOptions = {}
Returns Promise<FileSystemSetAccessPolicyResponse>

setMetadata

setMetadata(metadata: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>

- Defined in DataLakeFileSystemClient.ts:305
Parameters
- Optional metadata: Metadata
- Default value options: FileSystemSetMetadataOptions = {}
Returns Promise<FileSystemSetMetadataResponse>

Generated using TypeDoc