ShareClient 類別

定義

命名空間:

Azure.Storage.Files.Shares

組件:

Azure.Storage.Files.Shares.dll

套件:

Azure.Storage.Files.Shares v12.17.1

來源:

ShareClient.cs

ShareClient可讓您操作 Azure 儲存體共用及其目錄和檔案。

public class ShareClient

type ShareClient = class

Public Class ShareClient

繼承

Object

ShareClient

建構函式

ShareClient()	初始化 類別的新實例 ShareClient 以進行模擬。
ShareClient(String, String)	初始化 ShareClient 類別的新執行個體。
ShareClient(String, String, ShareClientOptions)	初始化 ShareClient 類別的新執行個體。
ShareClient(Uri, AzureSasCredential, ShareClientOptions)	初始化 ShareClient 類別的新執行個體。 請注意，權杖認證驗證只與 GetPermission(String, CancellationToken) 、 GetPermissionAsync(String, CancellationToken) 、 CreatePermission(String, CancellationToken) 和 CreatePermissionAsync(String, CancellationToken) 共用層級作業相容。
ShareClient(Uri, ShareClientOptions)	初始化 ShareClient 類別的新執行個體。
ShareClient(Uri, StorageSharedKeyCredential, ShareClientOptions)	初始化 ShareClient 類別的新執行個體。
ShareClient(Uri, TokenCredential, ShareClientOptions)	初始化 ShareClient 類別的新執行個體。 請注意，唯一支援權杖認證驗證的共用層級作業為 CreatePermission(String, CancellationToken) 、 CreatePermissionAsync(String, CancellationToken)GetPermission(String, CancellationToken) 和 GetPermissionAsync(String, CancellationToken) 。 這個建構函式也允許建構 ShareServiceClient 可用來衍生 ShareClient 具有權杖認證驗證的 。 另請注意， ShareTokenIntent 權杖驗證目前是必要的。

屬性

AccountName	取得對應至共用用戶端的儲存體帳戶名稱。
CanGenerateSasUri	判斷用戶端是否能夠產生 SAS。 如果用戶端是使用 StorageSharedKeyCredential 進行驗證的。
Name	取得共用的名稱。
Uri	取得共用的主要 Uri 端點。

方法

Create(ShareCreateOptions, CancellationToken)	Create(ShareCreateOptions, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在，作業就會失敗。 如需相關資訊，請參閱 建立共用。
CreateAsync(ShareCreateOptions, CancellationToken)	CreateAsync(ShareCreateOptions, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在，作業就會失敗。 如需相關資訊，請參閱 建立共用。
CreateDirectory(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken)	此作業會在 CreateDirectory(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 此共用中建立新的目錄。 如需相關資訊，請參閱 建立目錄。
CreateDirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken)	此作業會在 CreateDirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) 此共用中建立新的目錄。 如需相關資訊，請參閱 建立目錄。
CreateIfNotExists(ShareCreateOptions, CancellationToken)	CreateIfNotExists(ShareCreateOptions, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在，則不會變更。 如需相關資訊，請參閱 建立共用。
CreateIfNotExistsAsync(IDictionary<String,String>, Nullable<Int32>, CancellationToken)	CreateIfNotExistsAsync(IDictionary<String,String>, Nullable<Int32>, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在，則不會變更。 如需相關資訊，請參閱 建立共用。
CreateIfNotExistsAsync(ShareCreateOptions, CancellationToken)	CreateIfNotExistsAsync(IDictionary<String,String>, Nullable<Int32>, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在，則不會變更。 如需相關資訊，請參閱 建立共用。
CreatePermission(String, CancellationToken)	在共用層級建立安全性描述項 (許可權) 。 建立的安全性描述元可用於共用中的檔案/目錄。
CreatePermissionAsync(String, CancellationToken)	在共用層級建立安全性描述項 (許可權) 。 建立的安全性描述元可用於共用中的檔案/目錄。
CreateSnapshot(IDictionary<String,String>, CancellationToken)	建立共用的唯讀快照集。 如需相關資訊，請參閱 快照集共用。
CreateSnapshotAsync(IDictionary<String,String>, CancellationToken)	建立共用的唯讀快照集。 如需相關資訊，請參閱 快照集共用。
Delete(ShareDeleteOptions, CancellationToken)	標記要刪除的指定共用或共用快照集。 共用或共用快照集及其內含的任何檔案稍後會在垃圾收集期間刪除，這可能需要幾分鐘的時間。 如需相關資訊，請參閱 刪除共用。
DeleteAsync(ShareDeleteOptions, CancellationToken)	標記要刪除的指定共用或共用快照集。 共用或共用快照集及其內含的任何檔案稍後會在垃圾收集期間刪除，這可能需要幾分鐘的時間。 如需相關資訊，請參閱 刪除共用。
DeleteDirectory(String, CancellationToken)	DeleteDirectory(String, CancellationToken)作業會移除指定的空白目錄。 如需相關資訊，請參閱 刪除目錄。
DeleteDirectoryAsync(String, CancellationToken)	DeleteDirectoryAsync(String, CancellationToken)作業會移除指定的空白目錄。 如需相關資訊，請參閱 刪除目錄。
DeleteIfExists(ShareDeleteOptions, CancellationToken)	如果指定共用或共用快照集存在，則會將其標示為刪除。 如需相關資訊，請參閱 刪除共用。
DeleteIfExistsAsync(ShareDeleteOptions, CancellationToken)	如果指定共用或共用快照集存在，則會將其標示為刪除。 如需相關資訊，請參閱 刪除共用。
Exists(CancellationToken)	作業 Exists(CancellationToken) 可以在 上 ShareClient 呼叫，以查看相關聯的共用是否存在於儲存體服務中的儲存體帳戶上。
ExistsAsync(CancellationToken)	作業 ExistsAsync(CancellationToken) 可以在 上 ShareClient 呼叫，以查看相關聯的共用是否存在於儲存體服務中的儲存體帳戶上。
GenerateSasUri(ShareSasBuilder)	會 GenerateSasUri(ShareSasBuilder) 傳回 ， Uri 根據用戶端屬性和傳遞的產生器，產生 Blob Container Service 共用存取簽章 (SAS) URI。 SAS 是由用戶端的共用金鑰認證所簽署。 若要檢查用戶端是否能夠簽署服務 Sas，請參閱 CanGenerateSasUri 。 如需相關資訊，請參閱 建構服務 SAS。
GenerateSasUri(ShareSasPermissions, DateTimeOffset)	會 GenerateSasUri(ShareSasPermissions, DateTimeOffset) 根據傳遞的用戶端屬性和參數，傳回 Uri 產生共用服務共用存取簽章 (SAS) URI 的 。 SAS 是由用戶端的共用金鑰認證所簽署。 若要檢查用戶端是否能夠簽署服務 Sas，請參閱 CanGenerateSasUri 。 如需相關資訊，請參閱 建構服務 SAS。
GetAccessPolicy(ShareFileRequestConditions, CancellationToken)	作業 GetAccessPolicy(ShareFileRequestConditions, CancellationToken) 會取得此共用的許可權。 許可權會指出是否可以公開存取共用資料。 如需相關資訊，請參閱 取得共用 ACL。
GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken)	作業 GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken) 會取得此共用的許可權。 許可權會指出是否可以公開存取共用資料。 如需相關資訊，請參閱 取得共用 ACL。
GetDirectoryClient(String)	將 附加 directoryName 至 結尾 Uri ，以建立新的 ShareDirectoryClient 物件。 新的 ShareDirectoryClient 會使用與 相同的要求原則管線 ShareClient 。
GetParentServiceClientCore()	建立指向這個 ShareClient 父容器的新 ShareServiceClient 。 新的 ShareServiceClient 會使用與 相同的要求原則管線 ShareClient 。
GetPermission(String, CancellationToken)	取得安全性描述元定義語言中的檔案許可權， (SDDL) 。
GetPermissionAsync(String, CancellationToken)	取得安全性描述元定義語言中的檔案許可權， (SDDL) 。
GetProperties(ShareFileRequestConditions, CancellationToken)	此 GetProperties(ShareFileRequestConditions, CancellationToken) 作業會傳回共用的所有使用者定義中繼資料、標準 HTTP 屬性和系統屬性。 如需相關資訊，請參閱 取得共用屬性。
GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)	此 GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) 作業會傳回共用的所有使用者定義中繼資料、標準 HTTP 屬性和系統屬性。 如需相關資訊，請參閱 取得共用屬性。
GetRootDirectoryClient()	為共用的根目錄建立 ShareDirectoryClient 物件。 新的 ShareDirectoryClient 會使用與 相同的要求原則管線 ShareClient 。
GetStatistics(ShareFileRequestConditions, CancellationToken)	擷取與共享相關的統計資料。 如需相關資訊，請參閱 取得共用統計資料。
GetStatisticsAsync(ShareFileRequestConditions, CancellationToken)	擷取與共享相關的統計資料。 如需相關資訊，請參閱 取得共用統計資料。
SetAccessPolicy(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken)	作業 SetAccessPolicy(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken) 會設定指定共用的許可權。 許可權會指出是否可以公開存取共用資料。 如需相關資訊，請參閱 設定共用 ACL。
SetAccessPolicyAsync(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken)	作業 SetAccessPolicyAsync(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken) 會設定指定共用的許可權。 許可權會指出是否可以公開存取共用資料。 如需相關資訊，請參閱 設定共用 ACL。
SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	作業會將 SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) 指定共用的使用者定義中繼資料設定為一或多個名稱/值組。 如需相關資訊，請參閱 設定共用中繼資料。
SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	作業會將 SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) 指定共用的使用者定義中繼資料設定為一或多個名稱/值組。 如需相關資訊，請參閱 設定共用中繼資料。
SetProperties(ShareSetPropertiesOptions, CancellationToken)	設定共用的屬性。 如需相關資訊，請參閱 設定共用屬性。
SetPropertiesAsync(ShareSetPropertiesOptions, CancellationToken)	設定共用的屬性。 如需相關資訊，請參閱 設定共用屬性。
WithSnapshot(String)	使用相同 Uri 來源但指定的 snapshot 時間戳記， ShareClient 初始化 類別的新實例。 如需相關資訊，請參閱 快照集共用。

擴充方法

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