你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
DataLakePathClient class
DataLakePathClient 表示 Azure 存储路径 (目录或文件) 的 URL。
- 扩展
-
StorageClient
构造函数
| Data |
从 URL 和管道创建 DataLakePathClient 的实例。 |
| Data |
从 URL 和凭据创建 DataLakePathClient 的实例。 |
属性
| file |
当前文件系统的名称。 |
| name | 目录或文件) (当前路径的名称。 |
继承属性
| account |
|
| credential | 例如 AnonymousCredential、StorageSharedKeyCredential 或包中 |
| url | 编码的 URL 字符串值。 |
方法
构造函数详细信息
DataLakePathClient(string, Pipeline)
从 URL 和管道创建 DataLakePathClient 的实例。
new DataLakePathClient(url: string, pipeline: Pipeline)参数
- url
-
string
指向 Azure 存储数据湖路径的客户端字符串， (目录或文件) ，例如“https://myaccount.dfs.core.windows.net/filesystem/directory"或 “https://myaccount.dfs.core.windows.net/filesystem/file"。 如果使用 AnonymousCredential，则可以追加 SAS，例如“https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"”。
- pipeline
- Pipeline
调用 newPipeline () 以创建默认管道，或提供自定义管道。
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
从 URL 和凭据创建 DataLakePathClient 的实例。
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)参数
- url
-
string
指向 Azure 存储数据湖路径的客户端字符串， (目录或文件) ，例如“https://myaccount.dfs.core.windows.net/filesystem/directory"或 “https://myaccount.dfs.core.windows.net/filesystem/file"。 如果使用 AnonymousCredential，则可以追加 SAS，例如“https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"”。
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
例如 AnonymousCredential、StorageSharedKeyCredential 或包中 @azure/identity 用于对服务请求进行身份验证的任何凭据。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。
- options
- StoragePipelineOptions
可选。 用于配置 HTTP 管道的选项。
属性详细信息
fileSystemName
当前文件系统的名称。
string fileSystemName属性值
string
name
目录或文件) (当前路径的名称。
string name属性值
string
继承属性详细信息
accountName
accountName: string属性值
string
继承自 StorageClient.accountName
credential
例如 AnonymousCredential、StorageSharedKeyCredential 或包中 @azure/identity 用于对服务请求进行身份验证的任何凭据。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential属性值
继承自 StorageClient.credential
url
编码的 URL 字符串值。
url: string属性值
string
继承自 StorageClient.url
方法详细信息
create(PathResourceTypeModel, PathCreateOptions)
创建目录或路径。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>参数
- resourceType
- PathResourceTypeModel
资源类型，“directory”或“file”。
- options
- PathCreateOptions
可选。 创建路径时的选项。
返回
Promise<PathCreateResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
创建目录或文件。 如果资源已存在，则不会更改。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>参数
- resourceType
- PathResourceTypeModel
资源类型，“directory”或“file”。
- options
- PathCreateIfNotExistsOptions
返回
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
(目录或文件) 删除当前路径。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>参数
- recursive
-
boolean
仅当资源为目录时才必需且有效。 如果为“true”，则将删除目录下的所有路径。
- options
- PathDeleteOptions
可选。 删除路径时的选项。
返回
Promise<PathDeleteResponse>
deleteIfExists(boolean, PathDeleteOptions)
删除当前路径 (目录或文件) （如果存在）。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>参数
- recursive
-
boolean
仅当资源为目录时才必需且有效。 如果为“true”，则将删除目录下的所有路径。
- options
- PathDeleteOptions
返回
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
如果此客户端表示的 Data Lake 文件存在，则返回 true;否则为 false。
注意：请谨慎使用此函数，因为其他客户端或应用程序可能会删除现有文件。 反之亦然，此函数完成后，其他客户端或应用程序可能会添加新文件。
function exists(options?: PathExistsOptions): Promise<boolean>参数
- options
- PathExistsOptions
options to Exists 操作。
返回
Promise<boolean>
getAccessControl(PathGetAccessControlOptions)
返回文件) 的路径 (目录的访问控制数据。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>参数
- options
- PathGetAccessControlOptions
可选。 获取文件访问控制时的选项。
返回
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
获取 DataLakeLeaseClient ，用于管理路径 (目录或文件) 的租约。
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient参数
- proposeLeaseId
-
string
可选。 初始建议租约 ID。
返回
getProperties(PathGetPropertiesOptions)
返回路径 (目录或文件) 的所有用户定义元数据、标准 HTTP 属性和系统属性。
警告：响应 metadata 中返回的对象将具有小写的键，即使它们最初包含大写字符也是如此。 这不同于 DataLakeFileSystemClient 方法返回的元数据键，这些元数据键使用 includeMetadata 选项列出路径，该选项将保留其原始大小写。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>参数
- options
- PathGetPropertiesOptions
可选。 获取路径属性时的选项。
返回
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
在同一文件系统中移动目录或文件。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>参数
- destinationPath
-
string
目标目录路径，如“directory”或文件路径“directory/file”。 如果 destinationPath 使用 SAS 进行身份验证，请将 SAS 添加到目标路径，如“directory/file？sasToken”。
- options
- PathMoveOptions
可选。 移动目录或文件时的选项。
返回
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
将目录或文件移动到另一个文件系统。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>参数
- destinationFileSystem
-
string
目标文件系统，如“filesystem”。
- destinationPath
-
string
目标目录路径（如“directory”）或文件路径“directory/file”如果 destinationPath 使用 SAS 进行身份验证，请将 SAS 添加到目标路径，例如“directory/file？sasToken”。
- options
- PathMoveOptions
可选。 移动目录或文件时的选项。
返回
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
删除路径和子路径上的访问控制。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>参数
文件或目录的 POSIX 访问控制列表。
可选。 选项
返回
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
设置文件) 的路径 (目录的访问控制数据。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>参数
- acl
文件或目录的 POSIX 访问控制列表。
- options
- PathSetAccessControlOptions
可选。 设置路径访问控制时的选项。
返回
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
设置路径和子路径上的访问控制。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>参数
- acl
文件或目录的 POSIX 访问控制列表。
可选。 选项
返回
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
在路径 (目录或文件) 上设置系统属性。
如果未提供任何值，或者没有为指定的 Blob HTTP 标头提供值，则将清除这些没有值的 Blob HTTP 标头。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>参数
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
返回
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
将文件) 的指定路径 (目录的用户定义元数据设置为一个或多个名称/值对。
如果未提供选项，或者参数中未定义任何元数据，则将删除路径元数据。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>参数
- metadata
- Metadata
可选。 将现有元数据替换为此值。 如果未提供任何值，则将删除现有元数据。
- options
- PathSetMetadataOptions
可选。 设置路径元数据时的选项。
返回
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
设置对路径的文件权限。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>参数
- permissions
- PathPermissions
文件所有者、文件拥有组和其他人的 POSIX 访问权限。
- options
- PathSetPermissionsOptions
可选。 设置路径权限时的选项。
返回
Promise<PathSetPermissionsResponse>
toDirectoryClient()
如果当前路径是目录，请将当前 DataLakePathClient 转换为 DataLakeDirectoryClient。
function toDirectoryClient(): DataLakeDirectoryClient返回
toFileClient()
如果当前路径是文件，请将当前 DataLakePathClient 转换为 DataLakeFileClient。
function toFileClient(): DataLakeFileClient返回
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
修改路径和子路径上的访问控制。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>参数
- acl
文件或目录的 POSIX 访问控制列表。
可选。 选项