BlockBlobClient class

リファレンス

パッケージ:: @azure/storage-blob

BlockBlobClient は、ブロック BLOB に適用できる一連の操作を定義します。

Extends: BlobClient

コンストラクター

BlockBlobClient(string, PipelineLike)	BlockBlobClient のインスタンスを作成します。このメソッドは、ブロック BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 BLOB 名にが含まれている場合は ? または %、BLOB 名は URL でエンコードする必要があります。
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	BlockBlobClient のインスタンスを作成します。このメソッドは、ブロック BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 BLOB 名にが含まれている場合は ? または %、BLOB 名は URL でエンコードする必要があります。
BlockBlobClient(string, string, string, StoragePipelineOptions)	BlockBlobClient のインスタンスを作成します。

プロパティ

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

メソッド

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	保留中の非同期コピー BLOB 操作を中止し、コピー先 BLOB の長さと完全なメタデータを残します。バージョン 2012-02-12 以降。
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	ストレージアカウント内の宛先に BLOB を非同期にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングャーを返します。投票者でを呼び出 `cancelOperation` すことで、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとすると、onProgress コールバックは呼び出されないことに注意してください。エラーがスローされます。バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントのコミット済み BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージアカウントについてのみ、Copy Blob 操作による他のストレージアカウントからのコピーが許可されています。
commitBlockList(string[], BlockBlobCommitBlockListOptions)	BLOB を構成するブロック ID の一覧を指定することによって BLOB を書き込みます。ブロックを BLOB の一部として書き込むには、その前の <xref:stageBlock> 操作でブロックがサーバーに正常に書き込まれている必要があります。 <xref:commitBlockList> を呼び出して、変更されたブロックのみをアップロードし、新規と既存のブロックを共にコミットすることによって BLOB を更新できます。ブロックリストで指定されておらず、完全に削除されたブロック。
createSnapshot(BlobCreateSnapshotOptions)	BLOB の読み取り専用のスナップショットを作成します。
delete(BlobDeleteOptions)	指定した BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。
deleteIfExists(BlobDeleteOptions)	指定した BLOB またはスナップショットが存在する場合は、削除対象としてマークします。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	BLOB の不変ポリシーを削除します。
download(number, number, BlobDownloadOptions)	メタデータとプロパティを含め、システムから BLOB を読み取るかダウンロードします。 Get Blob を呼び出してスナップショットを読み取ることもできます。 Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されますブラウザーでは、promise blobBody でデータが返されます
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きい BLOB の場合は、を検討してください <xref:downloadToFile>。
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きい BLOB の場合は、を検討してください <xref:downloadToFile>。
downloadToFile(string, number, number, BlobDownloadOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をローカルファイルにダウンロードします。指定されたファイルパスが既に終了している場合、失敗します。オフセットとカウントは省略可能で、それぞれ 0 と undefined を渡して BLOB 全体をダウンロードします。
exists(BlobExistsOptions)	このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。注: 既存の BLOB は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も同様に、この関数の完了後に他のクライアントまたはアプリケーションによって新しい BLOB が追加される場合があります。
generateSasUrl(BlobGenerateSasUrlOptions)	共有キー資格情報を使用して構築された BlobClient でのみ使用できます。渡されたクライアントのプロパティとパラメーターに基づいて、BLOB サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。
getAppendBlobClient()	AppendBlobClient オブジェクトを作成します。
getBlobLeaseClient(string)	BLOB の <xref:BlobLeaseClient> リースを管理するを取得します。
getBlockBlobClient()	BlockBlobClient オブジェクトを作成します。
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	指定したブロックリストフィルターを使用して、ブロック BLOB の一部としてアップロードされたブロックの一覧を返します。
getPageBlobClient()	PageBlobClient オブジェクトを作成します。
getProperties(BlobGetPropertiesOptions)	BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステムプロパティを返します。 BLOB のコンテンツは返しません。
getTags(BlobGetTagsOptions)	基になる BLOB に関連付けられているタグを取得します。
query(string, BlockBlobQueryOptions)	NODE.JSランタイムでのみ使用できます。 JSON または CSV 形式の BLOB のクイッククエリ。使用例 (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob 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); }); }
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	BLOB の層を設定します。操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージアカウント内のブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。ブロック BLOB の層によって、ホット/クール/アーカイブストレージの種類が決まります。この操作では、BLOB の ETag は更新されません。
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	BLOB のシステムプロパティを設定します。値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	BLOB に不変ポリシーを設定します。
setLegalHold(boolean, BlobSetLegalHoldOptions)	BLOB に訴訟ホールドを設定します。
setMetadata(Metadata, BlobSetMetadataOptions)	1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。
setTags(Tags, BlobSetTagsOptions)	基になる BLOB にタグを設定します。 BLOB には最大 10 個のタグを含めることができます。タグキーは 1 ~ 128 文字にする必要があります。タグの値は 0 ~ 256 文字にする必要があります。有効なタグキーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース ('')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)	指定したブロックをブロック BLOB の "ステージング領域" にアップロードし、後で commitBlockList の呼び出しによってコミットされるようにします。
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	STAGE Block From URL 操作では、コンテンツが URL から読み取られる BLOB の一部としてコミットされる新しいブロックが作成されます。この API は、バージョン 2018-03-28 以降で使用できます。
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	同期コピー元 URL 操作は、BLOB またはインターネットリソースを新しい BLOB にコピーします。コピーが完了するまで応答は返されません。
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	BLOB の内容が特定の URL から読み取られた新しいブロック BLOB を作成します。この API は、2020-04-08 バージョン以降でサポートされています。 URL からの PUT BLOB では、部分的な更新はサポートされていません。既存の BLOB の内容は、新しい BLOB の内容で上書きされます。ソース URL を使用してブロック BLOB のコンテンツの部分的な更新を実行するには、とを使用 <xref:stageBlockFromURL> します <xref:commitBlockList>。
undelete(BlobUndeleteOptions)	論理的に削除された BLOB および関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。 BLOB の削除の取り消しは、バージョン 2017-07-29 以降でのみサポートされています。
upload(HttpRequestBody, number, BlockBlobUploadOptions)	新しいブロック BLOB を作成するか、既存のブロック BLOB の内容を更新します。既存のブロック BLOB を更新すると、BLOB の既存のメタデータは上書きされます。部分的な更新はサポートされていません。既存の BLOB のコンテンツは、新しいコンテンツで上書きされます。ブロック BLOB の部分的な更新を実行するには、とを使用 <xref:stageBlock> します <xref:commitBlockList>。これは、並列以外のアップロード方法です。コンカレンシーアップロードのパフォーマンスを向上させるには、を <xref:uploadStream><xref:uploadBrowserData>使用<xref:uploadFile>してください。
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	ブラウザーでのみ使用できます。ブラウザー Blob/File/ArrayBuffer/ArrayBufferView オブジェクトをアップロードして BLOB をブロックします。バッファー長が 256 MB 以下の場合、このメソッドは 1 回のアップロード呼び出しを使用してアップロードを完了します。それ以外の場合、このメソッドはを呼び出 <xref:stageBlock> してブロックをアップロードし、最後にを呼び出 <xref:commitBlockList> してブロックリストをコミットします。を設定する一般的な <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> オプションはです `blobContentType`。これにより、ブラウザーはファイルの種類に基づいて機能を提供できます。
uploadData(Buffer \| Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView オブジェクトを BlockBlob にアップロードします。データの長さが specifiled <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (既定値は ) 以下の場合、 <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>このメソッドは 1 回 <xref:upload> の呼び出しを使用してアップロードを完了します。それ以外の場合、このメソッドはを呼び出 <xref:stageBlock> してブロックをアップロードし、最後にを呼び出 <xref:commitBlockList> してブロックリストをコミットします。を設定する一般的な <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> オプションはです `blobContentType`。これにより、ブラウザーはファイルの種類に基づいて機能を提供できます。
uploadFile(string, BlockBlobParallelUploadOptions)	NODE.JSランタイムでのみ使用できます。ブロック内のローカルファイルをブロック BLOB にアップロードします。ファイルサイズが 256 MB 以下の場合、このメソッドは 1 回のアップロード呼び出しを使用してアップロードを完了します。それ以外の場合、このメソッドは stageBlock を呼び出してブロックをアップロードし、最後に commitBlockList を呼び出してブロックリストをコミットします。
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	NODE.JSランタイムでのみ使用できます。 Node.js読み取り可能ストリームをブロック BLOB にアップロードします。パフォーマンス向上のヒント: 入力ストリーム highWaterMark は、bufferSize パラメーターを使用して同じ値を設定することをお勧めします。これにより、Buffer.concat() 操作は回避されます。
withSnapshot(string)	指定したスナップショットタイムスタンプを使用して、ソースと同じ新しい BlockBlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、ベース BLOB の URL が返されます。
withVersion(string)	この BLOB のバージョンを指す新しい BlobClient オブジェクトを作成します。 "" を指定すると、versionId が削除され、クライアントがベース BLOB に返されます。

コンストラクターの詳細

BlockBlobClient(string, PipelineLike)

BlockBlobClient のインスタンスを作成します。このメソッドは、ブロック BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 BLOB 名にが含まれている場合は ? または %、BLOB 名は URL でエンコードする必要があります。

new BlockBlobClient(url: string, pipeline: PipelineLike)

パラメーター

url: string

"https://myaccount.blob.core.windows.net/mycontainer/blockblob" など、Azure Storage ブロック BLOB を指す URL 文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString")。このメソッドは、BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。ただし、BLOB 名にが含まれている場合は。または %、BLOB 名は URL でエンコードする必要があります。 "my?blob%" という名前の BLOB など、URL は "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" である必要があります。

pipeline: PipelineLike

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

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

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

パラメーター

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

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

BlockBlobClient(string, string, string, StoragePipelineOptions)

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

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

パラメーター

connectionString: string

アカウント接続文字列または Azure ストレージアカウントの SAS 接続文字列。 [ 注 - アカウント接続文字列は、NODE.JSランタイムでのみ使用できます。 ] アカウント接続文字列の例 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS 接続文字列の例 - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

コンテナー名。

blobName: string

BLOB 名。

options: StoragePipelineOptions

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

プロパティの詳細

accountName

accountName: string

プロパティ値

string

containerName

BLOB が関連付けられているストレージコンテナーの名前。

string containerName

プロパティ値

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

BLOB の名前です。

string name

プロパティ値

string

url

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

url: string

プロパティ値

string

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

保留中の非同期コピー BLOB 操作を中止し、コピー先 BLOB の長さと完全なメタデータを残します。バージョン 2012-02-12 以降。

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

パラメーター

copyId: string

コピー元 URL 操作の ID。

options: BlobAbortCopyFromURLOptions

BLOB の URL からのコピーの中止操作のオプション。

戻り値

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

ストレージアカウント内の宛先に BLOB を非同期にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングャーを返します。投票者でを呼び出 cancelOperation すことで、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとすると、onProgress コールバックは呼び出されないことに注意してください。エラーがスローされます。バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントのコミット済み BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージアカウントについてのみ、Copy Blob 操作による他のストレージアカウントからのコピーが許可されています。

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

パラメーター

copySource: string

ソースの Azure Blob/File への URL。

options: BlobBeginCopyFromURLOptions

BLOB のコピー開始 URL 操作のオプション。

戻り値

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

commitBlockList(string[], BlockBlobCommitBlockListOptions)

BLOB を構成するブロック ID の一覧を指定することによって BLOB を書き込みます。ブロックを BLOB の一部として書き込むには、その前の <xref:stageBlock> 操作でブロックがサーバーに正常に書き込まれている必要があります。 <xref:commitBlockList> を呼び出して、変更されたブロックのみをアップロードし、新規と既存のブロックを共にコミットすることによって BLOB を更新できます。ブロックリストで指定されておらず、完全に削除されたブロック。

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

パラメーター

blocks: string[]

base64 でエンコードされた 64 バイト値の配列

options: BlockBlobCommitBlockListOptions

ブロック BLOB コミットブロックリスト操作のオプション。

戻り値

Promise<BlockBlobCommitBlockListResponse>

ブロック BLOB コミットブロックリスト操作の応答データ。

createSnapshot(BlobCreateSnapshotOptions)

BLOB の読み取り専用のスナップショットを作成します。

function createSnapshot(options?: BlobCreateSnapshotOptions)

パラメーター

options: BlobCreateSnapshotOptions

BLOB スナップショット作成操作のオプション。

戻り値

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

指定した BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。

function delete(options?: BlobDeleteOptions)

パラメーター

options: BlobDeleteOptions

BLOB 削除操作のオプション。

戻り値

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

指定した BLOB またはスナップショットが存在する場合は、削除対象としてマークします。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。

function deleteIfExists(options?: BlobDeleteOptions)

パラメーター

options: BlobDeleteOptions

BLOB 削除操作のオプション。

戻り値

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

BLOB の不変ポリシーを削除します。

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

パラメーター

options: BlobDeleteImmutabilityPolicyOptions

BLOB の不変ポリシーを削除するオプション。

戻り値

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

メタデータとプロパティを含め、システムから BLOB を読み取るかダウンロードします。 Get Blob を呼び出してスナップショットを読み取ることもできます。

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

パラメーター

offset: number

ダウンロードする BLOB の位置 (0 以上)

count: number

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

options: BlobDownloadOptions

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

使用例 (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob 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 blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob 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);
  });
}

戻り値

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

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

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

パラメーター

buffer: Buffer

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

offset: number

ダウンロードするブロック BLOB の位置 (バイト単位)

count: number

ダウンロードするデータの量 (バイト単位)。未定義を渡すときに末尾にダウンロードされます

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

パラメーター

offset: number

ダウンロードするブロック BLOB の位置 (バイト単位)

count: number

ダウンロードするデータの量 (バイト単位)。未定義を渡すときに末尾にダウンロードされます

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

パラメーター

filePath: string

offset: number

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

count: number

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

options: BlobDownloadOptions

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

戻り値

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

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

function exists(options?: BlobExistsOptions)

パラメーター

options: BlobExistsOptions

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

戻り値

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

パラメーター

options: BlobGenerateSasUrlOptions

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

戻り値

Promise<string>

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

getAppendBlobClient()

AppendBlobClient オブジェクトを作成します。

function getAppendBlobClient()

戻り値

AppendBlobClient

getBlobLeaseClient(string)

BLOB の <xref:BlobLeaseClient> リースを管理するを取得します。

function getBlobLeaseClient(proposeLeaseId?: string)

パラメーター

proposeLeaseId: string

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

戻り値

BlobLeaseClient

BLOB のリースを管理するための新しい BlobLeaseClient オブジェクト。

getBlockBlobClient()

BlockBlobClient オブジェクトを作成します。

function getBlockBlobClient()

戻り値

BlockBlobClient

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

指定したブロックリストフィルターを使用して、ブロック BLOB の一部としてアップロードされたブロックの一覧を返します。

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

パラメーター

listType: BlockListType

コミット後のブロックの一覧、コミット前のブロック一覧、または両方の一覧のいずれを返すかを指定します。

options: BlockBlobGetBlockListOptions

ブロック BLOB のブロックリストの取得操作のオプション。

戻り値

Promise<BlockBlobGetBlockListResponse>

ブロック BLOB のブロックリスト取得操作の応答データ。

getPageBlobClient()

PageBlobClient オブジェクトを作成します。

function getPageBlobClient()

戻り値

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

パラメーター

options: BlobGetPropertiesOptions

プロパティの取得操作のオプション。

戻り値

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

基になる BLOB に関連付けられているタグを取得します。

function getTags(options?: BlobGetTagsOptions)

パラメーター

options: BlobGetTagsOptions

戻り値

Promise<BlobGetTagsResponse>

query(string, BlockBlobQueryOptions)

NODE.JSランタイムでのみ使用できます。 JSON または CSV 形式の BLOB のクイッククエリ。

使用例 (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob 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?: BlockBlobQueryOptions)

パラメーター

query: string

options: BlockBlobQueryOptions

戻り値

Promise<BlobDownloadResponseModel>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

BLOB の層を設定します。操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージアカウント内のブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。ブロック BLOB の層によって、ホット/クール/アーカイブストレージの種類が決まります。この操作では、BLOB の ETag は更新されません。

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

パラメーター

tier: BlockBlobTier | PremiumPageBlobTier | string

BLOB に設定する層。有効な値は、ホット、クール、またはアーカイブです。

options: BlobSetTierOptions

BLOB セット層操作のオプション。

戻り値

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

BLOB のシステムプロパティを設定します。値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

パラメーター

blobHTTPHeaders: BlobHTTPHeaders

値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。設定する一般的なヘッダーは、 blobContentType ブラウザーがファイルの種類に基づいて機能を提供できるようにすることです。

options: BlobSetHTTPHeadersOptions

BLOB セット HTTP ヘッダー操作のオプション。

戻り値

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

BLOB に不変ポリシーを設定します。

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

パラメーター

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

BLOB に不変性ポリシーを設定するためのオプション。

戻り値

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

BLOB に訴訟ホールドを設定します。

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

パラメーター

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

BLOB に訴訟ホールドを設定するためのオプション。

戻り値

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

パラメーター

metadata: Metadata

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

options: BlobSetMetadataOptions

メタデータの設定操作のオプション。

戻り値

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

基になる BLOB にタグを設定します。 BLOB には最大 10 個のタグを含めることができます。タグキーは 1 ~ 128 文字にする必要があります。タグの値は 0 ~ 256 文字にする必要があります。有効なタグキーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース ('')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。

function setTags(tags: Tags, options?: BlobSetTagsOptions)

パラメーター

tags: Tags

options: BlobSetTagsOptions

戻り値

Promise<BlobSetTagsResponse>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

指定したブロックをブロック BLOB の "ステージング領域" にアップロードし、後で commitBlockList の呼び出しによってコミットされるようにします。

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

パラメーター

blockId: string

base64 でエンコードされた 64 バイトの値

body: HttpRequestBody

ステージング領域にアップロードするデータ。

contentLength: number

アップロードするバイト数。

options: BlockBlobStageBlockOptions

ブロック BLOB ステージブロック操作のオプション。

戻り値

Promise<BlockBlobStageBlockResponse>

ブロック BLOB ステージブロック操作の応答データ。

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

STAGE Block From URL 操作では、コンテンツが URL から読み取られる BLOB の一部としてコミットされる新しいブロックが作成されます。この API は、バージョン 2018-03-28 以降で使用できます。

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

パラメーター

blockId: string

base64 でエンコードされた 64 バイトの値

sourceURL: string

BLOB の URL を指定します。値には、BLOB を指定する最大 2 KB の長さの URL を指定できます。この値は要求 URI に含まれるため、URL でエンコードされる必要があります。ソース BLOB はパブリックであるか、共有アクセス署名を介して認証される必要があります。ソース BLOB がパブリックの場合、操作を実行するために認証は必要ありません。ソースオブジェクト URL の例をいくつか次に示します。 https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

ダウンロードする BLOB の位置 (0 以上)

count: number

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

options: BlockBlobStageBlockFromURLOptions

ブロック BLOB ステージブロックの URL 操作のオプション。

戻り値

Promise<BlockBlobStageBlockFromURLResponse>

ブロック BLOB ステージの URL からのブロック操作の応答データ。

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

同期コピー元 URL 操作は、BLOB またはインターネットリソースを新しい BLOB にコピーします。コピーが完了するまで応答は返されません。

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

パラメーター

copySource: string

コピー元のソース URL(Shared Access Signature(SAS) が認証に必要な場合があります

options: BlobSyncCopyFromURLOptions

戻り値

Promise<BlobCopyFromURLResponse>

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

BLOB の内容が特定の URL から読み取られた新しいブロック BLOB を作成します。この API は、2020-04-08 バージョン以降でサポートされています。 URL からの PUT BLOB では、部分的な更新はサポートされていません。既存の BLOB の内容は、新しい BLOB の内容で上書きされます。ソース URL を使用してブロック BLOB のコンテンツの部分的な更新を実行するには、とを使用 <xref:stageBlockFromURL> します <xref:commitBlockList>。

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

パラメーター

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

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

戻り値

Promise<BlockBlobPutBlobFromUrlResponse>

undelete(BlobUndeleteOptions)

論理的に削除された BLOB および関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。 BLOB の削除の取り消しは、バージョン 2017-07-29 以降でのみサポートされています。

function undelete(options?: BlobUndeleteOptions)

パラメーター

options: BlobUndeleteOptions

Blob Undelete 操作のオプション。

戻り値

Promise<BlobUndeleteResponse>

upload(HttpRequestBody, number, BlockBlobUploadOptions)

新しいブロック BLOB を作成するか、既存のブロック BLOB の内容を更新します。既存のブロック BLOB を更新すると、BLOB の既存のメタデータは上書きされます。部分的な更新はサポートされていません。既存の BLOB のコンテンツは、新しいコンテンツで上書きされます。ブロック BLOB の部分的な更新を実行するには、とを使用 <xref:stageBlock> します <xref:commitBlockList>。これは、並列以外のアップロード方法です。コンカレンシーアップロードのパフォーマンスを向上させるには、を <xref:uploadStream><xref:uploadBrowserData>使用<xref:uploadFile>してください。

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

パラメーター

body: HttpRequestBody

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

contentLength: number

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

options: BlockBlobUploadOptions

ブロック BLOB アップロード操作のオプション。

戻り値

Promise<BlockBlobUploadResponse>

ブロック BLOB アップロード操作の応答データ。

使用例:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

警告

この API は非推奨になりました。

Use <xref:uploadData> instead.

ブラウザーでのみ使用できます。ブラウザー Blob/File/ArrayBuffer/ArrayBufferView オブジェクトをアップロードして BLOB をブロックします。

バッファー長が 256 MB 以下の場合、このメソッドは 1 回のアップロード呼び出しを使用してアップロードを完了します。それ以外の場合、このメソッドはを呼び出 <xref:stageBlock> してブロックをアップロードし、最後にを呼び出 <xref:commitBlockList> してブロックリストをコミットします。

を設定する一般的な <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> オプションはです blobContentType。これにより、ブラウザーはファイルの種類に基づいて機能を提供できます。

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

パラメーター

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob、File、ArrayBuffer、または ArrayBufferView

options: BlockBlobParallelUploadOptions

ブラウザーデータをアップロードするオプション。

戻り値

Promise<BlobUploadCommonResponse>

BLOB アップロード操作の応答データ。

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

Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView オブジェクトを BlockBlob にアップロードします。データの長さが specifiled <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (既定値は ) 以下の場合、 <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>このメソッドは 1 回 <xref:upload> の呼び出しを使用してアップロードを完了します。それ以外の場合、このメソッドはを呼び出 <xref:stageBlock> してブロックをアップロードし、最後にを呼び出 <xref:commitBlockList> してブロックリストをコミットします。

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

パラメーター

data: Buffer | Blob | ArrayBuffer | ArrayBufferView

Buffer(Node.js)、Blob、ArrayBuffer、または ArrayBufferView

options: BlockBlobParallelUploadOptions

戻り値

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

NODE.JSランタイムでのみ使用できます。ブロック内のローカルファイルをブロック BLOB にアップロードします。

ファイルサイズが 256 MB 以下の場合、このメソッドは 1 回のアップロード呼び出しを使用してアップロードを完了します。それ以外の場合、このメソッドは stageBlock を呼び出してブロックをアップロードし、最後に commitBlockList を呼び出してブロックリストをコミットします。

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

パラメーター

filePath: string

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

options: BlockBlobParallelUploadOptions

ブロック BLOB 操作にアップロードするオプション。

戻り値

Promise<BlobUploadCommonResponse>

BLOB アップロード操作の応答データ。

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

NODE.JSランタイムでのみ使用できます。 Node.js読み取り可能ストリームをブロック BLOB にアップロードします。

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

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

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

パラメーター

stream: Readable

読み取り可能ストリームのNode.js

bufferSize: number

割り当てられたすべてのバッファーのサイズ。アップロードされたブロック BLOB のブロックサイズも指定します。既定値は 8 MB です

maxConcurrency: number

最大コンカレンシーは、割り当て可能なバッファーの最大数を示し、最大アップロードコンカレンシーとの正の相関関係を示します。既定値は 5 です

options: BlockBlobUploadStreamOptions

ブロック BLOB へのストリームのアップロード操作のオプション。

戻り値

Promise<BlobUploadCommonResponse>

BLOB アップロード操作の応答データ。

withSnapshot(string)

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

function withSnapshot(snapshot: string)

パラメーター

snapshot: string

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

戻り値

BlockBlobClient

新しい BlockBlobClient オブジェクトは、ソースと同じですが、指定されたスナップショットタイムスタンプを持ちます。

withVersion(string)

この BLOB のバージョンを指す新しい BlobClient オブジェクトを作成します。 "" を指定すると、versionId が削除され、クライアントがベース BLOB に返されます。

function withVersion(versionId: string)

パラメーター

versionId: string

versionId。

戻り値

BlobClient

この BLOB のバージョンを指す新しい BlobClient オブジェクト。

次の方法で共有

BlockBlobClient class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

BlockBlobClient(string, PipelineLike)

パラメーター

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

パラメーター

BlockBlobClient(string, string, string, StoragePipelineOptions)

パラメーター

プロパティの詳細

accountName

プロパティ値

containerName

プロパティ値

credential

プロパティ値

name

プロパティ値

url

プロパティ値

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

パラメーター

戻り値

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

パラメーター

戻り値

commitBlockList(string[], BlockBlobCommitBlockListOptions)

パラメーター

戻り値

createSnapshot(BlobCreateSnapshotOptions)

パラメーター

戻り値

delete(BlobDeleteOptions)

パラメーター

戻り値

deleteIfExists(BlobDeleteOptions)

パラメーター

戻り値

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

パラメーター

戻り値

download(number, number, BlobDownloadOptions)

パラメーター

戻り値

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

パラメーター

戻り値

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

パラメーター

戻り値

downloadToFile(string, number, number, BlobDownloadOptions)

パラメーター

戻り値

exists(BlobExistsOptions)

パラメーター

戻り値

generateSasUrl(BlobGenerateSasUrlOptions)

パラメーター

戻り値

getAppendBlobClient()

戻り値

getBlobLeaseClient(string)

パラメーター

戻り値

getBlockBlobClient()

戻り値

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

パラメーター

戻り値

getPageBlobClient()

戻り値

getProperties(BlobGetPropertiesOptions)

パラメーター

戻り値

getTags(BlobGetTagsOptions)

パラメーター