Share via


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。 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

適用於