ShareFileClient class

パッケージ:

@azure/storage-file-share

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

Extends

StorageClient

コンストラクター

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)	ShareFileClient のインスタンスを作成します。
ShareFileClient(string, Pipeline, ShareClientConfig)	ShareFileClient のインスタンスを作成します。

プロパティ

name	ファイルの名前
path	ファイルの完全パス
shareName	このファイル クライアントに対応する共有名

継承されたプロパティ

accountName
url	URL 文字列値。

メソッド

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	保留中の [ファイルのコピー] 操作を中止し、コピー先ファイルの長さと完全なメタデータを残します。 「https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file」を参照してください。
clearRange(number, number, FileClearRangeOptions)	指定した範囲をクリアし、その範囲の記憶域で使用されている領域を解放します。
create(number, FileCreateOptions)	新しいファイルを作成するか、ファイルを置き換えます。 これは、コンテンツを含まないファイルのみを初期化します。 「https://docs.microsoft.com/en-us/rest/api/storageservices/create-file」を参照してください。
delete(FileDeleteOptions)	ストレージ アカウントからファイルを削除します。 正常に削除されたファイルは、その時点でストレージ アカウントのインデックスから削除され、クライアントからアクセスできなくなります。 ファイルのデータは、後でガベージ コレクション中にサービスから削除されます。 ファイルが SMB クライアントで開かれている場合、ファイルの削除は状態コード 409 (競合) とエラー コード SharingViolation で失敗します。 共有スナップショット (共有の読み取り専用コピー) では、ファイルの削除はサポートされていません。 共有スナップショットでこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します 「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2」を参照してください。
deleteIfExists(FileDeleteOptions)	ストレージ アカウントが存在する場合は、ストレージ アカウントからファイルを削除します。 正常に削除されたファイルは、その時点でストレージ アカウントのインデックスから削除され、クライアントからアクセスできなくなります。 ファイルのデータは、後でガベージ コレクション中にサービスから削除されます。 ファイルが SMB クライアントで開かれている場合、ファイルの削除は状態コード 409 (競合) とエラー コード SharingViolation で失敗します。 共有スナップショット (共有の読み取り専用コピー) では、ファイルの削除はサポートされていません。 共有スナップショットでこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します 「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2」を参照してください。
download(number, number, FileDownloadOptions)	メタデータやプロパティなど、システムからファイルを読み取りまたはダウンロードします。 Node.js では、読み取り可能ストリームでデータが返されます readableStreamBody ブラウザーでは、データは promise で返されます contentAsBlob 「https://docs.microsoft.com/en-us/rest/api/storageservices/get-file」を参照してください。
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	NODE.JS ランタイムでのみ使用できます。 バッファーに並列で Azure ファイルをダウンロードします。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体をダウンロードします。 警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があります。 このサイズより大きいファイルの場合は、 downloadToFile を検討してください。
downloadToBuffer(number, number, FileDownloadToBufferOptions)	NODE.JS ランタイムでのみ使用できます バッファーに並列で Azure ファイルをダウンロードします。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体をダウンロードします 警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があります。 このサイズより大きいファイルの場合は、 downloadToFile を検討してください。
downloadToFile(string, number, number, FileDownloadOptions)	NODE.JS ランタイムでのみ使用できます。 Azure BLOB をローカル ファイルにダウンロードします。 指定されたファイル パスが既に終了した場合、失敗します。 オフセットとカウントは省略可能です。BLOB 全体をダウンロードするには、それぞれ 0 と undefined を渡します。
exists(FileExistsOptions)	指定したファイルが存在する場合は true を返します。それ以外の場合は false。 注: 既存のファイルは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しいファイルが追加される可能性があります。
forceCloseAllHandles(FileForceCloseHandlesOptions)	ファイルのすべてのハンドルを強制的に閉じます。 「https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles」を参照してください。
forceCloseHandle(string, FileForceCloseHandlesOptions)	ファイルの特定のハンドルを強制的に閉じます。 「https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles」を参照してください。
generateSasUrl(FileGenerateSasUrlOptions)	共有キー資格情報を使用して構築されたクライアントでのみ使用できます。 渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。 「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。
getProperties(FileGetPropertiesOptions)	ファイルのすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 ファイルのコンテンツは返しません。 「https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-properties」を参照してください。
getRangeList(FileGetRangeListOptions)	ファイルの有効な範囲の一覧を返します。
getRangeListDiff(string, FileGetRangeListOptions)	以前の共有スナップショットとこのファイルの間で異なる範囲の一覧を返します。
getShareLeaseClient(string)	ファイルのリースを管理する ShareLeaseClient を取得します。
listHandles(FileListHandlesOptions)	すべてのハンドルを一覧表示する非同期反復可能反復子を返します。 指定したアカウントの下。 .byPage() は、ページ内のハンドルを一覧表示する非同期反復可能反復子を返します。
rename(string, FileRenameOptions)	ファイル名を変更します。 この API では、同じ共有内のファイルの名前変更のみがサポートされます。
resize(number, FileResizeOptions)	ファイルのサイズを変更します。 「https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties」を参照してください。
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	ファイルに HTTP ヘッダーを設定します。 オプションが指定されていない場合、またはオプション内のファイル HTTP ヘッダーに値が指定されていない場合は、値のないこれらのファイル HTTP ヘッダーがクリアされます。 「https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties」を参照してください。
setMetadata(Metadata, FileSetMetadataOptions)	指定したファイルのユーザー定義メタデータを更新します。 オプション パラメーターにメタデータが定義されていない場合、ファイル メタデータは削除されます。 「https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata」を参照してください。
setProperties(FileProperties)	ファイルのプロパティを設定します。 「https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties」を参照してください。
startCopyFromURL(string, FileStartCopyOptions)	BLOB またはファイルをストレージ アカウント内のコピー先ファイルにコピーします。
uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)	新しい Azure ファイルを作成するか、既存の Azure ファイルを置き換えてから、Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView をアップロードします。
uploadFile(string, FileParallelUploadOptions)	NODE.JS ランタイムでのみ使用できます。 新しい Azure ファイルを作成するか、既存の Azure ファイルを置き換えてから、ローカル ファイルをアップロードします。
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	ファイルにバイト範囲をアップロードします。 この操作は、既存のファイルに対してのみ呼び出すことができます。 ファイルのサイズ、プロパティ、メタデータは変更されません。 範囲の開始とカウントの両方を指定する必要があります。 範囲のサイズは最大 4 MB です。
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	別のファイルの URL から内容が読み取られたファイルにバイト範囲をアップロードします。 範囲のサイズは最大 4 MB です。
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	NODE.JS ランタイムでのみ使用できます。 読み取り可能なストリーム ファクトリ Node.js を受け入れ、ブロック単位で Azure ファイルにアップロードします。 読み取り可能ストリーム ファクトリは、定義されたオフセットから開始 Node.js 読み取り可能ストリームを返す必要があります。 オフセットは、アップロードする Azure ファイル内のオフセットです。
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	ブラウザーでのみ使用できます。 ブラウザー BLOB オブジェクトを Azure ファイルにアップロードします。 データ ソースとして blobFactory が必要です。これは、指定されたオフセットとサイズを持つ BLOB オブジェクトを返す必要があります。
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	NODE.JS ランタイムでのみ使用できます。 新しい Azure File を作成するか、既存の Azure ファイルを置き換えてから、Node.js 読み取り可能ストリームをアップロードします。 このメソッドは、Azure File の作成を試み、チャンクごとにチャンクのアップロードを開始します。 チャンクのサイズはパラメーターによって定義されます bufferSize 。 ストリームの潜在的なサイズがファイル サイズを超えないようにしてください。 パフォーマンス向上のヒント: 入力ストリーム highWaterMark は、bufferSize パラメーターを使用して同じ値を設定することをお勧めします。これにより、Buffer.concat() 操作は回避されます。
withShareSnapshot(string)	ソースと同じ、指定された共有スナップショット タイムスタンプを持つ新しい ShareFileClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、ベースの ShareFileClient への URL が返されます。

コンストラクターの詳細

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)

ShareFileClient のインスタンスを作成します。

new ShareFileClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

パラメーター

url

string

"https://myaccount.file.core.windows.net/myshare/mydirectory/file" など、Azure Storage ファイルを指す URL 文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString")。 このメソッドは、ファイルを指すエンコードされた URL またはエンコードされていない URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 ただし、ファイル名またはディレクトリ名に %が含まれている場合は、URL にファイル名またはディレクトリ名をエンコードする必要があります。 "myfile%" という名前のファイルなど、URL は "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25"" である必要があります。

credential

Credential | TokenCredential

、StorageSharedKeyCredential、TokenCredential など、指定しない場合は AnonymousCredential が使用されます。

options

ShareClientOptions

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

ShareFileClient(string, Pipeline, ShareClientConfig)

ShareFileClient のインスタンスを作成します。

new ShareFileClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

パラメーター

url

string

"https://myaccount.file.core.windows.net/myshare/mydirectory/file" など、Azure Storage ファイルを指す URL 文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString")。 このメソッドは、ファイルを指すエンコードされた URL またはエンコードされていない URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 ただし、ファイル名またはディレクトリ名に %が含まれている場合は、URL にファイル名またはディレクトリ名をエンコードする必要があります。 "myfile%" という名前のファイルなど、URL は "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25"" である必要があります。

pipeline

Pipeline

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

options

ShareClientConfig

プロパティの詳細

name

ファイルの名前

string name

プロパティ値

string

path

ファイルの完全パス

string path

プロパティ値

string

shareName

このファイル クライアントに対応する共有名

string shareName

プロパティ値

string

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

accountName

accountName: string

プロパティ値

string

継承元 StorageClient.accountName

url

URL 文字列値。

url: string

プロパティ値

string

継承元 StorageClient.url

メソッドの詳細

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

保留中の [ファイルのコピー] 操作を中止し、コピー先ファイルの長さと完全なメタデータを残します。

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

function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

パラメーター

copyId

string

中止するファイルのコピー操作の ID。

options

FileAbortCopyFromURLOptions

ファイルへのオプション URL からのコピーの中止操作。

戻り値

Promise<FileAbortCopyResponse>

clearRange(number, number, FileClearRangeOptions)

指定した範囲をクリアし、その範囲の記憶域で使用されている領域を解放します。

function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

パラメーター

offset

number

contentLength

number

options

FileClearRangeOptions

[ファイルのクリア範囲] 操作のオプション。

戻り値

Promise<FileUploadRangeResponse>

create(number, FileCreateOptions)

新しいファイルを作成するか、ファイルを置き換えます。 これは、コンテンツを含まないファイルのみを初期化します。

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

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

パラメーター

size

number

ファイルの最大サイズ (最大 4 TB) をバイト単位で指定します。

options

FileCreateOptions

[ファイルの作成] 操作のオプション。

戻り値

Promise<FileCreateResponse>

ファイル作成操作の応答データ。

使用例:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

delete(FileDeleteOptions)

ストレージ アカウントからファイルを削除します。 正常に削除されたファイルは、その時点でストレージ アカウントのインデックスから削除され、クライアントからアクセスできなくなります。 ファイルのデータは、後でガベージ コレクション中にサービスから削除されます。

ファイルが SMB クライアントで開かれている場合、ファイルの削除は状態コード 409 (競合) とエラー コード SharingViolation で失敗します。

共有スナップショット (共有の読み取り専用コピー) では、ファイルの削除はサポートされていません。 共有スナップショットでこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します

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

function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

パラメーター

options

FileDeleteOptions

[ファイルの削除] 操作のオプション。

戻り値

Promise<FileDeleteResponse>

ファイル削除操作の応答データ。

deleteIfExists(FileDeleteOptions)

ストレージ アカウントが存在する場合は、ストレージ アカウントからファイルを削除します。 正常に削除されたファイルは、その時点でストレージ アカウントのインデックスから削除され、クライアントからアクセスできなくなります。 ファイルのデータは、後でガベージ コレクション中にサービスから削除されます。

ファイルが SMB クライアントで開かれている場合、ファイルの削除は状態コード 409 (競合) とエラー コード SharingViolation で失敗します。

共有スナップショット (共有の読み取り専用コピー) では、ファイルの削除はサポートされていません。 共有スナップショットでこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します

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

function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>

パラメーター

options

FileDeleteOptions

戻り値

Promise<FileDeleteIfExistsResponse>

download(number, number, FileDownloadOptions)

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

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

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

function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

パラメーター

offset

number

ダウンロードするファイルの位置 (0 以上)

count

number

ダウンロードするデータの量 (0 より大きい)。 未定義の場合、末尾にダウンロードされます

options

FileDownloadOptions

[ファイルのダウンロード] 操作のオプション。

戻り値

Promise<FileDownloadResponseModel>

ファイルのダウンロード操作の応答データ。

使用例 (Node.js):

// Download a file to a string
const downloadFileResponse = await fileClient.download();
console.log(
  "Downloaded file content:",
  (await streamToBuffer(downloadFileResponse.readableStreamBody)).toString()}
);

// A helper method used to read a Node.js readable stream into string
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 a file to a string
const downloadFileResponse = await fileClient.download(0);
console.log(
  "Downloaded file content:",
  await blobToString(await downloadFileResponse.blobBody)}
);

// A helper method used to convert a browser Blob into string.
export 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);
  });
}

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

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

バッファーに並列で Azure ファイルをダウンロードします。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体をダウンロードします。

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

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

パラメーター

buffer

Buffer

バッファーが埋められるには、count より大きい長さが必要です

offset

number

ダウンロードする Azure ファイルの場所

count

number

ダウンロードするデータの量。 undefined を渡すときに最後にダウンロードされます

options

FileDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToBuffer(number, number, FileDownloadToBufferOptions)

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

バッファーに並列で Azure ファイルをダウンロードします。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体をダウンロードします

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

function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

パラメーター

offset

number

ダウンロードする Azure ファイルの場所

count

number

ダウンロードするデータの量。 undefined を渡すときに最後にダウンロードされます

options

FileDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToFile(string, number, number, FileDownloadOptions)

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

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

パラメーター

filePath

string

offset

number

ダウンロードするブロック BLOB の位置。

count

number

ダウンロードするデータの量。 undefined を渡すと、最後までダウンロードされます。

options

FileDownloadOptions

BLOB ダウンロード オプションのオプション。

戻り値

Promise<FileDownloadResponseModel>

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

exists(FileExistsOptions)

指定したファイルが存在する場合は true を返します。それ以外の場合は false。

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

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

パラメーター

options

FileExistsOptions

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

戻り値

Promise<boolean>

forceCloseAllHandles(FileForceCloseHandlesOptions)

ファイルのすべてのハンドルを強制的に閉じます。

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

function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

パラメーター

options

FileForceCloseHandlesOptions

ハンドルを強制的に閉じる操作を行うオプション。

戻り値

Promise<CloseHandlesInfo>

forceCloseHandle(string, FileForceCloseHandlesOptions)

ファイルの特定のハンドルを強制的に閉じます。

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

function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

パラメーター

handleId

string

特定のハンドル ID。アスタリスク "*" にすることはできません。 forceCloseAllHandles() を使用して、すべてのハンドルを閉じます。

options

FileForceCloseHandlesOptions

戻り値

Promise<FileForceCloseHandlesResponse>

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): string

パラメーター

options

FileGenerateSasUrlOptions

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

戻り値

string

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

getProperties(FileGetPropertiesOptions)

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

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

function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

パラメーター

options

FileGetPropertiesOptions

[ファイルのプロパティの取得] 操作のオプション。

戻り値

Promise<FileGetPropertiesResponse>

[ファイルのプロパティの取得] 操作の応答データ。

getRangeList(FileGetRangeListOptions)

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

function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

パラメーター

options

FileGetRangeListOptions

[File Get range List]\(範囲リストの取得\) 操作のオプション。

戻り値

Promise<FileGetRangeListResponse>

getRangeListDiff(string, FileGetRangeListOptions)

以前の共有スナップショットとこのファイルの間で異なる範囲の一覧を返します。

function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>

パラメーター

prevShareSnapshot

string

前のスナップショット パラメーターは、比較対象の以前の共有スナップショットを指定する不透明な DateTime 値です。

options

FileGetRangeListOptions

戻り値

Promise<FileGetRangeListDiffResponse>

getShareLeaseClient(string)

ファイルのリースを管理する ShareLeaseClient を取得します。

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

パラメーター

proposeLeaseId

string

最初に提案されたリース ID。

戻り値

ShareLeaseClient

ファイルのリースを管理するための新しい ShareLeaseClient オブジェクト。

listHandles(FileListHandlesOptions)

すべてのハンドルを一覧表示する非同期反復可能反復子を返します。 指定したアカウントの下。

.byPage() は、ページ内のハンドルを一覧表示する非同期反復可能反復子を返します。

function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

パラメーター

options

FileListHandlesOptions

ハンドル操作を一覧表示するオプション。

ページングをサポートする asyncIterableIterator。

戻り値

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

rename(string, FileRenameOptions)

ファイル名を変更します。 この API では、同じ共有内のファイルの名前変更のみがサポートされます。

function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

パラメーター

destinationPath

string

名前を変更する宛先パスを指定します。 パスは、URL に配置して宛先を指定するようにエンコードされます。

options

FileRenameOptions

名前変更操作のオプション。

戻り値

Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

ファイル名変更操作の応答データ。

使用例:

// Rename the file
await fileClient.rename(destinationPath);
console.log("Renamed file successfully!");

resize(number, FileResizeOptions)

ファイルのサイズを変更します。

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

function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

パラメーター

length

number

ファイルのサイズを指定したサイズ (バイト単位) に変更します。 指定したバイト値が現在のファイル サイズ未満の場合、指定したバイト値を超える範囲はすべてクリアされます。

options

FileResizeOptions

[ファイルのサイズ変更] 操作のオプション。

戻り値

Promise<FileSetHTTPHeadersResponse>

ファイル セット HTTP ヘッダー操作の応答データ。

setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)

ファイルに HTTP ヘッダーを設定します。

オプションが指定されていない場合、またはオプション内のファイル HTTP ヘッダーに値が指定されていない場合は、値のないこれらのファイル HTTP ヘッダーがクリアされます。

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

function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

パラメーター

fileHttpHeaders

FileHttpHeaders

options

FileSetHttpHeadersOptions

ファイル セット HTTP ヘッダー操作のオプション。

戻り値

Promise<FileSetHTTPHeadersResponse>

ファイル セット HTTP ヘッダー操作の応答データ。

setMetadata(Metadata, FileSetMetadataOptions)

指定したファイルのユーザー定義メタデータを更新します。

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

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

function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

パラメーター

metadata

Metadata

メタデータが指定されていない場合、既存のすべてのディレクトリ メタデータが削除されます

options

FileSetMetadataOptions

[ファイル セット メタデータ] 操作のオプション。

戻り値

Promise<FileSetMetadataResponse>

ファイル セット メタデータ操作の応答データ。

setProperties(FileProperties)

ファイルのプロパティを設定します。

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

function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

パラメーター

properties

FileProperties

ファイルのプロパティ。 ファイル HTTP ヘッダー (Content-Type など) の場合、値が指定されていない場合は、既存の HTTP ヘッダーが削除されます。 他のファイル プロパティ (fileAttributes など) の場合、値が指定されていない場合は、既存の値が保持されます。

戻り値

Promise<SetPropertiesResponse>

startCopyFromURL(string, FileStartCopyOptions)

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

function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

パラメーター

copySource

string

ソース ファイルまたは BLOB の URL (最大 2 KB) を指定します。 同じストレージ アカウント内の別のファイルにファイルをコピーするには、共有キーを使用してソース ファイルを認証できます。 別のストレージ アカウントからファイルをコピーする場合、または同じストレージ アカウントまたは別のストレージ アカウントから BLOB をコピーする場合は、共有アクセス署名を使用してソース ファイルまたは BLOB を認証する必要があります。 ソースがパブリック BLOB の場合、コピー操作を実行するために認証は必要ありません。 共有スナップショット内のファイルをコピー ソースとして指定することもできます。

options

FileStartCopyOptions

[ファイルのコピー開始] 操作のオプション。

戻り値

Promise<FileStartCopyResponse>

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

新しい Azure ファイルを作成するか、既存の Azure ファイルを置き換えてから、Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView をアップロードします。

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

パラメーター

data

Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node)、Blob、ArrayBuffer、ArrayBufferView

options

FileParallelUploadOptions

戻り値

Promise<void>

uploadFile(string, FileParallelUploadOptions)

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

新しい Azure ファイルを作成するか、既存の Azure ファイルを置き換えてから、ローカル ファイルをアップロードします。

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

パラメーター

filePath

string

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

options

FileParallelUploadOptions

戻り値

Promise<void>

uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)

ファイルにバイト範囲をアップロードします。 この操作は、既存のファイルに対してのみ呼び出すことができます。 ファイルのサイズ、プロパティ、メタデータは変更されません。 範囲の開始とカウントの両方を指定する必要があります。 範囲のサイズは最大 4 MB です。

function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

パラメーター

body

HttpRequestBody

BLOB、string、ArrayBuffer、ArrayBufferView、またはデータ ソースの先頭からのオフセットを持つ新しい読み取り可能ストリームを返す関数。

offset

number

アップロード先の Azure File のオフセット位置。

contentLength

number

本文の長さ (バイト単位)。 Buffer.byteLength() を使用して、Base64/Hex 以外のエンコード文字を含む文字列の本文の長さを計算します。

options

FileUploadRangeOptions

[ファイルのアップロード範囲] 操作のオプション。

戻り値

Promise<FileUploadRangeResponse>

ファイルのアップロード範囲操作の応答データ。

使用例:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)

別のファイルの URL から内容が読み取られたファイルにバイト範囲をアップロードします。 範囲のサイズは最大 4 MB です。

function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

パラメーター

sourceURL

string

コピー ソースの URL (認証に必要な Shared Access Signature(SAS) を指定します。

sourceOffset

number

コピー元のソース オフセット。 ソース ファイルの先頭からコピーするには、0 を渡します。

destOffset

number

コピー先ファイルのオフセット。

count

number

ソース ファイルからアップロードされるバイト数。

options

FileUploadRangeFromURLOptions

[ファイル] - [URL からの範囲のアップロード] 操作を構成するためのオプション。

戻り値

Promise<FileUploadRangeFromURLResponse>

uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)

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

読み取り可能なストリーム ファクトリ Node.js を受け入れ、ブロック単位で Azure ファイルにアップロードします。 読み取り可能ストリーム ファクトリは、定義されたオフセットから開始 Node.js 読み取り可能ストリームを返す必要があります。 オフセットは、アップロードする Azure ファイル内のオフセットです。

function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>

パラメーター

streamFactory

(offset: number, count?: number) => ReadableStream

定義されたオフセットから開始 Node.js 読み取り可能ストリームを返します。

size

number

Azure ファイルのサイズ

options

FileParallelUploadOptions

戻り値

Promise<void>

uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)

ブラウザーでのみ使用できます。

ブラウザー BLOB オブジェクトを Azure ファイルにアップロードします。 データ ソースとして blobFactory が必要です。これは、指定されたオフセットとサイズを持つ BLOB オブジェクトを返す必要があります。

function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>

パラメーター

blobFactory

(offset: number, size: number) => Blob

size

number

options

FileParallelUploadOptions

戻り値

Promise<void>

uploadStream(Readable, number, number, number, FileUploadStreamOptions)

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

新しい Azure File を作成するか、既存の Azure ファイルを置き換えてから、Node.js 読み取り可能ストリームをアップロードします。 このメソッドは、Azure File の作成を試み、チャンクごとにチャンクのアップロードを開始します。 チャンクのサイズはパラメーターによって定義されます bufferSize 。 ストリームの潜在的なサイズがファイル サイズを超えないようにしてください。

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

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

function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

パラメーター

stream

Readable

読み取り可能ストリームを Node.js します。 ファイル サイズ以下である必要があります。

size

number

作成するファイルのサイズ。 使用できる最大サイズは 4 TB です。 この値がストリーム サイズより大きい場合は、ファイル末尾に空のバイトが存在します。

bufferSize

number

バイト単位で割り当てられたすべてのバッファーのサイズ。また、アップロードされたファイル中のチャンク/範囲のサイズ。 サイズは 0 より大きく、4 * 1024 * 1024 (4 MB) 以下である必要があります

maxBuffers

number

最大バッファーはアップロード中に割り当てられます。最大アップロードコンカレンシーとの正の相関関係

options

FileUploadStreamOptions

戻り値

Promise<void>

withShareSnapshot(string)

ソースと同じ、指定された共有スナップショット タイムスタンプを持つ新しい ShareFileClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、ベースの ShareFileClient への URL が返されます。

function withShareSnapshot(shareSnapshot: string): ShareFileClient

パラメーター

shareSnapshot

string

共有スナップショットのタイムスタンプ。

戻り値

ShareFileClient

ソースと同じが、指定された共有スナップショット タイムスタンプを持つ新しい ShareFileClient オブジェクト。