BlockBlobClient class

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

new BlockBlobClient(url: string, pipeline: PipelineLike)

パラメーター

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

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

パラメーター

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

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

パラメーター

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

string containerName

プロパティ値

BLOB の名前。

string name

プロパティ値

accountName: string

プロパティ値

継承元BlobClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

継承元BlobClient.credential

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

url: string

プロパティ値

継承元BlobClient.url

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

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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

JSON または CSV 形式の BLOB のクイック クエリ。

使用例 (Node.js):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blockBlobClient = containerClient.getBlockBlobClient(blobName);

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select from BlobStorage");
if (queryBlockBlobResponse.readableStreamBody) {
  const downloadedBuffer = await streamToBuffer(queryBlockBlobResponse.readableStreamBody);
  const downloaded = downloadedBuffer.toString();
  console.log(`Query blob content: ${downloaded}`);
}

async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    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>

パラメーター

戻り値

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

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

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

パラメーター

戻り値

ブロック BLOB ステージ ブロック操作の応答データ。

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

https://learn.microsoft.com/rest/api/storageservices/put-block-from-url を参照してください

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

パラメーター

戻り値

ブロック BLOB ステージ ブロックの URL からの操作の応答データ。

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

使用例:

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blockBlobClient = containerClient.getBlockBlobClient(blobName);

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

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

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

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

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

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

パラメーター

戻り値

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

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

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

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

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

パラメーター

戻り値

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

ブロック内のローカル ファイルをブロック BLOB にアップロードします。

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

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

パラメーター

戻り値

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

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

Node.js 読み取り可能ストリームをブロック BLOB にアップロードします。

パフォーマンス向上のヒント:

• 入力ストリーム highWaterMark は、bufferSize パラメーターを使用して同じ値を設定することをお勧めします。これは、Buffer.concat() 操作を回避します。

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

パラメーター

戻り値

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

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

function withSnapshot(snapshot: string): BlockBlobClient

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

継承元:BlobClient.abortCopyFromURL

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

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

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

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

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

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

パラメーター

戻り値

継承元BlobClient.beginCopyFromURL

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

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

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

パラメーター

戻り値

継承元BlobClient.createSnapshot

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

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

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

パラメーター

戻り値

継承元BlobClient.delete

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

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

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

パラメーター

戻り値

継承元BlobClient.deleteIfExists

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

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

パラメーター

戻り値

継承元BlobClient.deleteImmutabilityPolicy

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

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

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

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

パラメーター

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
const downloadBlockBlobResponse = await blobClient.download();
if (downloadBlockBlobResponse.readableStreamBody) {
  const downloaded = await streamToString(downloadBlockBlobResponse.readableStreamBody);
  console.log(`Downloaded blob content: ${downloaded}`);
}

async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
  const result = await new Promise<Buffer<ArrayBuffer>>((resolve, reject) => {
    const chunks: Buffer[] = [];
    stream.on("data", (data) => {
      chunks.push(Buffer.isBuffer(data) ? data : Buffer.from(data));
    });
    stream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    stream.on("error", reject);
  });
  return result.toString();
}

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
const downloadBlockBlobResponse = await blobClient.download();
const blobBody = await downloadBlockBlobResponse.blobBody;
if (blobBody) {
  const downloaded = await blobBody.text();
  console.log(`Downloaded blob content: ${downloaded}`);
}

戻り値

継承元BlobClient.download

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>

パラメーター

戻り値

継承元BlobClient.downloadToBuffer

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

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

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

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

パラメーター

戻り値

継承元BlobClient.downloadToBuffer

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

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

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

パラメーター

戻り値

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

継承元:BlobClient.downloadToFile

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

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

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

パラメーター

戻り値

継承元BlobClient.exists

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

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

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

パラメーター

戻り値

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

継承元BlobClient.generateSasStringToSign

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

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

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

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

パラメーター

戻り値

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

継承元:BlobClient.generateSasUrl

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

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

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

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

パラメーター

戻り値

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

継承元BlobClient.generateUserDelegationSasStringToSign

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

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

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

パラメーター

戻り値

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

継承元BlobClient.generateUserDelegationSasUrl

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

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

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

パラメーター

戻り値

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

継承元BlobClient.getAccountInfo

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

function getAppendBlobClient(): AppendBlobClient

戻り値

継承元BlobClient.getAppendBlobClient

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

パラメーター

戻り値

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

継承元BlobClient.getBlobLeaseClient

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

function getBlockBlobClient(): BlockBlobClient

戻り値

継承元BlobClient.getBlockBlobClient

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

function getPageBlobClient(): PageBlobClient

戻り値

継承元BlobClient.getPageBlobClient

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

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

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

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

パラメーター

戻り値

継承元BlobClient.getProperties

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

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

パラメーター

戻り値

継承元BlobClient.getTags

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

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

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

パラメーター

戻り値

継承元BlobClient.setAccessTier

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

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

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

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

パラメーター

戻り値

継承元BlobClient.setHTTPHeaders

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

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

パラメーター

戻り値

継承元BlobClient.setImmutabilityPolicy

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

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

パラメーター

戻り値

継承元BlobClient.setLegalHold

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

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

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

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

パラメーター

戻り値

継承元BlobClient.setMetadata

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

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

パラメーター

戻り値

継承元BlobClient.setTags

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

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

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

パラメーター

戻り値

継承元BlobClient.syncCopyFromURL

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

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

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

パラメーター

戻り値

継承元BlobClient.undelete

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

function withVersion(versionId: string): BlobClient

パラメーター

戻り値

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

継承元BlobClient.withVersion