ShareFileClient 類別

定義

命名空間:

Azure.Storage.Files.Shares

組件:

Azure.Storage.Files.Shares.dll

套件:

Azure.Storage.Files.Shares v12.16.0

ShareFileClient可讓您操作 Azure 儲存體檔案。

public class ShareFileClient

type ShareFileClient = class

Public Class ShareFileClient

繼承

Object

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。
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) 會 contentrange 寫入檔案的 。 如需相關資訊，請參閱 放置範圍。
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) 會 contentrange 寫入檔案的 。 如需相關資訊，請參閱 放置範圍。
UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	此 UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) 作業會將範圍從 Azure 檔案寫入另一個 Azure 檔案。 此 API 僅支援 2019-02-02 版和更新版本。
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 檔案。 此 API 僅支援 2019-02-02 版和更新版本。
WithSnapshot(String)	使用相同 Uri 來源但指定的 shareSnapshot 時間戳記， ShareFileClient 初始化 類別的新實例。 如需相關資訊，請參閱 快照集共用。

擴充方法

GetShareLeaseClient(ShareFileClient, String)	初始化 ShareLeaseClient 類別的新執行個體。
GetParentShareClient(ShareFileClient)	建立指向此 ShareFileClient 父容器的新 ShareClient 。 新的 ShareClient 會使用與 相同的要求原則管線 ShareFileClient 。
GetParentShareDirectoryClient(ShareFileClient)	建立指向此 ShareFileClient 父容器的新 ShareDirectoryClient 。 新的 ShareDirectoryClient 會使用與 相同的要求原則管線 ShareFileClient 。