BlobClient class

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

new BlobClient(url: string, pipeline: PipelineLike)

パラメーター

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

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

パラメーター

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

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

パラメーター

accountName: string

プロパティ値

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

string containerName

プロパティ値

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

BLOB の名前。

string name

プロパティ値

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

url: string

プロパティ値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

パラメーター

戻り値

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

function delete(options?: BlobDeleteOptions)

パラメーター

戻り値

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

function deleteIfExists(options?: BlobDeleteOptions)

パラメーター

戻り値

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

パラメーター

戻り値

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

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

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

パラメーター

// 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);
  });
}

戻り値

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)

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

function exists(options?: BlobExistsOptions)

パラメーター

戻り値

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

パラメーター

戻り値

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

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

function getAppendBlobClient()

戻り値

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

function getBlobLeaseClient(proposeLeaseId?: string)

パラメーター

戻り値

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

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

function getBlockBlobClient()

戻り値

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

function getPageBlobClient()

戻り値

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

function getProperties(options?: BlobGetPropertiesOptions)

パラメーター

戻り値

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

function getTags(options?: BlobGetTagsOptions)

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

function undelete(options?: BlobUndeleteOptions)

パラメーター

戻り値

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

function withSnapshot(snapshot: string)

パラメーター

戻り値

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

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

function withVersion(versionId: string)

パラメーター

戻り値

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