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 のインスタンスを作成します。

プロパティ

containerName

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

BLOB の名前です。

継承されたプロパティ

accountName
credential

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

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

メソッド

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

「https://docs.microsoft.com/rest/api/storageservices/put-block-list」を参照してください。
getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

「https://docs.microsoft.com/rest/api/storageservices/get-block-list」を参照してください。
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);
  });
}
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

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

「https://docs.microsoft.com/rest/api/storageservices/put-block」を参照してください。
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url」を参照してください。
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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

新しいブロック BLOB を作成するか、既存のブロック BLOB の内容を更新します。 既存のブロック BLOB を更新すると、BLOB の既存のメタデータは上書きされます。 部分的な更新はサポートされていません。既存の BLOB のコンテンツは、新しいコンテンツで上書きされます。 ブロック BLOB の部分的な更新を実行するには、 stageBlock と commitBlockList を使用 します。

これは並列以外のアップロード方法です。コンカレンシー アップロードのパフォーマンスを向上させるには、 uploadFile、 uploadStream 、または uploadBrowserData を使用してください。

「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。
uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

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

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

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

設定する一般的な BLOBHTTPHeaders オプションは です blobContentType。これにより、ブラウザーはファイルの種類に基づいて機能を提供できます。
uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView オブジェクトを BlockBlob にアップロードします。

データ長が specifiled maxSingleShotSize (既定値は ) 以下の場合、このメソッドは <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>1 回 のアップロード 呼び出しを使用してアップロードを完了します。 それ以外の場合、このメソッドは stageBlock を呼び出してブロックをアップロードし、最後に commitBlockList を呼び出してブロック リストをコミットします。

設定する一般的な 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 が返されます。

継承されたメソッド

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 ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージ アカウントについてのみ、Copy Blob 操作による他のストレージ アカウントからのコピーが許可されています。

「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 と undefined を渡して BLOB 全体をダウンロードします。
exists(BlobExistsOptions)

このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。

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

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

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。
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)

1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。

オプションが指定されていない場合、または パラメーターにメタデータが定義されていない場合は、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」を参照してください。
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)

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

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

パラメーター

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"" である必要があります。

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

プロパティの詳細

containerName

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

string containerName

プロパティ値

string

name

BLOB の名前です。

string name

プロパティ値

string

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

accountName 

accountName: string

プロパティ値

string

BlobClient.accountNameから継承

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credentialから継承

url

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

url: string

プロパティ値

string

BlobClient.urlから継承

メソッドの詳細

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

「https://docs.microsoft.com/rest/api/storageservices/put-block-list」を参照してください。

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

パラメーター

blocks

string[]

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

options
BlockBlobCommitBlockListOptions

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

戻り値

Promise<BlockBlobCommitBlockListResponse>

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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

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

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

パラメーター

listType
BlockListType

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

options
BlockBlobGetBlockListOptions

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

戻り値

Promise<BlockBlobGetBlockListResponse>

ブロック 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);
  });
}

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

パラメーター

query

string

options
BlockBlobQueryOptions

戻り値

Promise<BlobDownloadResponseModel>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

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

「https://docs.microsoft.com/rest/api/storageservices/put-block」を参照してください。

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

パラメーター

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 以降で使用できます。

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

パラメーター

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 からのブロック操作の応答データ。

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

パラメーター

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=

options
BlockBlobSyncUploadFromURLOptions

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

戻り値

Promise<BlockBlobPutBlobFromUrlResponse>

upload(HttpRequestBody, number, BlockBlobUploadOptions)

新しいブロック BLOB を作成するか、既存のブロック BLOB の内容を更新します。 既存のブロック BLOB を更新すると、BLOB の既存のメタデータは上書きされます。 部分的な更新はサポートされていません。既存の BLOB のコンテンツは、新しいコンテンツで上書きされます。 ブロック BLOB の部分的な更新を実行するには、 stageBlock と commitBlockList を使用 します。

これは並列以外のアップロード方法です。コンカレンシー アップロードのパフォーマンスを向上させるには、 uploadFile、 uploadStream 、または uploadBrowserData を使用してください。

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

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

パラメーター

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 uploadData instead.

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

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

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

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

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

パラメーター

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob、File、ArrayBuffer、または ArrayBufferView

options
BlockBlobParallelUploadOptions

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

戻り値

Promise<BlobUploadCommonResponse>

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

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

Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView オブジェクトを BlockBlob にアップロードします。

データ長が specifiled maxSingleShotSize (既定値は ) 以下の場合、このメソッドは <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>1 回 のアップロード 呼び出しを使用してアップロードを完了します。 それ以外の場合、このメソッドは stageBlock を呼び出してブロックをアップロードし、最後に commitBlockList を呼び出してブロック リストをコミットします。

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

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

パラメーター

data

Blob | ArrayBuffer | ArrayBufferView | Buffer

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

パラメーター

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

パラメーター

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

パラメーター

snapshot

string

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

戻り値

BlockBlobClient

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

継承済みメソッドの詳細

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>

BlobClient.abortCopyFromURL から継承

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

「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/File への URL。

options
BlobBeginCopyFromURLOptions

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

戻り値

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

BlobClient.beginCopyFromURL から継承

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>

BlobClient.createSnapshotから継承

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>

BlobClient.deleteから継承

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>

BlobClient.deleteIfExistsから継承

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

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

パラメーター

options
BlobDeleteImmutabilityPolicyOptions

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

戻り値

Promise<BlobDeleteImmutabilityPolicyResponse>

BlobClient.deleteImmutabilityPolicyから継承

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>

BlobClient.downloadから継承

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>

BlobClient.downloadToBufferから継承されます

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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

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

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

パラメーター

offset

number

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

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

BlobClient.downloadToBufferから継承されます

downloadToFile(string, number, number, BlobDownloadOptions)

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

Azure BLOB をローカル ファイルにダウンロードします。 指定されたファイル パスが既に終了している場合、失敗します。 オフセットとカウントは省略可能で、それぞれ 0 と undefined を渡して 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 に設定されています。これは、そのコンテンツが既に読み取られ、指定されたパスにあるローカル ファイルに書き込まれるためです。

BlobClient.downloadToFileから継承

exists(BlobExistsOptions)

このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。

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

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

パラメーター

options
BlobExistsOptions

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

戻り値

Promise<boolean>

BlobClient.existsから継承

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。

BlobClient.generateSasUrlから継承されます

getAppendBlobClient()

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

function getAppendBlobClient(): AppendBlobClient

戻り値

AppendBlobClient

BlobClient.getAppendBlobClientから継承

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

パラメーター

proposeLeaseId

string

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

戻り値

BlobLeaseClient

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

BlobClient.getBlobLeaseClientから継承

getBlockBlobClient()

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

function getBlockBlobClient(): BlockBlobClient

戻り値

BlockBlobClient

BlobClient.getBlockBlobClientから継承

getPageBlobClient()

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

function getPageBlobClient(): PageBlobClient

戻り値

PageBlobClient

BlobClient.getPageBlobClientから継承

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>

BlobClient.getPropertiesから継承

getTags(BlobGetTagsOptions)

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

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

パラメーター

options
BlobGetTagsOptions

戻り値

Promise<BlobGetTagsResponse>

BlobClient.getTagsから継承

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>

BlobClient.setAccessTierから継承されます

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>

BlobClient.setHTTPHeadersから継承

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

パラメーター

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

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

戻り値

Promise<BlobSetImmutabilityPolicyResponse>

BlobClient.setImmutabilityPolicyから継承

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

パラメーター

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

戻り値

Promise<BlobSetLegalHoldResponse>

BlobClient.setLegalHoldから継承

setMetadata(Metadata, BlobSetMetadataOptions)

1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。

オプションが指定されていない場合、または パラメーターにメタデータが定義されていない場合は、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>

BlobClient.setMetadataから継承

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>

BlobClient.setTagsから継承

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>

BlobClient.syncCopyFromURL から継承

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 Undelete 操作のオプション。

戻り値

Promise<BlobUndeleteResponse>

BlobClient.undeleteから継承

withVersion(string)

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

function withVersion(versionId: string): BlobClient

パラメーター

versionId

string

versionId。

戻り値

BlobClient

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

BlobClient.withVersionから継承