次の方法で共有

BlobBatchClient class

  • リファレンス
パッケージ:
@azure/storage-blob

BlobBatchClient を使用すると、Azure Storage Blob Service に対してバッチ処理された要求を行うことができます。

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

コンストラクター

BlobBatchClient(string, PipelineLike)

BlobBatchClient のインスタンスを作成します。
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

メソッド

createBatch()

BlobBatchを作成します。 BlobBatch は、BLOB に対する操作の集計セットを表します。
deleteBlobs(BlobClient[], BlobDeleteOptions)

複数の削除操作を作成して、指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 両方を同時に削除できます。 削除操作の詳細 を参照してください。 操作 (サブ要求) は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

複数の削除操作を作成して、指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 両方を同時に削除できます。 削除操作の詳細 を参照してください。 操作は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

BLOB に階層を設定する複数のセット層操作を作成します。 この操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージ アカウント内のブロック BLOB で許可されます (ローカル冗長ストレージのみ)。 Premium ページ BLOB の層によって、BLOB の許可されるサイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細 設定を参照してください。 操作 (サブ要求) は、指定された資格情報で認証され、承認されます。BLOB バッチ承認の詳細を参照してください。
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

BLOB に階層を設定する複数のセット層操作を作成します。 この操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージ アカウント内のブロック BLOB で許可されます (ローカル冗長ストレージのみ)。 Premium ページ BLOB の層によって、BLOB の許可されるサイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細 設定を参照してください。 操作 (サブ要求) は、指定された資格情報で認証され、承認されます。BLOB バッチ承認の詳細を参照してください。
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

複数のサブ要求で構成されるバッチ要求を送信します。

スニペットを実行する前に、blobBatchClient やその他の詳細を取得します。 blobServiceClient.getBlobBatchClient() は blobBatchClient を提供します

使用例:

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

リースの使用例:

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

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

コンストラクターの詳細

BlobBatchClient(string, PipelineLike)

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

new BlobBatchClient(url: string, pipeline: PipelineLike)

パラメーター

url

string

"https://myaccount.blob.core.windows.net" など、Azure Storage BLOB サービスを指す URL。 "https://myaccount.blob.core.windows.net?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。

pipeline
PipelineLike

newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。

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

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

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

パラメーター

url

string

"https://myaccount.blob.core.windows.net" など、Azure Storage BLOB サービスを指す URL。 "https://myaccount.blob.core.windows.net?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

メソッドの詳細

createBatch()

BlobBatchを作成します。 BlobBatch は、BLOB に対する操作の集計セットを表します。

function createBatch(): BlobBatch

戻り値

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

複数の削除操作を作成して、指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 両方を同時に削除できます。 削除操作の詳細 を参照してください。 操作 (サブ要求) は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。

function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

パラメーター

blobClients

BlobClient[]

削除する BLOB の BlobClients。

options
BlobDeleteOptions

戻り値

Promise<BlobBatchSubmitBatchResponse>

deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

複数の削除操作を作成して、指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 両方を同時に削除できます。 削除操作の詳細 を参照してください。 操作は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。

function deleteBlobs(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

パラメーター

urls

string[]

削除する BLOB リソースの URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
BlobDeleteOptions

戻り値

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

BLOB に階層を設定する複数のセット層操作を作成します。 この操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージ アカウント内のブロック BLOB で許可されます (ローカル冗長ストレージのみ)。 Premium ページ BLOB の層によって、BLOB の許可されるサイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細 設定を参照してください。 操作 (サブ要求) は、指定された資格情報で認証され、承認されます。BLOB バッチ承認の詳細を参照してください。

function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

パラメーター

blobClients

BlobClient[]

新しい層が設定されている BLOB の BlobClients。

tier
AccessTier
options
BlobSetTierOptions

戻り値

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

BLOB に階層を設定する複数のセット層操作を作成します。 この操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージ アカウント内のブロック BLOB で許可されます (ローカル冗長ストレージのみ)。 Premium ページ BLOB の層によって、BLOB の許可されるサイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細 設定を参照してください。 操作 (サブ要求) は、指定された資格情報で認証され、承認されます。BLOB バッチ承認の詳細を参照してください。

function setBlobsAccessTier(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

パラメーター

urls

string[]

削除する BLOB リソースの URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

tier
AccessTier
options
BlobSetTierOptions

戻り値

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

複数のサブ要求で構成されるバッチ要求を送信します。

スニペットを実行する前に、blobBatchClient やその他の詳細を取得します。 blobServiceClient.getBlobBatchClient() は blobBatchClient を提供します

使用例:

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

リースの使用例:

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

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

function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams): Promise<BlobBatchSubmitBatchResponse>

パラメーター

batchRequest
BlobBatch

Delete または SetTier 操作のセット。

options
BlobBatchSubmitBatchOptionalParams

戻り値

Promise<BlobBatchSubmitBatchResponse>