DataLakePathClient class

从 URL 和管道创建 DataLakePathClient 的实例。

new DataLakePathClient(url: string, pipeline: Pipeline)

参数

从 URL 和凭据创建 DataLakePathClient 的实例。

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

参数

当前文件系统的名称。

string fileSystemName

属性值

当前路径的名称（目录或文件）。

string name

属性值

accountName: string

属性值

继承自 StorageClient.accountName

例如 AnonymousCredential、StorageSharedKeyCredential 或任何来自 @azure/identity 包的凭据，用于对服务的请求进行身份验证。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

属性值

继承自 StorageClient.credential

编码的 URL 字符串值。

url: string

属性值

继承自 StorageClient.url

创建目录或路径。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

参数

返回

创建目录或文件。 如果资源已存在，则不会更改。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

参数

返回

删除当前路径（目录或文件）。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

参数

返回

如果存在，请删除当前路径（目录或文件）。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

参数

返回

如果此客户端表示的 Data Lake 文件存在，则返回 true;否则为 false。

注意：请谨慎使用此函数，因为现有文件可能被其他客户端或应用程序删除。 反之亦然，此函数完成后，其他客户端或应用程序可能会添加新文件。

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

参数

返回

返回路径（文件目录）的访问控制数据。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

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

参数

返回

获取管理路径（目录或文件）上的租约的 DataLakeLeaseClient。

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

参数

返回

返回路径（目录或文件）的所有用户定义的元数据、标准 HTTP 属性和系统属性。

警告：响应中返回的 metadata 对象将具有小写形式的键，即使它们最初包含大写字符也是如此。 这不同于 dataLakeFileSystemClient 方法返回的元数据键，这些元数据键使用 includeMetadata 选项列出路径，该选项将保留其原始大小写。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

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

参数

返回

在同一文件系统中移动目录或文件。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

参数

返回

将目录或文件移动到另一个文件系统。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

参数

返回

删除路径和子路径上的访问控制。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

参数

返回

设置路径（文件目录）的访问控制数据。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

参数

返回

设置路径和子路径上的访问控制。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

参数

返回

在路径（目录或文件）上设置系统属性。

如果未提供任何值，或者未为指定的 Blob HTTP 标头提供任何值，则清除不带值的这些 blob HTTP 标头。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

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

参数

返回

将指定路径（文件目录）的用户定义元数据设置为一个或多个名称值对。

如果未提供任何选项，或者参数中未定义任何元数据，将删除路径元数据。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

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

参数

返回

设置路径上的文件权限。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

参数

返回

如果当前路径是目录，请将当前 DataLakePathClient 转换为 DataLakeDirectoryClient。

function toDirectoryClient(): DataLakeDirectoryClient

返回

如果当前路径为文件，请将当前 DataLakePathClient 转换为 DataLakeFileClient。

function toFileClient(): DataLakeFileClient

返回

修改路径和子路径上的访问控制。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

参数

返回