ShareFileClient クラス

定義

ShareFileClientでは、Azure Storage ファイルを操作できます。

public class ShareFileClient
type ShareFileClient = class
Public Class ShareFileClient
継承
ShareFileClient

コンストラクター

ShareFileClient()

モック作成のために クラスの ShareFileClient 新しいインスタンスを初期化します。

ShareFileClient(String, String, String)

ShareFileClient クラスの新しいインスタンスを初期化します。

ShareFileClient(String, String, String, ShareClientOptions)

ShareFileClient クラスの新しいインスタンスを初期化します。

ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)

ShareFileClient クラスの新しいインスタンスを初期化します。

ShareFileClient(Uri, ShareClientOptions)

ShareFileClient クラスの新しいインスタンスを初期化します。

ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

ShareFileClient クラスの新しいインスタンスを初期化します。

ShareFileClient(Uri, TokenCredential, ShareClientOptions)

ShareFileClient クラスの新しいインスタンスを初期化します。

は現在、トークン認証に必要であることに ShareTokenIntent 注意してください。

プロパティ

AccountName

ファイル クライアントに対応するストレージ アカウント名を取得します。

CanGenerateSasUri

クライアントが SAS を生成できるかどうかを判断します。 クライアントが で認証されている場合。StorageSharedKeyCredential

Name

ファイルの名前を取得します。

Path

ファイルのパスを取得します。

ShareName

ファイル クライアントに対応する共有名を取得します。

Uri

ディレクトリのプライマリ Uri エンドポイントを取得します。

メソッド

AbortCopy(String, ShareFileRequestConditions, CancellationToken)

以前に開始された保留中のコピーを取り消そうとし、長さが 0 のコピー先ファイルと完全なメタデータを残します。

詳細については、「 ファイルのコピーを中止します

AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)

以前に開始された保留中のコピーを取り消そうとし、長さが 0 のコピー先ファイルと完全なメタデータを残します。

詳細については、「 ファイルのコピーを中止します

ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)

この操作により ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) 、ファイルの が range クリアされます。

詳細については、「 範囲を配置します

ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)

この操作により ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) 、ファイルの が range クリアされます。

詳細については、「 範囲を配置します

Create(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

新しいファイルを作成するか、既存のファイルを置き換えます。

詳細については、「 ファイルを作成します

CreateAsync(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

新しいファイルを作成するか、既存のファイルを置き換えます。

詳細については、「 ファイルを作成します

Delete(ShareFileRequestConditions, CancellationToken)

Delete(ShareFileRequestConditions, CancellationToken) 操作は、ファイルをストレージ アカウントからすぐに削除します。

詳細については、「 ファイルの削除

DeleteAsync(ShareFileRequestConditions, CancellationToken)

DeleteAsync(ShareFileRequestConditions, CancellationToken) 操作は、ファイルをストレージ アカウントからすぐに削除します。

詳細については、「 ファイルの削除

DeleteIfExists(ShareFileRequestConditions, CancellationToken)

この操作により DeleteIfExists(ShareFileRequestConditions, CancellationToken) 、ストレージ アカウントが存在する場合は、すぐにストレージ アカウントからファイルが削除されます。

詳細については、「 ファイルの削除

DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)

この操作により DeleteIfExists(ShareFileRequestConditions, CancellationToken) 、ストレージ アカウントが存在する場合は、すぐにストレージ アカウントからファイルが削除されます。

詳細については、「 ファイルの削除

Download(ShareFileDownloadOptions, CancellationToken)

Download(ShareFileDownloadOptions, CancellationToken) 操作は、メタデータやプロパティなどのファイルをシステムから読み取りまたはダウンロードします。

詳細については、「 ファイルを取得します

DownloadAsync(ShareFileDownloadOptions, CancellationToken)

DownloadAsync(ShareFileDownloadOptions, CancellationToken) 操作は、メタデータやプロパティなどのファイルをシステムから読み取りまたはダウンロードします。

詳細については、「 ファイルを取得します

Exists(CancellationToken)

操作を Exists(CancellationToken)ShareFileClient 呼び出して、関連付けられているファイルがストレージ アカウントの共有に存在するかどうかを確認できます。

ExistsAsync(CancellationToken)

操作を Exists(CancellationToken)ShareFileClient 呼び出して、関連付けられているファイルがストレージ アカウントの共有に存在するかどうかを確認できます。

ForceCloseAllHandles(CancellationToken)

この操作は ForceCloseAllHandles(CancellationToken) 、サービスでファイルで開かれているすべてのハンドルを閉じます。

この API は、操作をブロックするハンドルを強制的に閉じるために、一緒 GetHandlesAsync(CancellationToken) に使用することを目的としています。 これらのハンドルが、SMB クライアントによってリークまたは追跡されなくなった可能性があります。 API は、ファイルの読み取りまたは書き込みが失敗したためにユーザーに表示されるエラーを含め、閉じているハンドルにクライアント側の影響を与えます。 この API は、SMB Close の代替または代替として使用するためのものではありません。

詳細については、「 ハンドルを強制的に閉じます

ForceCloseAllHandlesAsync(CancellationToken)

この操作は ForceCloseAllHandlesAsync(CancellationToken) 、サービスでファイルで開かれているすべてのハンドルを閉じます。

この API は、操作をブロックするハンドルを強制的に閉じるために、一緒 GetHandlesAsync(CancellationToken) に使用することを目的としています。 これらのハンドルが、SMB クライアントによってリークまたは追跡されなくなった可能性があります。 API は、ファイルの読み取りまたは書き込みが失敗したためにユーザーに表示されるエラーを含め、閉じているハンドルにクライアント側の影響を与えます。 この API は、SMB Close の代替または代替として使用するためのものではありません。

詳細については、「 ハンドルを強制的に閉じます

ForceCloseHandle(String, CancellationToken)

操作は ForceCloseHandle(String, CancellationToken) 、サービスでファイルで開かれたハンドルを閉じます。 では、 で指定された 1 つのハンドルを閉じることが handleIdサポートされています。

この API は、操作をブロックするハンドルを強制的に閉じるために、一緒 GetHandlesAsync(CancellationToken) に使用することを目的としています。 これらのハンドルが、SMB クライアントによってリークまたは追跡されなくなった可能性があります。 API は、ファイルの読み取りまたは書き込みが失敗したためにユーザーに表示されるエラーを含め、閉じているハンドルにクライアント側の影響を与えます。 この API は、SMB Close の代替または代替として使用するためのものではありません。

詳細については、「 ハンドルを強制的に閉じます

ForceCloseHandleAsync(String, CancellationToken)

操作は ForceCloseHandleAsync(String, CancellationToken) 、サービスでファイルで開かれたハンドルを閉じます。 では、 で指定された 1 つのハンドルを閉じることが handleIdサポートされています。

この API は、操作をブロックするハンドルを強制的に閉じるために、一緒 GetHandlesAsync(CancellationToken) に使用することを目的としています。 これらのハンドルが、SMB クライアントによってリークまたは追跡されなくなった可能性があります。 API は、ファイルの読み取りまたは書き込みが失敗したためにユーザーに表示されるエラーを含め、閉じているハンドルにクライアント側の影響を与えます。 この API は、SMB Close の代替または代替として使用するためのものではありません。

詳細については、「 ハンドルを強制的に閉じます

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)Uri 渡されたクライアントのプロパティとパラメーターに基づいて Share File Service Shared Access Signature (SAS) URI を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。

クライアントが Service Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateSasUri

詳細については、「 サービス SAS の構築

GenerateSasUri(ShareSasBuilder)

GenerateSasUri(ShareSasBuilder) 、クライアントの Uri プロパティとビルダーに基づいて Share File Service Shared Access Signature (SAS) URI を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。

クライアントが Service Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateSasUri

詳細については、「 サービス SAS の構築

GetCopyAuthorizationHeaderAsync(ShareFileClient, CancellationToken)

ソースをShareFileClientHttpAuthorization認証するために OAuth が必要なサービスコピーにサービスを実行するときに承認を渡すための を取得します。

GetHandles(CancellationToken)

この操作は GetHandles(CancellationToken) 、ディレクトリまたはファイル上の開いているハンドルの非同期シーケンスを返します。 ハンドルを列挙すると、すべての値をフェッチするときに、サービスに対して複数の要求が行われる場合があります。

詳細については、「 リスト ハンドル

GetHandlesAsync(CancellationToken)

この操作は GetHandlesAsync(CancellationToken) 、ディレクトリまたはファイル上の開いているハンドルの非同期シーケンスを返します。 ハンドルを列挙すると、すべての値をフェッチするときに、サービスに対して複数の要求が行われる場合があります。

詳細については、「 リスト ハンドル

GetParentShareClientCore()

この ShareFileClientの親コンテナーを指す新しい ShareClient を作成します。 新しい ShareClient では、 と同じ要求ポリシー パイプラインが使用されます ShareFileClient

GetParentShareDirectoryClientCore()

この ShareFileClientの親コンテナーを指す新しい ShareDirectoryClient を作成します。 新しい ShareDirectoryClient では、 と同じ要求ポリシー パイプラインが使用されます ShareFileClient

GetProperties(ShareFileRequestConditions, CancellationToken)

GetProperties(ShareFileRequestConditions, CancellationToken) 操作は、すべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびファイルのシステム プロパティを返します。 ファイルのコンテンツは返しません。

詳細については、「 ファイルのプロパティを取得します

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) 操作は、すべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびファイルのシステム プロパティを返します。 ファイルのコンテンツは返しません。

詳細については、「 ファイルのプロパティを取得します

GetRangeList(ShareFileGetRangeListOptions, CancellationToken)

ファイルの有効な範囲の一覧を返します。

詳細については、「 範囲を一覧表示します

GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)

ファイルの有効な範囲の一覧を返します。

詳細については、「 範囲を一覧表示します

GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)

previousSnapshot が取得されてからファイル内で変更された範囲の一覧を返します。

詳細については、「 範囲を一覧表示します

GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)

previousSnapshot が取得されてからファイル内で変更された範囲の一覧を返します。

詳細については、「 範囲を一覧表示します

OpenRead(ShareFileOpenReadOptions, CancellationToken)

ファイルから読み取るためのストリームを開きます。 ストリームは、ストリームの読み取り元としてのみファイルをダウンロードします。

OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)

ファイルから読み取るためのストリームを開きます。 ストリームは、ストリームの読み取り元としてのみファイルをダウンロードします。

OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

ファイルに書き込むためのストリームを開きます。

OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

ファイルに書き込むためのストリームを開きます。

Rename(String, ShareFileRenameOptions, CancellationToken)

ファイル名を変更します。 この API では、ファイルの名前を共有間またはストレージ アカウント間で変更することはできません。

RenameAsync(String, ShareFileRenameOptions, CancellationToken)

ファイル名を変更します。 この API では、ファイルの名前を共有間またはストレージ アカウント間で変更することはできません。

SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) 操作はファイルのシステム プロパティを設定します。

詳細については、「 [ファイルのプロパティ] を設定します

SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) 操作はファイルのシステム プロパティを設定します。

詳細については、「 [ファイルのプロパティ] を設定します

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 つ以上の名前と値のペアとして設定されます。

詳細については、「 ファイル メタデータを設定します

StartCopy(Uri, ShareFileCopyOptions, CancellationToken)

BLOB またはファイルをストレージ アカウント内のコピー先ファイルにコピーします。

詳細については、「 ファイルのコピー

StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)

BLOB またはファイルをストレージ アカウント内のコピー先ファイルにコピーします。

詳細については、「 ファイルのコピー

Upload(Stream, ShareFileUploadOptions, CancellationToken)

操作は Upload(Stream, ShareFileUploadOptions, CancellationToken) ファイルに書き込みます options.Stream.Stream

詳細については、「 範囲を配置します

UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)

操作は UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) ファイルに書き込みます options.Stream.Stream

詳細については、「 範囲を配置します

UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

操作は Azure.Storage.Files.Shares.ShareFileClient.UploadRange(Azure.HttpRange,System.IO.Stream,System.Byte[],System.IProgress{System.Int64},Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) 、ファイルの contentrange 書き込みます。

詳細については、「 範囲を配置します

UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

操作は Azure.Storage.Files.Shares.ShareFileClient.UploadRangeAsync(Azure.HttpRange,System.IO.Stream,System.Byte[],System.IProgress{System.Int64},Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) 、ファイルの contentrange 書き込みます。

詳細については、「 範囲を配置します

UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)

この操作により UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) 、Azure ファイルから別の Azure ファイルに範囲が書き込まれます。 この API は、バージョン 2019-02-02 以降でのみサポートされています。

UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)

この操作により Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) 、Azure ファイルから別の Azure ファイルに範囲が書き込まれます。 この API は、バージョン 2019-02-02 以降でのみサポートされています。

WithSnapshot(String)

同じUriソースと指定されたshareSnapshotタイムスタンプを使用してShareFileClient、 クラスの新しいインスタンスを初期化します。

詳細については、「 スナップショット共有

拡張メソッド

GetShareLeaseClient(ShareFileClient, String)

ShareLeaseClient クラスの新しいインスタンスを初期化します。

GetParentShareClient(ShareFileClient)

この ShareFileClientの親コンテナーを指す新しい ShareClient を作成します。 新しい ShareClient では、 と同じ要求ポリシー パイプラインが使用されます ShareFileClient

GetParentShareDirectoryClient(ShareFileClient)

この ShareFileClientの親コンテナーを指す新しい ShareDirectoryClient を作成します。 新しい ShareDirectoryClient では、 と同じ要求ポリシー パイプラインが使用されます ShareFileClient

適用対象