DataLakeFileClient class

リファレンス

パッケージ:: @azure/storage-file-datalake

DataLakeFileClient は、Azure Storage ファイルへの URL を表します。

Extends: DataLakePathClient

コンストラクター

DataLakeFileClient(string, Pipeline)	URL とパイプラインから DataLakeFileClient のインスタンスを作成します。
DataLakeFileClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	URL と資格情報から DataLakeFileClient のインスタンスを作成します。

プロパティ

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

継承されたプロパティ

accountName
credential	AnonymousCredential、StorageSharedKeyCredential、またはサービスに対する要求を `@azure/identity` 認証するためのパッケージからの任意の資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。指定しない場合は、AnonymousCredential が使用されます。
url	エンコードされた URL 文字列値。

メソッド

append(RequestBodyType, number, number, FileAppendOptions)	ファイルに追加するデータをアップロードします。データはファイルにのみ追加できます。頻繁にアップロードされたデータをファイルに適用するには、flush を呼び出します。「https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update」を参照してください。
create(FileCreateOptions)	ファイルを作成します。「https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。
create(PathResourceTypeModel, PathCreateOptions)	ファイルを作成します。「https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create」を参照してください。
createIfNotExists(FileCreateIfNotExistsOptions)	まだ存在しない場合は、ファイルを作成します。「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」を参照してください。
flush(number, FileFlushOptions)	以前に追加されたデータをファイルにフラッシュ (書き込み) します。
generateSasUrl(FileGenerateSasUrlOptions)	共有キー資格情報を使用して構築されたクライアントでのみ使用できます。渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。
query(string, FileQueryOptions)	JSON または CSV 形式のファイルのクイッククエリ。使用例 (Node.js): // Query and convert a file to a string const queryResponse = await fileClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString(); console.log("Query file content:", downloaded); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); }
read(number, number, FileReadOptions)	メタデータとプロパティを含むファイルをサービスからダウンロードします。 Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されますブラウザーでは、promise contentAsBlob でデータが返されます「https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob」を参照してください。使用例 (Node.js): // Download and convert a file to a string const downloadResponse = await fileClient.read(); const downloaded = await streamToBuffer(downloadResponse.readableStreamBody); console.log("Downloaded file content:", downloaded.toString()); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); } 使用例 (ブラウザー): `// Download and convert a file to a string const downloadResponse = await fileClient.read(); const downloaded = await blobToString(await downloadResponse.contentAsBlob); console.log("Downloaded file content", downloaded); async function blobToString(blob: Blob): Promise<string> { const fileReader = new FileReader(); return new Promise<string>((resolve, reject) => { fileReader.onloadend = (ev: any) => { resolve(ev.target!.result); }; fileReader.onerror = reject; fileReader.readAsText(blob); }); }`
readToBuffer(Buffer, number, number, FileReadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Data Lake ファイルをバッファーに並列で読み取ります。オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体を読み取ります。警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きいファイルの場合は、 readToFile を検討してください。
readToBuffer(number, number, FileReadToBufferOptions)	NODE.JS ランタイムでのみ使用できます Data Lake ファイルをバッファーに並列で読み取ります。オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体を読み取ります警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きいファイルの場合は、 readToFile を検討してください。
readToFile(string, number, number, FileReadOptions)	NODE.JSランタイムでのみ使用できます。 Data Lake ファイルをローカルファイルにダウンロードします。指定されたファイルパスが既に終了している場合、失敗します。オフセットとカウントは省略可能で、それぞれ 0 と undefined を渡してファイル全体をダウンロードします。
setExpiry(FileExpiryMode, FileSetExpiryOptions)	ファイルの有効期限を設定します。その時間に達すると、ファイルが削除されます。
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView をファイルにアップロードします。
uploadFile(string, FileParallelUploadOptions)	NODE.JSランタイムでのみ使用できます。ローカルファイルを Data Lake ファイルにアップロードします。
uploadStream(Readable, FileParallelUploadOptions)	NODE.JSランタイムでのみ使用できます。 Node.js読み取り可能ストリームを Data Lake ファイルにアップロードします。このメソッドはファイルの作成を試み、チャンクごとにチャンクのアップロードを開始します。ストリームの潜在的なサイズがFILE_MAX_SIZE_BYTESを超えず、チャンクの潜在的な数がBLOCK_BLOB_MAX_BLOCKSを超えていないことを確認してください。パフォーマンス向上のヒント: 入力ストリーム highWaterMark は、options.chunkSize パラメーターを使用して同じ値を設定することをお勧めします。これにより、Buffer.concat() 操作が回避されます。

継承されたメソッド

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」を参照してください。

コンストラクターの詳細

DataLakeFileClient(string, Pipeline)

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

new DataLakeFileClient(url: string, pipeline: Pipeline)

パラメーター

url: string

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

pipeline: Pipeline

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

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

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

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

パラメーター

url: string

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

DataLakePathClient.accountNameから継承

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

DataLakePathClient.credentialから継承

url

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

url: string

プロパティ値

string

DataLakePathClient.urlから継承

メソッドの詳細

append(RequestBodyType, number, number, FileAppendOptions)

ファイルに追加するデータをアップロードします。データはファイルにのみ追加できます。頻繁にアップロードされたデータをファイルに適用するには、flush を呼び出します。

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

function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>

パラメーター

body: HttpRequestBody

アップロードするコンテンツ。

offset: number

オフセットをバイト単位で追加します。

length: number

追加するコンテンツの長さ (バイト単位)。

options: FileAppendOptions

省略可能。データを追加するときのオプション。

戻り値

Promise<FileAppendResponse>

create(FileCreateOptions)

ファイルを作成します。

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

function create(options?: FileCreateOptions): Promise<FileCreateResponse>

パラメーター

options: FileCreateOptions

省略可能。ファイル作成時のオプション。

戻り値

Promise<FileCreateResponse>

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

リソースの種類は、DataLakeFileClient の場合は "file" である必要があります。

options: PathCreateOptions

省略可能。ファイル作成時のオプション。

戻り値

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

まだ存在しない場合は、ファイルを作成します。

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

function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>

パラメーター

options: FileCreateIfNotExistsOptions

省略可能。ファイル作成時のオプション。

戻り値

Promise<FileCreateIfNotExistsResponse>

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

リソースの種類は、DataLakeFileClient の場合は "file" である必要があります。

options: PathCreateIfNotExistsOptions

戻り値

Promise<PathCreateIfNotExistsResponse>

flush(number, FileFlushOptions)

以前に追加されたデータをファイルにフラッシュ (書き込み) します。

function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>

パラメーター

position: number

フラッシュするファイルの位置。このパラメーターを使用すると、呼び出し元はデータを並行してアップロードし、ファイルに追加する順序を制御できます。ファイルに追加するデータをアップロードするとき、および以前にアップロードしたデータをファイルにフラッシュするときに必要です。値は、データを追加する位置である必要があります。アップロードされたデータは、ファイルにすぐにフラッシュまたは書き込まれるわけではありません。フラッシュするには、以前にアップロードしたデータが連続している必要があります。position パラメーターを指定し、すべてのデータが書き込まれた後のファイルの長さと同じにする必要があり、要求に含まれる要求エンティティ本文が存在しないようにする必要があります。

options: FileFlushOptions

省略可能。データをフラッシュするときのオプション。

戻り値

Promise<FileFlushResponse>

generateSasUrl(FileGenerateSasUrlOptions)

共有キー資格情報を使用して構築されたクライアントでのみ使用できます。

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。

function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>

パラメーター

options: FileGenerateSasUrlOptions

省略可能なパラメーター。

戻り値

Promise<string>

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

query(string, FileQueryOptions)

JSON または CSV 形式のファイルのクイッククエリ。

使用例 (Node.js):

// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString();
console.log("Query file content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>

パラメーター

query: string

options: FileQueryOptions

戻り値

Promise<FileReadResponse>

read(number, number, FileReadOptions)

メタデータとプロパティを含むファイルをサービスからダウンロードします。

Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されます
ブラウザーでは、promise contentAsBlob でデータが返されます

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

使用例 (Node.js):

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

使用例 (ブラウザー):

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await blobToString(await downloadResponse.contentAsBlob);
console.log("Downloaded file content", downloaded);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

パラメーター

offset: number

省略可能。読み取りファイルへのオフセット。既定値は 0 です。

count: number

省略可能。読み取るバイト数。既定値はオフセットから末尾に読み取られます。

options: FileReadOptions

省略可能。ファイルの読み取り時のオプション。

戻り値

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

NODE.JSランタイムでのみ使用できます。

Data Lake ファイルをバッファーに並列で読み取ります。オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体を読み取ります。

警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きいファイルの場合は、 readToFile を検討してください。

function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

パラメーター

buffer: Buffer

バッファーを塗りつぶすには、count より大きい長さを持つ必要があります

offset: number

読み取る Data Lake ファイルの位置

count: number

読み取るデータの量。未定義を渡すときに最後まで読み取られます

options: FileReadToBufferOptions

戻り値

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

NODE.JS ランタイムでのみ使用できます

Data Lake ファイルをバッファーに並列で読み取ります。オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体を読み取ります

function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

パラメーター

offset: number

Data Lake ファイルの読み取り元の位置 (バイト単位)

count: number

読み取るデータの量 (バイト単位)。未定義を渡すときに最後まで読み取られます

options: FileReadToBufferOptions

戻り値

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

NODE.JSランタイムでのみ使用できます。

Data Lake ファイルをローカルファイルにダウンロードします。指定されたファイルパスが既に終了している場合、失敗します。オフセットとカウントは省略可能で、それぞれ 0 と undefined を渡してファイル全体をダウンロードします。

function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

パラメーター

filePath: string

offset: number

ダウンロードするファイルの位置。

count: number

ダウンロードするデータの量。未定義を渡すときに末尾にダウンロードされます。

options: FileReadOptions

Data Lake ファイルを読み取るオプション。

戻り値

Promise<FileReadResponse>

ファイル読み取り操作の応答データ。ただし、readableStreamBody の内容は既に読み取られ、指定されたパスのローカルファイルに書き込まれるため、undefined に設定されています。

setExpiry(FileExpiryMode, FileSetExpiryOptions)

ファイルの有効期限を設定します。その時間に達すると、ファイルが削除されます。

function setExpiry(mode: FileExpiryMode, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>

パラメーター

mode: FileExpiryMode

options: FileSetExpiryOptions

戻り値

Promise<FileSetExpiryResponse>

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView をファイルにアップロードします。

function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

パラメーター

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node)、Blob、ArrayBuffer、ArrayBufferView

options: FileParallelUploadOptions

戻り値

Promise<FileUploadResponse>

uploadFile(string, FileParallelUploadOptions)

NODE.JSランタイムでのみ使用できます。

ローカルファイルを Data Lake ファイルにアップロードします。

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

パラメーター

filePath: string

ローカルファイルの完全パス

options: FileParallelUploadOptions

戻り値

Promise<FileUploadResponse>

uploadStream(Readable, FileParallelUploadOptions)

NODE.JSランタイムでのみ使用できます。

Node.js読み取り可能ストリームを Data Lake ファイルにアップロードします。このメソッドはファイルの作成を試み、チャンクごとにチャンクのアップロードを開始します。ストリームの潜在的なサイズがFILE_MAX_SIZE_BYTESを超えず、チャンクの潜在的な数がBLOCK_BLOB_MAX_BLOCKSを超えていないことを確認してください。

パフォーマンス向上のヒント:

入力ストリーム highWaterMark は、options.chunkSize パラメーターを使用して同じ値を設定することをお勧めします。これにより、Buffer.concat() 操作が回避されます。

function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

パラメーター

stream: Readable

読み取り可能ストリームをNode.jsします。

options: FileParallelUploadOptions

戻り値

Promise<FileUploadResponse>

継承済みメソッドの詳細

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

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

戻り値

Promise<PathDeleteResponse>

DataLakePathClient.deleteから継承

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" の場合、ディレクトリの下にあるすべてのパスが削除されます。

options: PathDeleteOptions

戻り値

Promise<PathDeleteIfExistsResponse>

DataLakePathClient.deleteIfExistsから継承

exists(PathExistsOptions)

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

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

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

パラメーター

options: PathExistsOptions

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

戻り値

Promise<boolean>

DataLakePathClient.existsから継承

getAccessControl(PathGetAccessControlOptions)

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

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

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

パラメーター

options: PathGetAccessControlOptions

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

戻り値

Promise<PathGetAccessControlResponse>

DataLakePathClient.getAccessControlから継承

getDataLakeLeaseClient(string)

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

パラメーター

proposeLeaseId: string

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

戻り値

DataLakeLeaseClient

DataLakePathClient.getDataLakeLeaseClientから継承

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

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

戻り値

Promise<PathGetPropertiesResponse>

DataLakePathClient.getPropertiesから継承

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>

DataLakePathClient.moveから継承

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" や file path "directory/file" などの宛先ディレクトリパス destinationPath が SAS で認証されている場合は、"directory/file?sasToken" などの宛先パスに SAS を追加します。

options: PathMoveOptions

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

戻り値

Promise<PathMoveResponse>

DataLakePathClient.moveから継承

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

省略可能。オプション

戻り値

Promise<PathChangeAccessControlRecursiveResponse>

DataLakePathClient.removeAccessControlRecursiveから継承

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

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

戻り値

Promise<PathSetAccessControlResponse>

DataLakePathClient.setAccessControlから継承

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

省略可能。オプション

戻り値

Promise<PathChangeAccessControlRecursiveResponse>

DataLakePathClient.setAccessControlRecursiveから継承

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

options: PathSetHttpHeadersOptions

戻り値

Promise<PathSetHttpHeadersResponse>

DataLakePathClient.setHttpHeadersから継承

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

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

戻り値

Promise<PathSetMetadataResponse>

DataLakePathClient.setMetadataから継承

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

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

戻り値

Promise<PathSetPermissionsResponse>

DataLakePathClient.setPermissionsから継承

toDirectoryClient()

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

function toDirectoryClient(): DataLakeDirectoryClient

戻り値

DataLakeDirectoryClient

DataLakePathClient.toDirectoryClientから継承

toFileClient()

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

function toFileClient(): DataLakeFileClient

戻り値

DataLakeFileClient

DataLakePathClient.toFileClientから継承

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

省略可能。オプション

戻り値

Promise<PathChangeAccessControlRecursiveResponse>

DataLakePathClient.updateAccessControlRecursiveから継承

次の方法で共有

DataLakeFileClient class

コンストラクター

プロパティ

継承されたプロパティ

メソッド

継承されたメソッド

コンストラクターの詳細

DataLakeFileClient(string, Pipeline)

パラメーター

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

パラメーター

プロパティの詳細

fileSystemName

プロパティ値

name

プロパティ値

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

accountName

プロパティ値

credential

プロパティ値

url

プロパティ値

メソッドの詳細

append(RequestBodyType, number, number, FileAppendOptions)

パラメーター

戻り値

create(FileCreateOptions)

パラメーター

戻り値

create(PathResourceTypeModel, PathCreateOptions)

パラメーター

戻り値

createIfNotExists(FileCreateIfNotExistsOptions)

パラメーター

戻り値

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

パラメーター

戻り値

flush(number, FileFlushOptions)

パラメーター

戻り値

generateSasUrl(FileGenerateSasUrlOptions)

パラメーター

戻り値

query(string, FileQueryOptions)

パラメーター

戻り値

read(number, number, FileReadOptions)

パラメーター

戻り値

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

パラメーター

戻り値

readToBuffer(number, number, FileReadToBufferOptions)

パラメーター

戻り値

readToFile(string, number, number, FileReadOptions)

パラメーター

戻り値

setExpiry(FileExpiryMode, FileSetExpiryOptions)

パラメーター

戻り値

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

パラメーター

戻り値

uploadFile(string, FileParallelUploadOptions)

パラメーター

戻り値

uploadStream(Readable, FileParallelUploadOptions)

パラメーター

戻り値

継承済みメソッドの詳細

delete(boolean, PathDeleteOptions)

パラメーター

戻り値

deleteIfExists(boolean, PathDeleteOptions)

パラメーター

戻り値