BlobBatchClient class

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

BlobBatchClient を使用すると、Azure Storage BLOB サービスにバッチ処理された要求を行うことができます。

「https://docs.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 を削除するには、そのスナップショットをすべて削除する必要があります。 両方を同時に削除できます。 「削除操作の詳細」を参照してください。 operation(subrequest) は、指定された資格情報で認証および承認されます。 「BLOB バッチ承認の詳細」を参照してください。
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

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

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

BLOB に階層を設定する複数のセット層操作を作成します。 この操作は、Premium ストレージ アカウントのページ BLOB と BLOB ストレージ アカウントのブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細の設定に関するページを参照してください。 operation(subrequest) は、指定された資格情報で認証および承認されます。 「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://docs.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。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.blob.core.windows.net?sasString")。

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。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.blob.core.windows.net?sasString")。

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 を削除するには、そのスナップショットをすべて削除する必要があります。 両方を同時に削除できます。 「削除操作の詳細」を参照してください。 operation(subrequest) は、指定された資格情報で認証および承認されます。 「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 ストレージ アカウントのページ BLOB と BLOB ストレージ アカウントのブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細の設定に関するページを参照してください。 operation(subrequest) は、指定された資格情報で認証および承認されます。 「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 ストレージ アカウントのページ BLOB と BLOB ストレージ アカウントのブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 BLOB 層の詳細の設定に関するページを参照してください。 operation(subrequest) は、指定された資格情報で認証および承認されます。 「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://docs.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>