次の方法で共有


BlobBatchClient class

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

コンストラクター

BlobBatchClient(string, PipelineLike)

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

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

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

メソッド

createBatch()

<xref: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 Storage アカウントのページ BLOB と BLOB ストレージ アカウント内のブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 「BLOB 層の詳細を設定する」を参照してください。 operation(subrequest) は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください

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

BLOB に階層を設定する複数のセット層操作を作成します。 操作は、Premium Storage アカウントのページ 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);

コンストラクターの詳細

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()

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

function createBatch()

戻り値

deleteBlobs(BlobClient[], BlobDeleteOptions)

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

function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions)

パラメーター

blobClients

BlobClient[]

削除する BLOB の BlobClients。

戻り値

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

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

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

パラメーター

urls

string[]

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

戻り値

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

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

function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions)

パラメーター

blobClients

BlobClient[]

新しい層を設定する必要がある BLOB の BlobClients。

tier
AccessTier

戻り値

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

BLOB に階層を設定する複数のセット層操作を作成します。 操作は、Premium Storage アカウントのページ 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)

パラメーター

urls

string[]

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

tier
AccessTier

戻り値

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);
function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams)

パラメーター

batchRequest
BlobBatch

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

戻り値