ShareClient クラス

定義

名前空間:

Azure.Storage.Files.Shares

アセンブリ:

Azure.Storage.Files.Shares.dll

パッケージ:

Azure.Storage.Files.Shares v12.17.1

ソース:

ShareClient.cs

ShareClientでは、Azure Storage 共有とそのディレクトリとファイルを操作できます。

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 クラスの新しいインスタンスを初期化します。 トークン資格情報認証は、、GetPermissionAsync(String, CancellationToken)CreatePermission(String, CancellationToken)およびCreatePermissionAsync(String, CancellationToken)共有レベルのGetPermission(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)のみです。 このコンストラクターを使用すると、トークン資格情報認証を持つ を派生させるために使用できる のShareClient構築ShareServiceClientも可能になります。 は現在、トークン認証に必要であることにも注意してください 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 コンテナー サービス Shared Access Signature (SAS) URI を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。 クライアントが Service Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateSasUri。 詳細については、「 サービス SAS の構築。
GenerateSasUri(ShareSasPermissions, DateTimeOffset)	は GenerateSasUri(ShareSasPermissions, DateTimeOffset) 、 Uri 渡されたクライアントのプロパティとパラメーターに基づいて Share Service Shared Access Signature (SAS) URI を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。 クライアントが Service Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateSasUri。 詳細については、「 サービス SAS の構築。
GetAccessPolicy(ShareFileRequestConditions, CancellationToken)	操作は GetAccessPolicy(ShareFileRequestConditions, CancellationToken) 、この共有のアクセス許可を取得します。 アクセス許可は、共有データにパブリックにアクセスできるかどうかを示します。 詳細については、「 共有 ACL を取得します。
GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken)	操作は GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken) 、この共有のアクセス許可を取得します。 アクセス許可は、共有データにパブリックにアクセスできるかどうかを示します。 詳細については、「 共有 ACL を取得します。
GetDirectoryClient(String)	の末尾Uriに をdirectoryName追加して、新しい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) 、指定した共有のユーザー定義メタデータが 1 つ以上の名前と値のペアとして設定されます。 詳細については、「 [メタデータの共有] を設定します。
SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	操作により SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) 、指定した共有のユーザー定義メタデータが 1 つ以上の名前と値のペアとして設定されます。 詳細については、「 [メタデータの共有] を設定します。
SetProperties(ShareSetPropertiesOptions, CancellationToken)	共有のプロパティを設定します。 詳細については、「 [共有プロパティ] を設定します。
SetPropertiesAsync(ShareSetPropertiesOptions, CancellationToken)	共有のプロパティを設定します。 詳細については、「 [共有プロパティ] を設定します。
WithSnapshot(String)	同じUriソースと指定されたsnapshotタイムスタンプを使用してShareClient、 クラスの新しいインスタンスを初期化します。 詳細については、「 スナップショット共有。

拡張メソッド

GetShareLeaseClient(ShareClient, String)	ShareLeaseClient クラスの新しいインスタンスを初期化します。
GetParentServiceClient(ShareClient)	この ShareClientの親コンテナーを指す新しい ShareServiceClient を作成します。 新しい ShareServiceClient では、 と同じ要求ポリシー パイプラインが使用されます ShareClient。