DataLakeFileSystemClient.GetPathsAsync メソッド

定義

名前空間:

Azure.Storage.Files.DataLake

アセンブリ:

Azure.Storage.Files.DataLake.dll

パッケージ:

Azure.Storage.Files.DataLake v12.17.1

ソース:

DataLakeFileSystemClient.cs

この操作は GetPathsAsync(String, Boolean, Boolean, CancellationToken) 、このファイル システム内のパスの非同期シーケンスを返します。 パスを列挙すると、すべての値をフェッチするときに、サービスに対して複数の要求が行われる場合があります。

詳細については、「 リスト パス。

public virtual Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem> GetPathsAsync (string path = default, bool recursive = false, bool userPrincipalName = false, System.Threading.CancellationToken cancellationToken = default);

abstract member GetPathsAsync : string * bool * bool * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem>
override this.GetPathsAsync : string * bool * bool * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem>

Public Overridable Function GetPathsAsync (Optional path As String = Nothing, Optional recursive As Boolean = false, Optional userPrincipalName As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PathItem)

パラメーター

path

String

指定したディレクトリ内のパスに結果をフィルター処理します。

recursive

Boolean

"true" の場合、すべてのパスが一覧表示されます。それ以外の場合は、ファイルシステムのルートにあるパスのみが一覧表示されます。

userPrincipalName

Boolean

任意。 アカウントに対して階層型名前空間が有効になっている場合にのみ有効です。 "true" の場合、各リスト エントリの所有者フィールドとグループ フィールドで返されるユーザー ID 値は、Azure Active Directory オブジェクト ID からユーザー プリンシパル名に変換されます。 "false" の場合、値は Azure Active Directory オブジェクト ID として返されます。 既定値は false です。 グループとアプリケーションのオブジェクト ID は一意のフレンドリ名を持たないため、変換されないことに注意してください。

cancellationToken

CancellationToken

操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。

戻り値

AsyncPageable<PathItem>

AsyncPageable<T>ファイル システム内のパスを記述する 。

注釈

RequestFailedExceptionエラーが発生すると、 がスローされます。