你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ShareDirectoryClient 类

定义

DirectoryClient 表示 Azure 存储文件服务的 URI,可用于操作目录。

public class ShareDirectoryClient
type ShareDirectoryClient = class
Public Class ShareDirectoryClient
继承
ShareDirectoryClient

构造函数

ShareDirectoryClient()

初始化 类的新实例 ShareDirectoryClient 进行模拟。

ShareDirectoryClient(String, String, String)

初始化 ShareDirectoryClient 类的新实例。

ShareDirectoryClient(String, String, String, ShareClientOptions)

初始化 ShareDirectoryClient 类的新实例。

ShareDirectoryClient(Uri, AzureSasCredential, ShareClientOptions)

初始化 ShareDirectoryClient 类的新实例。

ShareDirectoryClient(Uri, ShareClientOptions)

初始化 ShareDirectoryClient 类的新实例。

ShareDirectoryClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

初始化 ShareDirectoryClient 类的新实例。

ShareDirectoryClient(Uri, TokenCredential, ShareClientOptions)

初始化 ShareDirectoryClient 类的新实例。

请注意, ShareTokenIntent 令牌身份验证当前是必需的。

属性

AccountName

获取与目录客户端对应的存储帐户名称。

CanGenerateSasUri

确定客户端是否能够生成 SAS。 如果客户端使用 StorageSharedKeyCredential进行身份验证。

Name

获取目录的名称。

Path

获取目录的路径。

ShareName

获取与目录客户端对应的共享名称。

Uri

获取目录的主 Uri 终结点。

方法

Create(IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

操作在 Create(IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 指定的 Uri处创建新目录。

有关详细信息,请参阅 创建目录

CreateAsync(IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

操作在 CreateAsync(IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 指定的 Uri处创建新目录。

有关详细信息,请参阅 创建目录

CreateFile(String, Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

创建新文件或替换现有文件。

有关详细信息,请参阅 创建文件

CreateFileAsync(String, Int64, ShareFileHttpHeaders, IDictionary<String, String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

创建新文件或替换现有文件。

有关详细信息,请参阅 创建文件

CreateIfNotExists(IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

操作 CreateIfNotExists(IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 会创建新目录(如果尚不存在)。 如果该目录已存在,则不会对其进行修改。

有关详细信息,请参阅 创建目录

CreateIfNotExistsAsync(IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

操作 CreateIfNotExistsAsync(IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 会创建新目录(如果尚不存在)。 如果该目录已存在,则不会对其进行修改。

有关详细信息,请参阅 创建目录

CreateSubdirectory(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

操作 CreateSubdirectory(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 将在此目录下创建新的子目录。

有关详细信息,请参阅 创建目录

CreateSubdirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

操作 CreateSubdirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 将在此目录下创建新的子目录。

有关详细信息,请参阅 创建目录

Delete(CancellationToken)

Delete(CancellationToken)操作删除指定的空目录。

有关详细信息,请参阅 删除目录

DeleteAsync(CancellationToken)

DeleteAsync(CancellationToken)操作删除指定的空目录。

有关详细信息,请参阅 删除目录

DeleteFile(String, ShareFileRequestConditions, CancellationToken)

DeleteFile(String, ShareFileRequestConditions, CancellationToken)操作可立即从存储帐户中删除文件。

有关详细信息,请参阅 删除文件

DeleteFileAsync(String, ShareFileRequestConditions, CancellationToken)

DeleteFile(String, ShareFileRequestConditions, CancellationToken)操作可立即从存储帐户中删除文件。

有关详细信息,请参阅 删除文件

DeleteIfExists(CancellationToken)

操作 DeleteIfExists(CancellationToken) 会删除指定的空目录(如果存在)。

有关详细信息,请参阅 删除目录

DeleteIfExistsAsync(CancellationToken)

操作 DeleteIfExistsAsync(CancellationToken) 会删除指定的空目录(如果存在)。

有关详细信息,请参阅 删除目录

DeleteSubdirectory(String, CancellationToken)

DeleteSubdirectory(String, CancellationToken) 操作将删除指定的空子目录。

有关详细信息,请参阅 删除目录

DeleteSubdirectoryAsync(String, CancellationToken)

DeleteSubdirectoryAsync(String, CancellationToken) 操作将删除指定的空子目录。

有关详细信息,请参阅 删除目录

Exists(CancellationToken)

Exists(CancellationToken)可以对 调用ShareDirectoryClient操作,以查看关联的目录是否存在于存储服务中存储帐户的共享中。

ExistsAsync(CancellationToken)

Exists(CancellationToken)可以对 调用ShareDirectoryClient操作,以查看关联的目录是否存在于存储服务中存储帐户的共享中。

ForceCloseAllHandles(Nullable<Boolean>, CancellationToken)

ForceCloseAllHandles(Nullable<Boolean>, CancellationToken) 操作关闭在目录或服务上的文件上打开的所有句柄。 当资源是目录时,它可以选择性地支持以递归方式关闭子资源上的句柄。

此 API 旨在与一起 GetHandles(Nullable<Boolean>, CancellationToken) 用于强制关闭阻止操作的句柄,例如重命名目录。 SMB 客户端可能已泄漏或丢失这些句柄的跟踪。 API 对正在关闭的句柄具有客户端影响,包括由于读取或写入文件尝试失败而导致的用户可见错误。 此 API 不用作 SMB 关闭的替换或替代项。

有关详细信息,请参阅 强制关闭句柄

ForceCloseAllHandlesAsync(Nullable<Boolean>, CancellationToken)

ForceCloseAllHandlesAsync(Nullable<Boolean>, CancellationToken) 操作关闭在目录或服务上的文件上打开的所有句柄。 当资源是目录时,它可以选择性地支持以递归方式关闭子资源上的句柄。

此 API 旨在与一起 GetHandlesAsync(Nullable<Boolean>, CancellationToken) 用于强制关闭阻止操作的句柄,例如重命名目录。 SMB 客户端可能已泄漏或丢失这些句柄的跟踪。 API 对正在关闭的句柄具有客户端影响,包括由于读取或写入文件尝试失败而导致的用户可见错误。 此 API 不用作 SMB 关闭的替换或替代项。

有关详细信息,请参阅 强制关闭句柄

ForceCloseHandle(String, CancellationToken)

ForceCloseHandle(String, CancellationToken) 操作关闭在目录或服务上的文件上打开的句柄。 它支持关闭 指定的 handleId单个句柄。

此 API 旨在与一起 GetHandles(Nullable<Boolean>, CancellationToken) 用于强制关闭阻止操作的句柄,例如重命名目录。 SMB 客户端可能已泄漏或丢失这些句柄的跟踪。 API 对正在关闭的句柄具有客户端影响,包括由于读取或写入文件尝试失败而导致的用户可见错误。 此 API 不用作 SMB 关闭的替换或替代项。

有关详细信息,请参阅 强制关闭句柄

ForceCloseHandleAsync(String, CancellationToken)

ForceCloseHandle(String, CancellationToken) 操作关闭在目录或服务上的文件上打开的句柄。 它支持关闭 指定的 handleId单个句柄。

此 API 旨在与一起 GetHandlesAsync(Nullable<Boolean>, CancellationToken) 用于强制关闭阻止操作的句柄,例如重命名目录。 SMB 客户端可能已泄漏或丢失这些句柄的跟踪。 API 对正在关闭的句柄具有客户端影响,包括由于读取或写入文件尝试失败而导致的用户可见错误。 此 API 不用作 SMB 关闭的替换或替代项。

有关详细信息,请参阅 强制关闭句柄

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)

返回 GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) 一个 Uri ,根据传递的客户端属性和参数, (SAS) URI 生成共享目录服务共享访问签名。 SAS 由客户端的共享密钥凭据签名。

若要检查客户端是否能够对服务 Sas 进行签名,请参阅 CanGenerateSasUri

有关详细信息,请参阅 构造服务 SAS

GenerateSasUri(ShareSasBuilder)

GenerateSasUri(ShareSasBuilder)返回一个 ,Uri根据客户端属性 和 生成器, (SAS) URI 生成 Share Directory 服务共享访问签名。 SAS 由客户端的共享密钥凭据签名。

若要检查客户端是否能够对服务 Sas 进行签名,请参阅 CanGenerateSasUri

有关详细信息,请参阅 构造服务 SAS

GetFileClient(String)

通过将 追加fileName到 的Uri末尾来创建新的 ShareFileClient 对象。 新的 ShareFileClient 使用与 相同的请求策略管道 ShareDirectoryClient

GetFilesAndDirectories(ShareDirectoryGetFilesAndDirectoriesOptions, CancellationToken)

GetFilesAndDirectoriesAsync(ShareDirectoryGetFilesAndDirectoriesOptions, CancellationToken) 操作返回此目录中文件和子目录的异步序列。 枚举文件和目录可能会在提取所有值时向服务发出多个请求。

有关详细信息,请参阅 列出目录和文件

GetFilesAndDirectories(String, CancellationToken)

GetFilesAndDirectories(String, CancellationToken) 操作返回此目录中文件和子目录的异步序列。 枚举文件和目录可能会在提取所有值时向服务发出多个请求。

有关详细信息,请参阅 列出目录和文件

GetFilesAndDirectoriesAsync(ShareDirectoryGetFilesAndDirectoriesOptions, CancellationToken)

操作 GetFilesAndDirectoriesAsync(ShareDirectoryGetFilesAndDirectoriesOptions, CancellationToken) 返回此目录中文件和子目录的异步集合。 枚举文件和目录可能会在提取所有值时向服务发出多个请求。

有关详细信息,请参阅 列出目录和文件

GetFilesAndDirectoriesAsync(String, CancellationToken)

操作 GetFilesAndDirectoriesAsync(String, CancellationToken) 返回此目录中文件和子目录的异步集合。 枚举文件和目录可能会在提取所有值时向服务发出多个请求。

有关详细信息,请参阅 列出目录和文件

GetHandles(Nullable<Boolean>, CancellationToken)

操作 GetHandles(Nullable<Boolean>, CancellationToken) 返回目录或文件上打开的句柄的异步序列。 枚举句柄可能会在提取所有值时向服务发出多个请求。

有关详细信息,请参阅 列表句柄

GetHandlesAsync(Nullable<Boolean>, CancellationToken)

操作 GetHandlesAsync(Nullable<Boolean>, CancellationToken) 返回目录或文件上打开的句柄的异步序列。 枚举句柄可能会在提取所有值时向服务发出多个请求。

有关详细信息,请参阅 列表句柄

GetParentDirectoryClientCore()

创建一个指向此ShareFileClient的父容器的新 ShareDirectoryClient 。 新的 ShareDirectoryClient 使用与 相同的请求策略管道 ShareFileClient

GetParentShareClientCore()

创建一个指向此ShareFileClient的父容器的新 ShareClient 。 新的 ShareClient 使用与 相同的请求策略管道 ShareFileClient

GetProperties(CancellationToken)

GetProperties(CancellationToken) 操作返回指定目录的所有用户定义元数据和系统属性。 返回的数据不包括目录的子目录或文件列表。

有关详细信息,请参阅 获取目录属性

GetPropertiesAsync(CancellationToken)

GetPropertiesAsync(CancellationToken) 操作返回指定目录的所有用户定义元数据和系统属性。 返回的数据不包括目录的子目录或文件列表。

有关详细信息,请参阅 获取目录属性

GetSubdirectoryClient(String)

通过将 追加subdirectoryName到 的Uri末尾来创建新的 ShareDirectoryClient 对象。 新的 ShareDirectoryClient 使用与 相同的请求策略管道 ShareDirectoryClient

Rename(String, ShareFileRenameOptions, CancellationToken)

重命名目录。 此 API 不支持将目录从一个共享重命名到另一个共享,也不支持在存储帐户之间重命名。

RenameAsync(String, ShareFileRenameOptions, CancellationToken)

重命名目录。 此 API 不支持将目录从一个共享重命名到另一个共享,也不支持在存储帐户之间重命名。

SetHttpHeaders(FileSmbProperties, String, CancellationToken)

SetHttpHeaders(FileSmbProperties, String, CancellationToken) 操作设置目录上的系统属性。

有关详细信息,请参阅 设置目录属性

SetHttpHeadersAsync(FileSmbProperties, String, CancellationToken)

SetHttpHeadersAsync(FileSmbProperties, String, CancellationToken) 操作设置目录上的系统属性。

有关详细信息,请参阅 设置目录属性

SetMetadata(IDictionary<String,String>, CancellationToken)

操作 SetMetadata(IDictionary<String,String>, CancellationToken) 为指定目录设置一个或多个用户定义的名称/值对。

有关详细信息,请参阅 设置目录元数据

SetMetadataAsync(IDictionary<String,String>, CancellationToken)

操作 SetMetadataAsync(IDictionary<String,String>, CancellationToken) 为指定目录设置一个或多个用户定义的名称/值对。

有关详细信息,请参阅 设置目录元数据

WithSnapshot(String)

使用相同的Uri源但指定的snapshot时间戳初始化 类的新实例ShareDirectoryClient

有关详细信息,请参阅 快照共享

扩展方法

GetParentDirectoryClient(ShareDirectoryClient)

创建一个指向此ShareDirectoryClient的父容器的新 ShareDirectoryClient 。 新的 ShareDirectoryClient 使用与 相同的请求策略管道 ShareDirectoryClient

GetParentShareClient(ShareDirectoryClient)

创建一个指向此ShareDirectoryClient的父容器的新 ShareClient 。 新的 ShareClient 使用与 相同的请求策略管道 ShareDirectoryClient

适用于