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

ShareFileClient 类

定义

ShareFileClient允许你操作 Azure 存储文件。

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

构造函数

ShareFileClient()

初始化 类的新实例 ShareFileClient 以便模拟。

ShareFileClient(String, String, String)

初始化 ShareFileClient 类的新实例。

ShareFileClient(String, String, String, ShareClientOptions)

初始化 ShareFileClient 类的新实例。

ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)

初始化 ShareFileClient 类的新实例。

ShareFileClient(Uri, ShareClientOptions)

初始化 ShareFileClient 类的新实例。

ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

初始化 ShareFileClient 类的新实例。

ShareFileClient(Uri, TokenCredential, ShareClientOptions)

初始化 ShareFileClient 类的新实例。

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

属性

AccountName

获取与文件客户端对应的存储帐户名称。

CanGenerateSasUri

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

Name

获取文件名。

Path

获取文件的路径。

ShareName

获取与文件客户端对应的共享名称。

Uri

获取目录的主 Uri 终结点。

方法

AbortCopy(String, ShareFileRequestConditions, CancellationToken)

尝试取消之前启动的挂起副本,并将目标文件保留为零长度和完整元数据。

有关详细信息,请参阅 中止复制文件

AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)

尝试取消之前启动的挂起副本,并将目标文件保留为零长度和完整元数据。

有关详细信息,请参阅 中止复制文件

ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)

操作 ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) 清除 range 文件的 。

有关详细信息,请参阅 放置范围

ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)

操作 ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) 清除 range 文件的 。

有关详细信息,请参阅 放置范围

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

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

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

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

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

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

Delete(ShareFileRequestConditions, CancellationToken)

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

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

DeleteAsync(ShareFileRequestConditions, CancellationToken)

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

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

DeleteIfExists(ShareFileRequestConditions, CancellationToken)

此操作 DeleteIfExists(ShareFileRequestConditions, CancellationToken) 会立即从存储帐户中删除该文件(如果存在)。

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

DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)

此操作 DeleteIfExists(ShareFileRequestConditions, CancellationToken) 会立即从存储帐户中删除该文件(如果存在)。

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

Download(ShareFileDownloadOptions, CancellationToken)

Download(ShareFileDownloadOptions, CancellationToken)操作可从系统读取或下载文件,包括其元数据和属性。

有关详细信息,请参阅 获取文件

DownloadAsync(ShareFileDownloadOptions, CancellationToken)

DownloadAsync(ShareFileDownloadOptions, CancellationToken)操作可从系统读取或下载文件,包括其元数据和属性。

有关详细信息,请参阅 获取文件

Exists(CancellationToken)

Exists(CancellationToken)可以对 调用 ShareFileClient 操作,以查看存储帐户上的共享中是否存在关联的文件。

ExistsAsync(CancellationToken)

Exists(CancellationToken)可以对 调用 ShareFileClient 操作,以查看存储帐户上的共享中是否存在关联的文件。

ForceCloseAllHandles(CancellationToken)

ForceCloseAllHandles(CancellationToken) 操作关闭服务中文件上打开的所有句柄。

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

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

ForceCloseAllHandlesAsync(CancellationToken)

ForceCloseAllHandlesAsync(CancellationToken) 操作关闭服务中文件上打开的所有句柄。

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

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

ForceCloseHandle(String, CancellationToken)

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

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

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

ForceCloseHandleAsync(String, CancellationToken)

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

此 API 旨在与一起使用 GetHandlesAsync(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。 SAS 由客户端的共享密钥凭据签名。

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

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

GetCopyAuthorizationHeaderAsync(ShareFileClient, CancellationToken)

ShareFileClient获取 用于在执行服务到服务复制时传递授权的 HttpAuthorization ,其中需要 OAuth 对源进行身份验证。

GetHandles(CancellationToken)

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

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

GetHandlesAsync(CancellationToken)

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

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

GetParentShareClientCore()

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

GetParentShareDirectoryClientCore()

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

GetProperties(ShareFileRequestConditions, CancellationToken)

GetProperties(ShareFileRequestConditions, CancellationToken) 操作返回文件的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不返回文件的内容。

有关详细信息,请参阅 获取文件属性

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) 操作返回文件的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不返回文件的内容。

有关详细信息,请参阅 获取文件属性

GetRangeList(ShareFileGetRangeListOptions, CancellationToken)

返回文件的有效范围列表。

有关详细信息,请参阅 列出范围

GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)

返回文件的有效范围列表。

有关详细信息,请参阅 列出范围

GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)

返回自使用 previousSnapshot 以来文件中已更改的区域列表。

有关详细信息,请参阅 列出范围

GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)

返回自使用 previousSnapshot 以来文件中已更改的区域列表。

有关详细信息,请参阅 列出范围

OpenRead(ShareFileOpenReadOptions, CancellationToken)

打开一个流以便从文件读取。 流将仅在从中读取流时下载文件。

OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)

打开一个流以便从文件读取。 流将仅在从中读取流时下载文件。

OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

打开一个流以便向文件写入。

OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

打开一个流以便向文件写入。

Rename(String, ShareFileRenameOptions, CancellationToken)

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

RenameAsync(String, ShareFileRenameOptions, CancellationToken)

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

SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)操作可设置文件的系统属性。

有关详细信息,请参阅 设置文件属性

SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)操作可设置文件的系统属性。

有关详细信息,请参阅 设置文件属性

SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)

SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) 操作将指定文件的用户定义元数据设置为一个或多个名称/值对。

有关详细信息,请参阅 设置文件元数据

SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)

SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) 操作将指定文件的用户定义元数据设置为一个或多个名称/值对。

有关详细信息,请参阅 设置文件元数据

StartCopy(Uri, ShareFileCopyOptions, CancellationToken)

将 Blob 或文件复制到存储帐户内的目标文件。

有关详细信息,请参阅 复制文件

StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)

将 Blob 或文件复制到存储帐户内的目标文件。

有关详细信息,请参阅 复制文件

Upload(Stream, ShareFileUploadOptions, CancellationToken)

Upload(Stream, ShareFileUploadOptions, CancellationToken) 操作写入 options.Stream.Stream 文件。

有关详细信息,请参阅 放置范围

UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)

UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) 操作写入 options.Stream.Stream 文件。

有关详细信息,请参阅 放置范围

UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

Azure.Storage.Files.Shares.ShareFileClient.UploadRange(Azure.HttpRange,System.IO.Stream,System.Byte[],System.IProgress{System.Int64},Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) 操作写入 content 文件的 range

有关详细信息,请参阅 放置范围

UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

Azure.Storage.Files.Shares.ShareFileClient.UploadRangeAsync(Azure.HttpRange,System.IO.Stream,System.Byte[],System.IProgress{System.Int64},Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) 操作写入 content 文件的 range

有关详细信息,请参阅 放置范围

UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)

UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) 操作将一个范围从一个 Azure 文件写入另一个 Azure 文件。 仅版本 2019-02-02 及更高版本支持此 API。

UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)

Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) 操作将一个范围从一个 Azure 文件写入另一个 Azure 文件。 仅版本 2019-02-02 及更高版本支持此 API。

WithSnapshot(String)

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

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

扩展方法

GetShareLeaseClient(ShareFileClient, String)

初始化 ShareLeaseClient 类的新实例。

GetParentShareClient(ShareFileClient)

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

GetParentShareDirectoryClient(ShareFileClient)

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

适用于