AdlsClient クラス

定義

名前空間:

Microsoft.Azure.DataLake.Store

アセンブリ:

Microsoft.Azure.DataLake.Store.dll

パッケージ:

Microsoft.Azure.DataLake.Store v1.1.24

Azure Data Lake Store のクライアント。 これには、呼び出しが簡単で、コア API よりも使いやすい REST API の操作を実行するためのパブリック API が含まれています。 コア API は自由度を高めますが、ADLSClient は、より一般的に使用されるフォームを提供します。 認証トークンとトークン更新をカプセル化します。 ServiceClientCredential または文字列認証トークンを受け取り、このクラスのインスタンスを返すファクトリ メソッドが含まれています。 すべての操作に対して、非同期と同期のバージョンが提供されます。 すべての同期メソッドは、Create と Concurrent append を除き、非同期メソッドでの待機です。 すべての API はスレッド セーフであり、CreateFile と GetAppendStream の一部の例外があります。 CreateFile と GetAppendStream は、異なるスレッドから同じパスに対して呼び出すことはできません。これは、リースの競合が発生するため、リースの競合が発生するためです。アプリケーションがこの SDK を使用してマルチスレッド操作を実行する場合は、AdlsClient のインスタンスを作成する前に、アプリケーションが SDK で使用するスレッドの数に ServicePointManager.DefaultConnectionLimit を設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。 Adls はログ記録に NLog を使用します。 adls.dotnet.* は、すべてのログを取得するロガーの名前です。

public class AdlsClient

type AdlsClient = class

Public Class AdlsClient

継承

Object

AdlsClient

派生

Microsoft.Azure.DataLake.Store.MockAdlsFileSystem.MockAdlsClient

コンストラクター

AdlsClient()

moq テスト用の保護されたコンストラクター

フィールド

ClientLogger

クライアントに関する情報 (デバッグ/エラー/トレース) をログに記録するロガー

プロパティ

AccountFQDN	完全なドメイン名を含む Azure Data Lake Store アカウント名
ClientId	クライアント オブジェクト ID
DefaultNumThreads	アップローダー/ダウンローダー、再帰的 ACL 変更、SDK を使用するその他のマルチスレッド ツールなどのツールで使用される既定のスレッド数。 SDK でマルチスレッド ツールに使用するスレッドの数を決定する場合は、ServicePointManager.DefaultConnectionLimit を設定するために使用できます。

メソッド

AddUserAgentSuffix(String)	ユーザー エージェント サフィックスを追加します
BulkDownload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	リモート サーバーからローカルにディレクトリまたはファイルをダウンロードします。 転送先ディレクトリのソース ディレクトリの下にコンテンツを転送します。 ソース ファイルを転送し、宛先パスとして保存します。 このメソッドは、エントリの転送エラーに対して例外をスローしません。 戻り値 TransferStatus を参照して、各エントリの転送の状態/例外を取得します。 既定では、転送の進行状況がシステムの一時パスに記録されるため、アップロードがクラッシュした場合に ユーザーが を使用して resume 復旧できます。 この進行状況ログは、 を使用して disableTransferLogging無効にすることができます。 AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を sdk で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
BulkDownload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	リモート サーバーからローカルにディレクトリまたはファイルをダウンロードします。 転送先ディレクトリのソース ディレクトリの下にコンテンツを転送します。 ソース ファイルを転送し、宛先パスとして保存します。 このメソッドは、エントリの転送エラーに対して例外をスローしません。 戻り値 TransferStatus を参照して、各エントリの転送の状態/例外を取得します。 AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を sdk で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
BulkUpload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	ローカルからリモートにディレクトリまたはファイルをアップロードします。 転送先ディレクトリのソース ディレクトリの下にコンテンツを転送します。 ソース ファイルを転送し、宛先パスとして保存します。 このメソッドは、エントリの転送エラーに対して例外をスローしません。 戻り値 TransferStatus を参照して、各エントリの転送の状態/例外を取得します。 既定では、転送の進行状況がシステムの一時パスに記録されるため、アップロードがクラッシュした場合に ユーザーが を使用して resume 復旧できます。 この進行状況ログは、 を使用して disableTransferLogging無効にすることができます。 AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を sdk で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。 既定では、ファイルは新しい行境界でアップロードされます。 ただし、ファイルに 4 MB のチャンク内に改行がない場合、転送は失敗します。 その場合は、改行境界でのアップロードを回避するために true を isBinary 渡す必要があります。
BulkUpload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	ローカルからリモートにディレクトリまたはファイルをアップロードします。 転送先ディレクトリのソース ディレクトリの下にコンテンツを転送します。 ソース ファイルを転送し、宛先パスとして保存します。 このメソッドは、エントリの転送エラーに対して例外をスローしません。 戻り値 TransferStatus を参照して、各エントリの転送の状態/例外を取得します。 AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を sdk で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。 既定では、ファイルは新しい行境界でアップロードされます。 ただし、ファイルに 4 MB のチャンク内に改行がない場合、転送は失敗します。 その場合は、改行境界でのアップロードを回避するために true を isBinary 渡す必要があります。
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32)	ディレクトリ ツリーで Acl を再帰的に変更する (変更、設定、削除する) AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を sdk で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32, IProgress<AclProcessorStats>, CancellationToken)	ディレクトリ ツリーで Acl を再帰的に変更する (変更、設定、削除する) AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を sdk で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
CheckAccess(String, String, CancellationToken)	ユーザー/グループが指定されたパスのアクセス権を指定しているかどうかを確認します
CheckAccessAsync(String, String, CancellationToken)	ユーザー/グループが指定されたパスへのアクセスを指定したかどうかを非同期的に確認します
CheckExists(String)	ファイルまたはディレクトリが存在するかどうかを確認します
ConcatenateFiles(String, List<String>, Boolean, CancellationToken)	同期 API を使用してソース ファイルを変換先ファイルに連結する
ConcatenateFilesAsync(String, List<String>, Boolean, CancellationToken)	ソース ファイルを変換先ファイルに連結する非同期 API
ConcurrentAppend(String, Boolean, Byte[], Int32, Int32)	サーバーで同時追加を実行する同期 API。 追加が行われるオフセットは、サーバーによって決定されます。 4 MB 未満のデータ サイズでこの API を呼び出すように強くお勧めします。 バックエンドは 4 MB のアトミック付加を設定します。
ConcurrentAppendAsync(String, Boolean, Byte[], Int32, Int32, CancellationToken)	サーバーで同時追加を実行する非同期 API。 追加が行われるオフセットは、サーバーによって決定されます。 非同期操作。 4 MB 未満のデータ サイズでこの API を呼び出すように強くお勧めします。 バックエンドは 4 MB のアトミック付加を設定します。
CreateClient(String, ServiceClientCredentials)	ServiceClientCredential を使用して AdlsClient のインスタンスを作成するファクトリ メソッド。 アプリケーションでこの SDK を使用してマルチスレッド操作を実行する場合は、AdlsClient のインスタンスを作成する前に、アプリケーションが SDK で使用するスレッド数に ServicePointManager.DefaultConnectionLimit を設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
CreateClient(String, String)	トークン キーを使用してインスタンス AdlsClient を作成するファクトリ メソッド。 アプリケーションでこの SDK を使用してマルチスレッド操作を実行する場合は、AdlsClient のインスタンスを作成する前に、アプリケーションが SDK で使用するスレッド数に ServicePointManager.DefaultConnectionLimit を設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
CreateDirectory(String, String, CancellationToken)	ディレクトリを作成するための同期 API
CreateDirectoryAsync(String, String, CancellationToken)	ディレクトリを作成するための非同期 API。
CreateFile(String, IfExists, String, Boolean)	ファイルを作成し、ADLS でそのファイルにデータを書き込むストリームを返す同期 API。 ファイルは排他アクセスで開かれます。このストリームが開いている間、追加のために同じファイルを開こうとすると失敗します。 スレッド処理: 返されるストリームはスレッド セーフではありません。
CreateFileAsync(String, IfExists, String, Boolean, CancellationToken)	ファイルを作成し、ADLS でそのファイルにデータを書き込むストリームを返す非同期 API。 ファイルは排他アクセスで開かれます。このストリームが開いている間、追加のために同じファイルを開こうとすると失敗します。 スレッド処理: 返されるストリームはスレッド セーフではありません。
Delete(String, CancellationToken)	ファイルまたはディレクトリを削除するための同期 API。 ディレクトリの場合は、空の場合にのみ削除されます。
DeleteAsync(String, CancellationToken)	ファイルまたはディレクトリを削除する非同期 API。 ディレクトリの場合は、空の場合にのみ削除されます。
DeleteRecursive(String, CancellationToken)	ファイルまたはディレクトリを再帰的に削除する同期 API。 空でないディレクトリの場合は、サブディレクトリまたはファイルが削除されます。
DeleteRecursiveAsync(String, CancellationToken)	ファイルまたはディレクトリを再帰的に削除する非同期 API
EnumerateDeletedItems(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	ヒントと開始点を持つアカウントの下のゴミ箱を検索します。 これは実行時間の長い操作であり、ユーザーは定期的に進行状況で更新されます。 注意: ファイルの削除解除はベスト エフォート操作です。 削除後にファイルを復元できる保証はありません。 この API の使用は、ホワイトリスト登録によって有効になります。 ADL アカウントがホワイトリストに登録されていない場合、この API を使用すると Not immplemented 例外がスローされます。 詳細とサポートについては、Microsoft サポートにお問い合わせください。
EnumerateDeletedItemsAsync(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	ごみ箱エントリを非同期的に取得する 注意: ファイルの削除はベスト エフォート操作です。 削除後にファイルを復元できる保証はありません。 この API の使用は、ホワイトリスト登録によって有効になります。 ADL アカウントがホワイトリストに登録されていない場合、この API を使用すると Not immplemented 例外がスローされます。 詳細とサポートについては、Microsoft サポートにお問い合わせください。
EnumerateDirectory(String, UserGroupRepresentation, CancellationToken)	ディレクトリに含まれるサブディレクトリまたはファイルを列挙する列挙可能な を返します。 既定では、listAfter と listBefore は空であり、すべてのディレクトリ エントリを列挙します。
GetAclStatus(String, UserGroupRepresentation, CancellationToken)	ファイル/ディレクトリの ACL エントリ リスト、所有者 ID、グループ ID、8 進数のアクセス許可、スティッキー ビット (ディレクトリの場合のみ) を取得します
GetAclStatusAsync(String, UserGroupRepresentation, CancellationToken)	ファイル/ディレクトリの ACL エントリ リスト、所有者 ID、グループ ID、8 進数のアクセス許可、スティッキー ビット (ディレクトリの場合のみ) を非同期的に取得します
GetAppendStream(String, CancellationToken)	ADLS 内のファイルにデータを書き込むストリームを返す同期 API。 ファイルは排他アクセスで開かれます。このストリームが開いている間、追加のために同じファイルを開こうとすると失敗します。 スレッド処理: 返されるストリームはスレッド セーフではありません。
GetAppendStreamAsync(String, CancellationToken)	ADLS 内のファイルにデータを書き込むストリームを返す非同期 API。 ファイルは排他アクセスで開かれます。このストリームが開いている間、追加のために同じファイルを開こうとすると失敗します。 スレッド処理: 返されるストリームはスレッド セーフではありません。
GetContentSummary(String, Int32, CancellationToken)	ファイルまたはディレクトリのコンテンツの概要を取得します。 AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を SDK で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
GetDirectoryEntry(String, UserGroupRepresentation, CancellationToken)	完全パス、型 (ファイルまたはディレクトリ)、グループ、ユーザー、アクセス許可、長さ、最終アクセス時間、最終更新時刻、有効期限、acl ビット、レプリケーション係数などのメタデータを同期的に取得します
GetDirectoryEntryAsync(String, UserGroupRepresentation, CancellationToken)	完全パス、型 (ファイルまたはディレクトリ)、グループ、ユーザー、アクセス許可、長さ、最終アクセス時間、最終更新時刻、有効期限、acl ビット、レプリケーション係数などのメタデータを非同期的に取得します
GetExceptionFromResponse(OperationResponse, String)	サーバーからの応答に基づいて ADLS 例外を返します
GetFileProperties(String, Boolean, String, Boolean, Boolean, Int32, Boolean, Boolean, Int64, CancellationToken)	指定されたパスの下にある alldirectories または /および ファイルのファイル プロパティをローカルまたは adl ファイルに再帰的にダンプします。 File プロパティには、ディスク使用量、Acl、またはその両方を指定できます。 AdlsClient のインスタンスを作成する前に、ServicePointManager.DefaultConnectionLimit を SDK で使用するスレッド数に設定することを強くお勧めします。 既定では、ServicePointManager.DefaultConnectionLimit は 2 に設定されています。
GetReadStream(String, CancellationToken)	ADLS 内のファイルからデータを読み取るストリームを返す同期 API
GetReadStream(String, Int32, CancellationToken)	ADLS 内のファイルからデータを読み取るストリームを返す同期 API
GetReadStreamAsync(String, CancellationToken)	ADLS 内のファイルからデータを読み取るストリームを返す非同期 API
GetReadStreamAsync(String, Int32, CancellationToken)	ADLS 内のファイルからデータを読み取るストリームを返す非同期 API
ModifyAclEntries(String, List<AclEntry>, CancellationToken)	指定された ACL リストを使用して、ファイルまたはディレクトリの ACL エントリを変更します。 exisitng ACL リストを特定のリストとマージします。
ModifyAclEntriesAsync(String, List<AclEntry>, CancellationToken)	指定された ACL リストを使用して、ファイルまたはディレクトリの ACL エントリを非同期的に変更します。 exisitng ACL リストを特定のリストとマージします。
RemoveAclEntries(String, List<AclEntry>, CancellationToken)	ファイルまたはディレクトリの指定された ACL エントリを削除します。
RemoveAclEntriesAsync(String, List<AclEntry>, CancellationToken)	ファイルまたはディレクトリの指定された ACL エントリを非同期的に削除します。
RemoveAllAcls(String, CancellationToken)	ファイルまたはディレクトリのすべての ACL エントリを削除します。
RemoveAllAclsAsync(String, CancellationToken)	ファイルまたはディレクトリのすべての ACL エントリを非同期的に削除します。
RemoveDefaultAcls(String, CancellationToken)	ファイルまたはディレクトリの AclScope の既定のすべての Acl エントリを削除します。
RemoveDefaultAclsAsync(String, CancellationToken)	ファイルまたはディレクトリの AclScope の既定のすべての Acl エントリを非同期的に削除します。
Rename(String, String, Boolean, CancellationToken)	ファイルまたはディレクトリの名前を変更する同期 API。 ディレクトリの名前を変更する場合: 宛先が存在する場合は、ソース ディレクトリを宛先の 1 レベル下に配置します。
RenameAsync(String, String, Boolean, CancellationToken)	ファイルまたはディレクトリの名前を変更する非同期 API。 ディレクトリの名前を変更する場合: 宛先が存在する場合は、ソース ディレクトリを宛先の 1 レベル下に配置します。
RestoreDeletedItems(String, String, String, String, CancellationToken)	同期的にごみ箱エントリを復元する 注意: ファイルの削除はベスト エフォート操作です。 削除後にファイルを復元できる保証はありません。 この API の使用は、ホワイトリスト登録によって有効になります。 ADL アカウントがホワイトリストに登録されていない場合、この API を使用すると Not immplemented 例外がスローされます。 詳細とサポートについては、Microsoft サポートにお問い合わせください。
RestoreDeletedItemsAsync(String, String, String, String, CancellationToken)	ごみ箱エントリを非同期的に復元する 注意: ファイルの削除はベスト エフォート操作です。 削除後にファイルを復元できる保証はありません。 この API の使用は、ホワイトリスト登録によって有効になります。 ADL アカウントがホワイトリストに登録されていない場合、この API を使用すると Not immplemented 例外がスローされます。 詳細とサポートについては、Microsoft サポートにお問い合わせください。
SetAcl(String, List<AclEntry>, CancellationToken)	ファイルまたはディレクトリの ACL エントリを設定します。 パスの既存の Acl エントリがワイプされます。
SetAclAsync(String, List<AclEntry>, CancellationToken)	ファイルまたはディレクトリの ACL エントリを非同期的に設定します。 パスの既存の Acl エントリがワイプされます。
SetConditionalCreateWithOverwrite(Boolean)	上書きを使用して条件付き作成を実行するかどうかを設定します。 再試行に関するアトミックな問題の解決に役立ちます
SetExpiryTime(String, ExpiryOption, Int64, CancellationToken)	有効期限を同期的に設定する
SetExpiryTimeAsync(String, ExpiryOption, Int64, CancellationToken)	有効期限を非同期的に設定する
SetOwner(String, String, String, CancellationToken)	パスの所有者またはグループを設定します。
SetOwnerAsync(String, String, String, CancellationToken)	パスの所有者またはグループを非同期に設定する
SetPermission(String, String, CancellationToken)	指定したパスのアクセス許可を設定します
SetPermissionAsync(String, String, CancellationToken)	指定したパスのアクセス許可を非同期的に設定する
SetPerRequestTimeout(TimeSpan)	要求ごとのタイムアウトを設定します。 クライアントの作成後に設定することを強くお勧めします。 別のスレッドから要求が進行中の場合は、設定しないことをお勧めします。
SetToken(String)	認証トークンを設定します。