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

ShareClient 类

定义

命名空间:

Azure.Storage.Files.Shares

程序集:

Azure.Storage.Files.Shares.dll

包:

Azure.Storage.Files.Shares v12.17.1

Source:

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 容器服务共享访问签名 (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。