BlobClient class

リファレンス

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

BlobClient は、Azure Storage BLOB への URL を表します。BLOB には、ブロック BLOB、追加 BLOB、またはページ BLOB を指定できます。

Extends: StorageClient

コンストラクター

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

プロパティ

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

継承されたプロパティ

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

メソッド

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	保留中の非同期コピー BLOB 操作を中止し、コピー先 BLOB の長さと完全なメタデータを残します。バージョン 2012-02-12 以降。 https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob を参照してください
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	BLOB をストレージアカウント内の宛先に非同期的にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングツールを返します。また、ポーラーで `cancelOperation` を呼び出すことで、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとするとエラーがスローされる場合、onProgress コールバックは呼び出されないことに注意してください。バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントでコミットされた BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 BLOB のコピー操作を別のストレージアカウントからコピーできるのは、2012 年 6 月 7 日以降に作成されたストレージアカウントのみです。 https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob を参照してください自動ポーリングの使用例: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` 手動ポーリングの使用例: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` 進行状況の更新の使用例: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); ポーリング間隔の変更の使用例 (既定では 15 秒): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` コピーの取り消しの使用例: `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	BLOB の読み取り専用スナップショットを作成します。 https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob を参照してください
delete(BlobDeleteOptions)	指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB は後でガベージコレクション中に削除されます。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 BLOB の削除操作では、両方を同時に削除できます。 https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob を参照してください
deleteIfExists(BlobDeleteOptions)	指定した BLOB またはスナップショットが存在する場合は、削除対象としてマークします。 BLOB は後でガベージコレクション中に削除されます。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 BLOB の削除操作では、両方を同時に削除できます。 https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob を参照してください
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	BLOB の不変ポリシーを削除します。
download(number, number, BlobDownloadOptions)	メタデータとプロパティを含め、システムから BLOB を読み取りまたはダウンロードします。 Get BLOB を呼び出してスナップショットを読み取ることもできます。 Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されますブラウザーでは、promise blobBody でデータが返されます https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob を参照してください
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーでサポートできるファイルは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトです。Node.js/V8 の制限があるためです。このサイズより大きい BLOB の場合は、downloadToFile検討してください。
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーでサポートできるファイルは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトです。Node.js/V8 の制限があるためです。このサイズより大きい BLOB の場合は、downloadToFile検討してください。
downloadToFile(string, number, number, BlobDownloadOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をローカルファイルにダウンロードします。指定されたファイルパスが既に終了している場合は失敗します。オフセットとカウントは省略可能で、それぞれ 0 と未定義を渡して BLOB 全体をダウンロードします。
exists(BlobExistsOptions)	このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。注: 既存の BLOB は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しい BLOB が追加される可能性があります。
generateSasStringToSign(BlobGenerateSasUrlOptions)	共有キー資格情報を使用して構築された BlobClient でのみ使用できます。渡されたクライアントのプロパティとパラメーターに基づいて、Blob Service Shared Access Signature (SAS) URI に署名する文字列を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
generateSasUrl(BlobGenerateSasUrlOptions)	共有キー資格情報を使用して構築された BlobClient でのみ使用できます。渡されたクライアントのプロパティとパラメーターに基づいて、BLOB サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
getAccountInfo(BlobGetAccountInfoOptions)	アカウント情報の取得操作は、指定されたアカウントの SKU 名とアカウントの種類を返します。アカウント情報の取得操作は、バージョン 2018-03-28 以降のサービスバージョンで使用できます。 https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information を参照してください
getAppendBlobClient()	AppendBlobClient オブジェクトを作成します。
getBlobLeaseClient(string)	BLOB のリースを管理する BlobLeaseClient を取得します。
getBlockBlobClient()	BlockBlobClient オブジェクトを作成します。
getPageBlobClient()	PageBlobClient オブジェクトを作成します。
getProperties(BlobGetPropertiesOptions)	BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステムプロパティを返します。 BLOB の内容は返されません。 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties を参照してください警告: 応答で返される `metadata` オブジェクトのキーは、最初に大文字が含まれていた場合でも小文字になります。これは、元の大文字と小文字が保持される `includeMetadata` オプションを使用して BLOB を一覧表示 ContainerClient のメソッドによって返されるメタデータキーとは異なります。
getTags(BlobGetTagsOptions)	基になる BLOB に関連付けられているタグを取得します。
setAccessTier(string, BlobSetTierOptions)	BLOB の層を設定します。この操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージアカウント内のブロック BLOB で許可されます (ローカル冗長ストレージのみ)。 Premium ページ BLOB の層によって、BLOB の許可されるサイズ、IOPS、帯域幅が決まります。ブロック BLOB の層によって、ホット/クール/アーカイブストレージの種類が決まります。この操作では、BLOB の ETag は更新されません。 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier を参照してください
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	BLOB のシステムプロパティを設定します。値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties を参照してください
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	BLOB に不変ポリシーを設定します。
setLegalHold(boolean, BlobSetLegalHoldOptions)	BLOB の訴訟ホールドを設定します。
setMetadata(Metadata, BlobSetMetadataOptions)	指定した BLOB のユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata を参照してください
setTags(Tags, BlobSetTagsOptions)	基になる BLOB にタグを設定します。 BLOB には最大 10 個のタグを含めることができます。タグキーは 1 ~ 128 文字にする必要があります。タグの値は、0 ~ 256 文字にする必要があります。有効なタグキーと値の文字には、小文字と大文字 (0 ~ 9)、スペース ('')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア('_')があります。
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	同期コピー元 URL 操作では、BLOB またはインターネットリソースが新しい BLOB にコピーされます。コピーが完了するまで応答は返されません。 https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url を参照してください
undelete(BlobUndeleteOptions)	論理的に削除された BLOB および関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。削除の取り消し BLOB は、バージョン 2017-07-29 以降でのみサポートされます。 https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob を参照してください
withSnapshot(string)	指定したスナップショットタイムスタンプを使用して、ソースと同じ新しい BlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、クライアントがベース BLOB に返されます。
withVersion(string)	この BLOB のバージョンを指す新しい BlobClient オブジェクトを作成します。 "" を指定すると、versionId が削除され、クライアントがベース BLOB に返されます。

コンストラクターの詳細

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

パラメーター

url: string

"https://myaccount.blob.core.windows.net/mycontainer/blob" など、Azure Storage BLOB を指す URL 文字列。 "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。このメソッドは、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() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。

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

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

パラメーター

url: string

"https://myaccount.blob.core.windows.net" など、Azure Storage BLOB サービスを指すクライアント文字列。 "https://myaccount.blob.core.windows.net?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

随意。 HTTP パイプラインを構成するためのオプション。

BlobClient(string, string, string, StoragePipelineOptions)

接続文字列から BlobClient のインスタンスを作成します。

new BlobClient(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 パイプラインを構成するためのオプション。

プロパティの詳細

containerName

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

string containerName

プロパティ値

string

name

BLOB の名前。

string name

プロパティ値

string

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

accountName

accountName: string

プロパティ値

string

StorageClient.accountName から継承された

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

StorageClient.credential から継承された

url

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

url: string

プロパティ値

string

StorageClient.url から継承された

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

パラメーター

copyId: string

コピー元 URL 操作の ID。

options: BlobAbortCopyFromURLOptions

BLOB Abort Copy From URL 操作のオプション (省略可能)。

戻り値

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

BLOB をストレージアカウント内の宛先に非同期的にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングツールを返します。また、ポーラーで cancelOperation を呼び出すことで、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとするとエラーがスローされる場合、onProgress コールバックは呼び出されないことに注意してください。

バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントでコミットされた BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 BLOB のコピー操作を別のストレージアカウントからコピーできるのは、2012 年 6 月 7 日以降に作成されたストレージアカウントのみです。

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

自動ポーリングの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

手動ポーリングの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

進行状況の更新の使用例:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

ポーリング間隔の変更の使用例 (既定では 15 秒):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

コピーの取り消しの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

パラメーター

copySource: string

ソースの Azure BLOB/ファイルへの URL。

options: BlobBeginCopyFromURLOptions

BLOB のコピー開始 URL 操作のオプション (省略可能)。

戻り値

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

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

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

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

パラメーター

options: BlobCreateSnapshotOptions

BLOB スナップショットの作成操作のオプション (省略可能)。

戻り値

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

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

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

パラメーター

options: BlobDeleteOptions

BLOB 削除操作のオプション (省略可能)。

戻り値

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

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

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

パラメーター

options: BlobDeleteOptions

BLOB 削除操作のオプション (省略可能)。

戻り値

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

パラメーター

options: BlobDeleteImmutabilityPolicyOptions

BLOB の不変ポリシーを削除するオプション (省略可能)。

戻り値

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

パラメーター

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 の場合は、downloadToFile検討してください。

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

パラメーター

buffer: Buffer

バッファーがいっぱいになるには、count より長い長さが必要です

offset: number

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

count: number

ダウンロードするデータの量 (バイト単位)。未定義を渡すときに最後までダウンロードします

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

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

パラメーター

offset: number

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

count: number

ダウンロードするデータの量 (バイト単位)。未定義を渡すときに最後までダウンロードします

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

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

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

パラメーター

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): Promise<boolean>

パラメーター

options: BlobExistsOptions

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

戻り値

Promise<boolean>

generateSasStringToSign(BlobGenerateSasUrlOptions)

共有キー資格情報を使用して構築された BlobClient でのみ使用できます。

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

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

パラメーター

options: BlobGenerateSasUrlOptions

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

戻り値

string

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

generateSasUrl(BlobGenerateSasUrlOptions)

共有キー資格情報を使用して構築された BlobClient でのみ使用できます。

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

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

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

パラメーター

options: BlobGenerateSasUrlOptions

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

戻り値

Promise<string>

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

getAccountInfo(BlobGetAccountInfoOptions)

アカウント情報の取得操作は、指定されたアカウントの SKU 名とアカウントの種類を返します。アカウント情報の取得操作は、バージョン 2018-03-28 以降のサービスバージョンで使用できます。

https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information を参照してください

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

パラメーター

options: BlobGetAccountInfoOptions

サービスのアカウント情報の取得操作のオプション。

戻り値

Promise<BlobGetAccountInfoResponse>

サービスアカウント情報の取得操作の応答データ。

getAppendBlobClient()

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

function getAppendBlobClient(): AppendBlobClient

戻り値

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

パラメーター

proposeLeaseId: string

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

戻り値

BlobLeaseClient

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

getBlockBlobClient()

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

function getBlockBlobClient(): BlockBlobClient

戻り値

BlockBlobClient

getPageBlobClient()

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

function getPageBlobClient(): PageBlobClient

戻り値

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

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

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

パラメーター

options: BlobGetPropertiesOptions

プロパティの取得操作のオプション (省略可能)。

戻り値

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

パラメーター

options: BlobGetTagsOptions

戻り値

Promise<BlobGetTagsResponse>

setAccessTier(string, BlobSetTierOptions)

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

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

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

パラメーター

tier: string

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

options: BlobSetTierOptions

BLOB セット層操作のオプション (省略可能)。

戻り値

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

BLOB のシステムプロパティを設定します。

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

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

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

パラメーター

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

BLOB セット HTTP ヘッダー操作のオプション (省略可能)。

戻り値

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

パラメーター

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

BLOB に不変ポリシーを設定するためのオプション (省略可能)。

戻り値

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

パラメーター

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

BLOB に訴訟ホールドを設定するオプション (省略可能)。

戻り値

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

指定した BLOB のユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。

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

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

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

パラメーター

metadata: Metadata

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

options: BlobSetMetadataOptions

メタデータの設定操作のオプション (省略可能)。

戻り値

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

パラメーター

tags: Tags

options: BlobSetTagsOptions

戻り値

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url を参照してください

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

パラメーター

copySource: string

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

options: BlobSyncCopyFromURLOptions

戻り値

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

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

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

パラメーター

options: BlobUndeleteOptions

BLOB の削除の取り消し操作に対するオプション (省略可能)。

戻り値

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

パラメーター

snapshot: string

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

戻り値

BlobClient

ソースと同一の、指定されたスナップショットタイムスタンプを持つ新しい BlobClient オブジェクト

withVersion(string)

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

function withVersion(versionId: string): BlobClient

パラメーター

versionId: string

versionId。

戻り値

BlobClient

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

次の方法で共有

BlobClient class

コンストラクター

プロパティ

継承されたプロパティ

メソッド

コンストラクターの詳細

BlobClient(string, PipelineLike)

パラメーター

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

パラメーター

BlobClient(string, string, string, StoragePipelineOptions)

パラメーター

プロパティの詳細

containerName

プロパティ値

name

プロパティ値

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

accountName

プロパティ値

credential

プロパティ値

url

プロパティ値

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

パラメーター

戻り値

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

パラメーター

戻り値

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)

パラメーター

戻り値

generateSasStringToSign(BlobGenerateSasUrlOptions)

パラメーター

戻り値

generateSasUrl(BlobGenerateSasUrlOptions)

パラメーター

戻り値

getAccountInfo(BlobGetAccountInfoOptions)

パラメーター

戻り値

getAppendBlobClient()

戻り値

getBlobLeaseClient(string)

パラメーター

戻り値

getBlockBlobClient()

戻り値

getPageBlobClient()

戻り値

getProperties(BlobGetPropertiesOptions)

パラメーター

戻り値