Share via


ShareServiceClient 類別

定義

ShareServiceClient可讓您操作 Azure 儲存體服務資源和共用。 儲存體帳戶會提供檔案服務的最上層命名空間。

public class ShareServiceClient
type ShareServiceClient = class
Public Class ShareServiceClient
繼承
ShareServiceClient

建構函式

ShareServiceClient()

初始化 類別的新實例 ShareServiceClient 以進行模擬。

ShareServiceClient(String)

初始化 ShareServiceClient 類別的新執行個體。

ShareServiceClient(String, ShareClientOptions)

初始化 ShareServiceClient 類別的新執行個體。

ShareServiceClient(Uri, AzureSasCredential, ShareClientOptions)

初始化 ShareServiceClient 類別的新執行個體。

ShareServiceClient(Uri, ShareClientOptions)

初始化 ShareServiceClient 類別的新執行個體。

ShareServiceClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

初始化 ShareServiceClient 類別的新執行個體。

ShareServiceClient(Uri, TokenCredential, ShareClientOptions)

初始化 ShareServiceClient 類別的新執行個體。

請注意,服務層級作業不支援權杖認證驗證。 此建構函式存在,允許建構 ShareServiceClient 可用來衍生 ShareClient 具有權杖認證驗證的 。

另請注意, ShareTokenIntent 權杖驗證目前是必要的。

屬性

AccountName

取得對應至檔案服務用戶端的儲存體帳戶名稱。

CanGenerateAccountSasUri

判斷用戶端是否能夠產生 SAS。 如果用戶端是使用 StorageSharedKeyCredential 進行驗證的。

Uri

取得檔案服務的主要 Uri 端點。

方法

CreateShare(String, ShareCreateOptions, CancellationToken)

CreateShare(String, ShareCreateOptions, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在,作業就會失敗。

如需相關資訊,請參閱 建立共用

CreateShareAsync(String, ShareCreateOptions, CancellationToken)

CreateShare(String, ShareCreateOptions, CancellationToken)作業可在指定帳戶下建立新共用。 如果具有相同名稱的共用已經存在,作業就會失敗。

如需相關資訊,請參閱 建立共用

DeleteShare(String, ShareDeleteOptions, CancellationToken)

標示要刪除的指定共用或共用快照集。 共用或共用快照集及其內含的任何檔案稍後會在垃圾收集期間刪除,這可能需要幾分鐘的時間。

目前,此方法一律會刪除快照集。 無法為 x-ms-delete-snapshots 指定個別的值。

如需相關資訊,請參閱 刪除共用

DeleteShareAsync(String, ShareDeleteOptions, CancellationToken)

標示要刪除的指定共用或共用快照集。 共用或共用快照集及其內含的任何檔案稍後會在垃圾收集期間刪除,這可能需要幾分鐘的時間。

目前,此方法一律會刪除快照集。 無法為 x-ms-delete-snapshots 指定個別的值。

如需相關資訊,請參閱 刪除共用

GenerateAccountSasUri(AccountSasBuilder)

GenerateAccountSasUri(AccountSasBuilder) 傳回 , Uri 其會根據傳遞的用戶端屬性和產生器,產生共用帳戶共用存取簽章 (SAS) 。 SAS 是由用戶端的共用金鑰認證所簽署。

若要檢查用戶端是否能夠簽署服務 Sas,請參閱 CanGenerateAccountSasUri

如需相關資訊,請參閱 建構帳戶 SAS

GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes)

GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes) 根據傳遞的用戶端屬性和參數,傳回 Uri 產生共用帳戶共用存取簽章 (SAS) 。 SAS 是由用戶端的共用金鑰認證所簽署。

若要檢查用戶端是否能夠簽署服務 Sas,請參閱 CanGenerateAccountSasUri

如需相關資訊,請參閱 建構帳戶 SAS

GetProperties(CancellationToken)

作業 GetProperties(CancellationToken) 會取得儲存體帳戶檔案服務的屬性,包括儲存體分析和 CORS (跨原始資源分享) 規則的屬性。

如需相關資訊,請參閱 取得檔案服務屬性

GetPropertiesAsync(CancellationToken)

作業 GetPropertiesAsync(CancellationToken) 會取得儲存體帳戶檔案服務的屬性,包括儲存體分析和 CORS (跨原始資源分享) 規則的屬性。

如需相關資訊,請參閱 取得檔案服務屬性

GetShareClient(String)

將 附加 shareName 至 結尾 Uri ,以建立新的 ShareClient 物件。 新的 ShareClient 會使用與 相同的要求原則管線 ShareServiceClient

GetShares(ShareTraits, ShareStates, String, CancellationToken)

GetShares(ShareTraits, ShareStates, String, CancellationToken) 作業會傳回儲存體帳戶中共用的非同步序列。 列舉共用可能會在擷取所有值時對服務提出多個要求。

如需相關資訊,請參閱 列出共用

GetSharesAsync(ShareTraits, ShareStates, String, CancellationToken)

作業會 GetSharesAsync(ShareTraits, ShareStates, String, CancellationToken) 傳回儲存體帳戶中共用的非同步集合。 列舉共用可能會在擷取所有值時對服務提出多個要求。

如需相關資訊,請參閱 列出共用

SetProperties(ShareServiceProperties, CancellationToken)

SetProperties(ShareServiceProperties, CancellationToken) 作業會設定儲存體帳戶檔案服務端點的屬性,包括儲存體分析的屬性、CORS (跨原始來源資源分享) 規則和虛刪除設定。 您也可以使用此作業,將所有傳入要求的預設要求版本設定為未指定版本的 File 服務。

如需相關資訊,請參閱 設定檔案服務屬性

SetPropertiesAsync(ShareServiceProperties, CancellationToken)

SetPropertiesAsync(ShareServiceProperties, CancellationToken) 作業會設定儲存體帳戶檔案服務端點的屬性,包括儲存體分析的屬性、CORS (跨原始來源資源分享) 規則和虛刪除設定。 您也可以使用此作業,將所有傳入要求的預設要求版本設定為未指定版本的 File 服務。

如需相關資訊,請參閱 設定檔案服務屬性

UndeleteShare(String, String, CancellationToken)

還原先前刪除的共用。 此 API 只有在共用虛刪除已啟用與共享相關聯之儲存體帳戶的功能。

UndeleteShareAsync(String, String, CancellationToken)

還原先前刪除的共用。 此 API 只有在共用虛刪除已啟用與共享相關聯之儲存體帳戶的功能。

適用於