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

プロパティ

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

メソッド

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	保留中の非同期コピー BLOB 操作を中止し、コピー先 BLOB の長さと完全なメタデータを残します。バージョン 2012-02-12 以降。
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	既存の追加 BLOB の末尾に新しいデータブロックをコミットします。
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	Append Block 操作は、コンテンツがソース URL から読み取られた既存の追加 BLOB の末尾に新しいデータブロックをコミットします。
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	ストレージアカウント内のコピー先に BLOB を非同期にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングを返します。また、ポーラーでを呼び出 `cancelOperation` して、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとすると、エラーがスローされる場合、onProgress コールバックは呼び出されないことに注意してください。バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントでコミットされた BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージアカウントについてのみ、Copy Blob 操作による他のストレージアカウントからのコピーが許可されています。
create(AppendBlobCreateOptions)	長さ 0 の追加 BLOB を作成します。 AppendBlock を呼び出して、追加 BLOB にデータを追加します。
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	長さ 0 の追加 BLOB を作成します。 AppendBlock を呼び出して、追加 BLOB にデータを追加します。同じ名前の BLOB が既に存在する場合、既存の BLOB の内容は変更されません。
createSnapshot(BlobCreateSnapshotOptions)	BLOB の読み取り専用のスナップショットを作成します。
delete(BlobDeleteOptions)	指定した BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作では、両方を同時に削除できます。
deleteIfExists(BlobDeleteOptions)	指定した BLOB またはスナップショットが存在する場合は、削除のマークを付けます。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作では、両方を同時に削除できます。
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	BLOB の不変ポリシーを削除します。
download(number, number, BlobDownloadOptions)	メタデータやプロパティなど、システムから BLOB を読み取りまたはダウンロードします。また、Get BLOB を呼び出してスナップショットを読み取ることもできます。 Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されますブラウザーでは、promise blobBody でデータが返されます
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーでサポートできるファイルは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトです。Node.js/V8 の制限があります。このサイズより大きい BLOB の場合は、を検討してください <xref:downloadToFile>。
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーでサポートできるファイルは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトです。Node.js/V8 の制限があります。このサイズより大きい BLOB の場合は、を検討してください <xref:downloadToFile>。
downloadToFile(string, number, number, BlobDownloadOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をローカルファイルにダウンロードします。指定されたファイルパスが既に終了した場合、失敗します。オフセットとカウントは省略可能です。BLOB 全体をダウンロードするには、それぞれ 0 と undefined を渡します。
exists(BlobExistsOptions)	このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。注: 既存の BLOB は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しい BLOB が追加される可能性があります。
generateSasUrl(BlobGenerateSasUrlOptions)	共有キー資格情報を使用して構築された BlobClient でのみ使用できます。渡されたクライアントプロパティとパラメーターに基づいて、BLOB サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。
getAppendBlobClient()	AppendBlobClient オブジェクトを作成します。
getBlobLeaseClient(string)	BLOB の <xref:BlobLeaseClient> リースを管理するを取得します。
getBlockBlobClient()	BlockBlobClient オブジェクトを作成します。
getPageBlobClient()	PageBlobClient オブジェクトを作成します。
getProperties(BlobGetPropertiesOptions)	BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステムプロパティを返します。 BLOB のコンテンツは返しません。
getTags(BlobGetTagsOptions)	基になる BLOB に関連付けられているタグを取得します。
seal(AppendBlobSealOptions)	追加 BLOB をシールし、読み取り専用にします。
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	BLOB の層を設定します。この操作は、Premium ストレージアカウントのページ BLOB と BLOB ストレージアカウントのブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。ブロック BLOB の層によって、ホット/クール/アーカイブストレージの種類が決まります。この操作では、BLOB の ETag は更新されません。
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	BLOB のシステムプロパティを設定します。値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	BLOB に不変ポリシーを設定します。
setLegalHold(boolean, BlobSetLegalHoldOptions)	BLOB に訴訟ホールドを設定します。
setMetadata(Metadata, BlobSetMetadataOptions)	1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。
setTags(Tags, BlobSetTagsOptions)	基になる BLOB にタグを設定します。 BLOB には最大 10 個のタグを含めることができます。タグキーは 1 ~ 128 文字にする必要があります。タグの値は 0 ~ 256 文字にする必要があります。有効なタグキーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース ('')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	同期コピー元 URL 操作は、BLOB またはインターネットリソースを新しい BLOB にコピーします。コピーが完了するまで応答は返されません。
undelete(BlobUndeleteOptions)	論理的に削除された BLOB および関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。 BLOB の削除の取り消しは、バージョン 2017-07-29 以降でのみサポートされています。
withSnapshot(string)	指定したスナップショットタイムスタンプを使用して、ソースと同じ新しい AppendBlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、クライアントがベース 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

"; などhttps://myaccount.blob.core.windows.net/mycontainer/appendblob"、Azure Storage の追加 BLOB を指す 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 パイプラインを構成するためのオプション。

プロパティの詳細

accountName

accountName: string

プロパティ値

string

containerName

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

string containerName

プロパティ値

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

BLOB の名前です。

string name

プロパティ値

string

url

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

url: string

プロパティ値

string

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

パラメーター

copyId: string

コピー元 URL 操作の ID。

options: BlobAbortCopyFromURLOptions

BLOB Abort Copy From URL 操作のオプション。

戻り値

Promise<BlobAbortCopyFromURLResponse>

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

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

function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions)

パラメーター

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 の末尾に新しいデータブロックをコミットします。

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions)

パラメーター

sourceURL: string

          The url to the blob that will be the source of the copy. A source blob in the same storage account can
          be authenticated via Shared Key. However, if the source is a blob in another account, the source blob
          must either be public or must be authenticated via a shared access signature. If the source blob is
          public, no authentication is required to perform the operation.

sourceOffset: number

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

count: number

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

options: AppendBlobAppendBlockFromURLOptions

戻り値

Promise<AppendBlobAppendBlockFromUrlResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

パラメーター

copySource: string

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

options: BlobBeginCopyFromURLOptions

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

戻り値

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

create(AppendBlobCreateOptions)

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

function create(options?: AppendBlobCreateOptions)

パラメーター

options: AppendBlobCreateOptions

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

使用例:

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

戻り値

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions)

パラメーター

options: AppendBlobCreateIfNotExistsOptions

戻り値

Promise<AppendBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

パラメーター

options: BlobCreateSnapshotOptions

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

戻り値

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

パラメーター

options: BlobDeleteOptions

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

戻り値

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

パラメーター

options: BlobDeleteOptions

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

戻り値

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

パラメーター

options: BlobDeleteImmutabilityPolicyOptions

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

戻り値

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

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

パラメーター

offset: number

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

count: number

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

options: BlobDownloadOptions

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

使用例 (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

使用例 (ブラウザー):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

戻り値

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

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

パラメーター

buffer: Buffer

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

offset: number

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

count: number

ダウンロードするデータの量 (バイト単位)。 undefined を渡すときに最後にダウンロードされます

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

パラメーター

offset: number

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

count: number

ダウンロードするデータの量 (バイト単位)。 undefined を渡すときに最後にダウンロードされます

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

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

パラメーター

filePath: string

offset: number

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

count: number

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

options: BlobDownloadOptions

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

戻り値

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

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

function exists(options?: BlobExistsOptions)

パラメーター

options: BlobExistsOptions

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

戻り値

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

パラメーター

options: BlobGenerateSasUrlOptions

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

戻り値

Promise<string>

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

getAppendBlobClient()

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

function getAppendBlobClient()

戻り値

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

パラメーター

proposeLeaseId: string

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

戻り値

BlobLeaseClient

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

getBlockBlobClient()

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

function getBlockBlobClient()

戻り値

BlockBlobClient

getPageBlobClient()

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

function getPageBlobClient()

戻り値

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

パラメーター

options: BlobGetPropertiesOptions

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

戻り値

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

パラメーター

options: BlobGetTagsOptions

戻り値

Promise<BlobGetTagsResponse>

seal(AppendBlobSealOptions)

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

function seal(options?: AppendBlobSealOptions)

パラメーター

options: AppendBlobSealOptions

戻り値

Promise<AppendBlobAppendBlockResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

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

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

パラメーター

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

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

戻り値

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

パラメーター

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

戻り値

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

パラメーター

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

戻り値

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

パラメーター

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

戻り値

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

パラメーター

metadata: Metadata

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

options: BlobSetMetadataOptions

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

戻り値

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

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

パラメーター

tags: Tags

options: BlobSetTagsOptions

戻り値

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

パラメーター

copySource: string

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

options: BlobSyncCopyFromURLOptions

戻り値

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

パラメーター

options: BlobUndeleteOptions

Blob Undelete 操作のオプション。

戻り値

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

パラメーター

snapshot: string

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

戻り値

AppendBlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

パラメーター

versionId: string

versionId。

戻り値

BlobClient

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