BlobBatchClient class
BlobBatchClient 可讓您對 Azure 儲存體 Blob 服務提出批次要求。
請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
建構函式
| Blob |
建立 BlobBatchClient 的實例。 |
| Blob |
建立 BlobBatchClient 的實例。 |
方法
| create |
建立 BlobBatch。 BlobBatch 代表 Blob 上的一組匯總作業。 |
| delete |
建立多個刪除作業，以標記要刪除的指定 Blob 或快照集。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 (子查詢) 作業將會使用指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。 |
| delete |
建立多個刪除作業，以標記要刪除的指定 Blob 或快照集。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。 |
| set |
建立多個集合層作業，以在 Blob 上設定層。 在進階儲存體帳戶中的分頁 Blob 和 Blob 儲存體帳戶中的區塊 Blob 上，允許此作業 (本機備援儲存體) 。 進階分頁 Blob 的層會決定 Blob 允許的大小、IOPS 和頻寬。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 請參閱 設定 Blob 層詳細資料。 作業 (子要求) 將會使用指定的認證進行驗證和授權。請參閱 Blob 批次授權詳細資料。 |
| set |
建立多個集合層作業，以在 Blob 上設定層。 在進階儲存體帳戶中的分頁 Blob 和 Blob 儲存體帳戶中的區塊 Blob 上，允許此作業 (本機備援儲存體) 。 進階分頁 Blob 的層會決定 Blob 允許的大小、IOPS 和頻寬。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 請參閱 設定 Blob 層詳細資料。 作業 (子要求) 將會使用指定的認證進行驗證和授權。請參閱 Blob 批次授權詳細資料。 |
| submit |
提交包含多個子查詢的批次要求。 在執行程式碼片段之前，請先取得 使用方式範例： 使用租用的範例： 請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
建構函式詳細資料
BlobBatchClient(string, PipelineLike)
建立 BlobBatchClient 的實例。
new BlobBatchClient(url: string, pipeline: PipelineLike)參數
- url
-
string
指向 Azure 儲存體 Blob 服務的 URL，例如 「 https://myaccount.blob.core.windows.net" ;。 如果使用 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
指向 Azure 儲存體 Blob 服務的 URL，例如 「 https://myaccount.blob.core.windows.net" ;。 如果使用 AnonymousCredential，您可以附加 SAS，例如 「 https://myaccount.blob.core.windows.net?sasString" ;。
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自套件的 @azure/identity 認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。
- options
- StoragePipelineOptions
設定 HTTP 管線的選項。
方法詳細資料
createBatch()
deleteBlobs(BlobClient[], BlobDeleteOptions)
建立多個刪除作業，以標記要刪除的指定 Blob 或快照集。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 (子查詢) 作業將會使用指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。
function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>參數
- blobClients
要刪除之 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 上設定層。 在進階儲存體帳戶中的分頁 Blob 和 Blob 儲存體帳戶中的區塊 Blob 上，允許此作業 (本機備援儲存體) 。 進階分頁 Blob 的層會決定 Blob 允許的大小、IOPS 和頻寬。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 請參閱 設定 Blob 層詳細資料。 作業 (子要求) 將會使用指定的認證進行驗證和授權。請參閱 Blob 批次授權詳細資料。
function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>參數
- blobClients
BlobClients 的 BlobClients，該 Blob 應該設定新的層。
- tier
- AccessTier
- options
- BlobSetTierOptions
傳回
Promise<BlobBatchSubmitBatchResponse>
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)
建立多個集合層作業，以在 Blob 上設定層。 在進階儲存體帳戶中的分頁 Blob 和 Blob 儲存體帳戶中的區塊 Blob 上，允許此作業 (本機備援儲存體) 。 進階分頁 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://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams): Promise<BlobBatchSubmitBatchResponse>參數
- batchRequest
- BlobBatch
一組 Delete 或 SetTier 作業。
傳回
Promise<BlobBatchSubmitBatchResponse>