次の方法で共有


DataLakePathClient class

DataLakePathClient は、Azure Storage パス (ディレクトリまたはファイル) への URL を表します。

Extends

StorageClient

コンストラクター

DataLakePathClient(string, Pipeline)

URL とパイプラインから DataLakePathClient のインスタンスを作成します。

DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

URL と資格情報から DataLakePathClient のインスタンスを作成します。

プロパティ

fileSystemName

現在のファイル システムの名前。

name

現在のパス (ディレクトリまたはファイル) の名前。

継承されたプロパティ

accountName
credential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

url

エンコードされた URL 文字列値。

メソッド

create(PathResourceTypeModel, PathCreateOptions)

ディレクトリまたはパスを作成します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

ディレクトリまたはファイルを作成します。 リソースが既に存在する場合、変更されません。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

delete(boolean, PathDeleteOptions)

現在のパス (ディレクトリまたはファイル) を削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete」を参照してください。

deleteIfExists(boolean, PathDeleteOptions)

現在のパス (ディレクトリまたはファイル) が存在する場合は削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete」を参照してください。

exists(PathExistsOptions)

このクライアントによって表される Data Lake ファイルが存在する場合は true を返します。それ以外の場合は false。

注: 既存のファイルは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同様に、この関数の完了後に他のクライアントまたはアプリケーションによって新しいファイルが追加される場合があります。

getAccessControl(PathGetAccessControlOptions)

パス (ファイルのディレクトリ) のアクセス制御データを返します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties」を参照してください。

getDataLakeLeaseClient(string)

パス (ディレクトリまたはファイル) のリースを管理する DataLakeLeaseClient を取得します。

getProperties(PathGetPropertiesOptions)

パス (ディレクトリまたはファイル) のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。

警告: 応答で返されるオブジェクトのキーは metadata 、最初に大文字が含まれていた場合でも小文字になります。 これは、 オプションを使用してincludeMetadataパスを一覧表示する DataLakeFileSystemClient のメソッドによって返されるメタデータ キーとは異なり、元の大文字と小文字が保持されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties」を参照してください。

move(string, PathMoveOptions)

同じファイル システム内のディレクトリまたはファイルを移動します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

move(string, string, PathMoveOptions)

ディレクトリまたはファイルを別のファイル システムに移動します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

パスとサブ パスのAccess Controlを削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

パス (ファイルのディレクトリ) のアクセス制御データを設定します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

パスとサブ パスのAccess Controlを設定します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

パス (ディレクトリまたはファイル) にシステム プロパティを設定します。

値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合は、値のないこれらの BLOB HTTP ヘッダーがクリアされます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties」を参照してください。

setMetadata(Metadata, PathSetMetadataOptions)

指定したパス (ファイルのディレクトリ) のユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。

オプションが指定されていない場合、または パラメーターにメタデータが定義されていない場合は、パス メタデータが削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata」を参照してください。

setPermissions(PathPermissions, PathSetPermissionsOptions)

パスに対するファイルのアクセス許可を設定します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

toDirectoryClient()

現在のパスがディレクトリの場合は、現在の DataLakePathClient を DataLakeDirectoryClient に変換します。

toFileClient()

現在のパスがファイルの場合は、現在の DataLakePathClient を DataLakeFileClient に変換します。

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

パスとサブパスのAccess Controlを変更します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

コンストラクターの詳細

DataLakePathClient(string, Pipeline)

URL とパイプラインから DataLakePathClient のインスタンスを作成します。

new DataLakePathClient(url: string, pipeline: Pipeline)

パラメーター

url

string

"; などのhttps://myaccount.dfs.core.windows.net/filesystem/directory" Azure Storage データ レイク パス (ディレクトリまたはファイル) を指すクライアント文字列。または "https://myaccount.dfs.core.windows.net/filesystem/file". AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString")。

pipeline
Pipeline

newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。

DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

URL と資格情報から DataLakePathClient のインスタンスを作成します。

new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

パラメーター

url

string

"; などのhttps://myaccount.dfs.core.windows.net/filesystem/directory" Azure Storage データ レイク パス (ディレクトリまたはファイル) を指すクライアント文字列。または "https://myaccount.dfs.core.windows.net/filesystem/file". AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString")。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

options
StoragePipelineOptions

省略可能。 HTTP パイプラインを構成するためのオプション。

プロパティの詳細

fileSystemName

現在のファイル システムの名前。

string fileSystemName

プロパティ値

string

name

現在のパス (ディレクトリまたはファイル) の名前。

string name

プロパティ値

string

継承されたプロパティの詳細

accountName

accountName: string

プロパティ値

string

継承元 StorageClient.accountName

credential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

継承元 StorageClient.credential

url

エンコードされた URL 文字列値。

url: string

プロパティ値

string

継承元 StorageClient.url

メソッドの詳細

create(PathResourceTypeModel, PathCreateOptions)

ディレクトリまたはパスを作成します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

パラメーター

resourceType
PathResourceTypeModel

リソースの種類、"directory"、または "file" です。

options
PathCreateOptions

省略可能。 パスを作成するときのオプション。

戻り値

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

ディレクトリまたはファイルを作成します。 リソースが既に存在する場合、変更されません。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

パラメーター

resourceType
PathResourceTypeModel

リソースの種類、"directory"、または "file" です。

戻り値

delete(boolean, PathDeleteOptions)

現在のパス (ディレクトリまたはファイル) を削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete」を参照してください。

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

パラメーター

recursive

boolean

必須で、リソースがディレクトリの場合にのみ有効です。 "true" の場合、ディレクトリの下にあるすべてのパスが削除されます。

options
PathDeleteOptions

省略可能。 パスを削除するときのオプション。

戻り値

deleteIfExists(boolean, PathDeleteOptions)

現在のパス (ディレクトリまたはファイル) が存在する場合は削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete」を参照してください。

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

パラメーター

recursive

boolean

必須で、リソースがディレクトリの場合にのみ有効です。 "true" の場合、ディレクトリの下にあるすべてのパスが削除されます。

戻り値

exists(PathExistsOptions)

このクライアントによって表される Data Lake ファイルが存在する場合は true を返します。それ以外の場合は false。

注: 既存のファイルは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同様に、この関数の完了後に他のクライアントまたはアプリケーションによって新しいファイルが追加される場合があります。

function exists(options?: PathExistsOptions): Promise<boolean>

パラメーター

options
PathExistsOptions

オプションを [Exists operation]\(存在する操作\) に設定します。

戻り値

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

パス (ファイルのディレクトリ) のアクセス制御データを返します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties」を参照してください。

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

パラメーター

options
PathGetAccessControlOptions

省略可能。 ファイル アクセス制御を取得するときのオプション。

戻り値

getDataLakeLeaseClient(string)

パス (ディレクトリまたはファイル) のリースを管理する DataLakeLeaseClient を取得します。

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

パラメーター

proposeLeaseId

string

省略可能。 最初に提案されたリース ID。

戻り値

getProperties(PathGetPropertiesOptions)

パス (ディレクトリまたはファイル) のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。

警告: 応答で返されるオブジェクトのキーは metadata 、最初に大文字が含まれていた場合でも小文字になります。 これは、 オプションを使用してincludeMetadataパスを一覧表示する DataLakeFileSystemClient のメソッドによって返されるメタデータ キーとは異なり、元の大文字と小文字が保持されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties」を参照してください。

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

パラメーター

options
PathGetPropertiesOptions

省略可能。 パス プロパティを取得するときのオプション。

戻り値

move(string, PathMoveOptions)

同じファイル システム内のディレクトリまたはファイルを移動します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

パラメーター

destinationPath

string

"directory" やファイル パス "directory/file" などの宛先ディレクトリ パス。 destinationPath が SAS で認証されている場合は、"directory/file?sasToken" などの宛先パスに SAS を追加します。

options
PathMoveOptions

省略可能。 ディレクトリまたはファイルを移動するときのオプション。

戻り値

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

ディレクトリまたはファイルを別のファイル システムに移動します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

パラメーター

destinationFileSystem

string

"filesystem" のような変換先ファイル システム。

destinationPath

string

"directory" やファイル パス "directory/file" などの宛先ディレクトリ パス destinationPath が SAS で認証されている場合は、"directory/file?sasToken" のような宛先パスに SAS を追加します。

options
PathMoveOptions

省略可能。 ディレクトリまたはファイルを移動するときのオプション。

戻り値

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

パスとサブ パスのAccess Controlを削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

パラメーター

acl

RemovePathAccessControlItem[]

ファイルまたはディレクトリの POSIX アクセス制御リスト。

options
PathChangeAccessControlRecursiveOptions

省略可能。 オプション

戻り値

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

パス (ファイルのディレクトリ) のアクセス制御データを設定します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

パラメーター

acl

PathAccessControlItem[]

ファイルまたはディレクトリの POSIX アクセス制御リスト。

options
PathSetAccessControlOptions

省略可能。 パス アクセス制御を設定するときのオプション。

戻り値

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

パスとサブ パスのAccess Controlを設定します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

パラメーター

acl

PathAccessControlItem[]

ファイルまたはディレクトリの POSIX アクセス制御リスト。

options
PathChangeAccessControlRecursiveOptions

省略可能。 オプション

戻り値

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

パス (ディレクトリまたはファイル) にシステム プロパティを設定します。

値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合は、値のないこれらの BLOB HTTP ヘッダーがクリアされます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties」を参照してください。

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

パラメーター

httpHeaders
PathHttpHeaders

戻り値

setMetadata(Metadata, PathSetMetadataOptions)

指定したパス (ファイルのディレクトリ) のユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。

オプションが指定されていない場合、または パラメーターにメタデータが定義されていない場合は、パス メタデータが削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata」を参照してください。

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

パラメーター

metadata
Metadata

省略可能。 既存のメタデータをこの値に置き換えます。 値が指定されていない場合、既存のメタデータは削除されます。

options
PathSetMetadataOptions

省略可能。 パス メタデータを設定するときのオプション。

戻り値

setPermissions(PathPermissions, PathSetPermissionsOptions)

パスに対するファイルのアクセス許可を設定します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

パラメーター

permissions
PathPermissions

ファイル所有者、ファイル所有グループなどの POSIX アクセス許可。

options
PathSetPermissionsOptions

省略可能。 パスのアクセス許可を設定するときのオプション。

戻り値

toDirectoryClient()

現在のパスがディレクトリの場合は、現在の DataLakePathClient を DataLakeDirectoryClient に変換します。

function toDirectoryClient(): DataLakeDirectoryClient

戻り値

toFileClient()

現在のパスがファイルの場合は、現在の DataLakePathClient を DataLakeFileClient に変換します。

function toFileClient(): DataLakeFileClient

戻り値

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

パスとサブパスのAccess Controlを変更します。

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

パラメーター

acl

PathAccessControlItem[]

ファイルまたはディレクトリの POSIX アクセス制御リスト。

options
PathChangeAccessControlRecursiveOptions

省略可能。 オプション

戻り値