AppendBlobClient class

リファレンス

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

AppendBlobClient は、追加 BLOB に適用できる一連の操作を定義します。

Extends: BlobClient

コンストラクター

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

プロパティ

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

継承されたプロパティ

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

メソッド

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	新しいデータブロックを既存の追加 BLOB の末尾にコミットします。「https://docs.microsoft.com/rest/api/storageservices/append-block」を参照してください。
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	Append Block 操作は、コンテンツがソース URL から読み取られた既存の追加 BLOB の末尾にデータの新しいブロックをコミットします。「https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url」を参照してください。
create(AppendBlobCreateOptions)	0 長の追加 BLOB を作成します。 AppendBlock を呼び出して、追加 BLOB にデータを追加します。「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	0 長の追加 BLOB を作成します。 AppendBlock を呼び出して、追加 BLOB にデータを追加します。同じ名前の BLOB が既に存在する場合、既存の BLOB の内容は変更されません。「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。
seal(AppendBlobSealOptions)	追加 BLOB をシールし、読み取り専用にします。
withSnapshot(string)	指定したスナップショットタイムスタンプを持つ、ソースと同じ新しい AppendBlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、クライアントがベース BLOB に返されます。

継承されたメソッド

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 に返されます。

コンストラクターの詳細

AppendBlobClient(string, PipelineLike)

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

new AppendBlobClient(url: string, pipeline: PipelineLike)

パラメーター

url: string

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

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

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

パラメーター

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

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

AppendBlobClient(string, string, string, StoragePipelineOptions)

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

new AppendBlobClient(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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credentialから継承

url

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

url: string

プロパティ値

string

BlobClient.urlから継承

メソッドの詳細

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

新しいデータブロックを既存の追加 BLOB の末尾にコミットします。

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

function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

パラメーター

body: HttpRequestBody

追加するデータ。

contentLength: number

本文の長さ (バイト単位)。

options: AppendBlobAppendBlockOptions

[ブロックの追加] 操作のオプション。

使用例:

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

戻り値

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Append Block 操作は、コンテンツがソース URL から読み取られた既存の追加 BLOB の末尾にデータの新しいブロックをコミットします。

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

パラメーター

sourceURL: string

コピーのソースとなる BLOB の URL。同じストレージアカウント内のソース BLOB は、共有キーを使用して認証できます。ただし、ソースが別のアカウントの BLOB の場合、ソース BLOB はパブリックであるか、共有アクセス署名を使用して認証される必要があります。ソース BLOB がパブリックの場合、操作を実行するために認証は必要ありません。

sourceOffset: number

追加するソースのオフセット

count: number

ブロックとして追加するバイト数

options: AppendBlobAppendBlockFromURLOptions

戻り値

Promise<AppendBlobAppendBlockFromUrlResponse>

create(AppendBlobCreateOptions)

0 長の追加 BLOB を作成します。 AppendBlock を呼び出して、追加 BLOB にデータを追加します。

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

パラメーター

options: AppendBlobCreateOptions

追加ブロック作成操作のオプション。

使用例:

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

戻り値

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

0 長の追加 BLOB を作成します。 AppendBlock を呼び出して、追加 BLOB にデータを追加します。同じ名前の BLOB が既に存在する場合、既存の BLOB の内容は変更されません。

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

パラメーター

options: AppendBlobCreateIfNotExistsOptions

戻り値

Promise<AppendBlobCreateIfNotExistsResponse>

seal(AppendBlobSealOptions)

追加 BLOB をシールし、読み取り専用にします。

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

パラメーター

options: AppendBlobSealOptions

戻り値

Promise<AppendBlobAppendBlockResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): AppendBlobClient

パラメーター

snapshot: string

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

戻り値

AppendBlobClient

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

継承済みメソッドの詳細

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 の 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 全体をダウンロードします。

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 の削除取り消し操作のオプション。

戻り値

Promise<BlobUndeleteResponse>

BlobClient.undeleteから継承

withVersion(string)

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

function withVersion(versionId: string): BlobClient

パラメーター

versionId: string

versionId。

戻り値

BlobClient

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

BlobClient.withVersionから継承されます