BlobBatch class

套件:

@azure/storage-blob

BlobBatch 代表 Blob 上一組匯總的作業。 目前僅 delete 支援 和 setAccessTier 。

建構函式

BlobBatch()

方法

deleteBlob(BlobClient, BlobDeleteOptions)	deleteBlob 作業會標示要刪除的指定 Blob 或快照集。 Blob 稍後會在記憶體回收時刪除。 每個批次要求只允許一種作業。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。
deleteBlob(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)	deleteBlob 作業會標示要刪除的指定 Blob 或快照集。 Blob 稍後會在記憶體回收時刪除。 每個批次要求只允許一種作業。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。
getHttpRequestBody()	取得子要求的已組合 HTTP 要求本文。
getMultiPartContentType()	取得批次要求的 Content-Type 值。 此值必須與批次界限多部分/混合。 範例：多部分/混合;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252
getSubRequests()	取得新增至批次要求的子要求。
setBlobAccessTier(BlobClient, AccessTier, BlobSetTierOptions)	setBlobAccessTier 作業會設定 Blob 上的層。 在 Blob 儲存體或一般用途 v2 帳戶中的區塊 Blob 上允許此作業。 每個批次要求只允許一種作業。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 如需區塊 Blob 層級階層處理的詳細資訊 ，請參閱經常性存取層、非經常性存取層和封存存取層。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。
setBlobAccessTier(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)	setBlobAccessTier 作業會設定 Blob 上的層。 在 Blob 儲存體或一般用途 v2 帳戶中的區塊 Blob 上允許此作業。 每個批次要求只允許一種作業。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 如需區塊 Blob 層級階層處理的詳細資訊 ，請參閱經常性存取層、非經常性存取層和封存存取層。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。

建構函式詳細資料

BlobBatch()

new BlobBatch()

方法詳細資料

deleteBlob(BlobClient, BlobDeleteOptions)

deleteBlob 作業會標示要刪除的指定 Blob 或快照集。 Blob 稍後會在記憶體回收時刪除。 每個批次要求只允許一種作業。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。

function deleteBlob(blobClient: BlobClient, options?: BlobDeleteOptions)

參數

blobClient

BlobClient

BlobClient。

options

BlobDeleteOptions

傳回

Promise<void>

deleteBlob(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

deleteBlob 作業會標示要刪除的指定 Blob 或快照集。 Blob 稍後會在記憶體回收時刪除。 每個批次要求只允許一種作業。 請注意，若要刪除 Blob，您必須刪除其所有快照集。 您可以同時刪除這兩者。 請參閱 刪除作業詳細資料。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。

function deleteBlob(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions)

參數

url

string

要刪除之 Blob 資源的 URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自封裝的 @azure/identity 認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。

options

BlobDeleteOptions

傳回

Promise<void>

getHttpRequestBody()

取得子要求的已組合 HTTP 要求本文。

function getHttpRequestBody()

傳回

string

getMultiPartContentType()

取得批次要求的 Content-Type 值。 此值必須與批次界限多部分/混合。 範例：多部分/混合;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

function getMultiPartContentType()

傳回

string

getSubRequests()

取得新增至批次要求的子要求。

function getSubRequests()

傳回

Map<number, BatchSubRequest>

setBlobAccessTier(BlobClient, AccessTier, BlobSetTierOptions)

setBlobAccessTier 作業會設定 Blob 上的層。 在 Blob 儲存體或一般用途 v2 帳戶中的區塊 Blob 上允許此作業。 每個批次要求只允許一種作業。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 如需區塊 Blob 層級階層處理的詳細資訊 ，請參閱經常性存取層、非經常性存取層和封存存取層。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。

function setBlobAccessTier(blobClient: BlobClient, tier: AccessTier, options?: BlobSetTierOptions)

參數

blobClient

BlobClient

BlobClient。

tier

AccessTier

options

BlobSetTierOptions

傳回

Promise<void>

setBlobAccessTier(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

setBlobAccessTier 作業會設定 Blob 上的層。 在 Blob 儲存體或一般用途 v2 帳戶中的區塊 Blob 上允許此作業。 每個批次要求只允許一種作業。 區塊 Blob 的層會決定經常性存取/非經常性存取/封存儲存體類型。 這項作業不會更新 Blob 的 ETag。 如需區塊 Blob 層級階層處理的詳細資訊 ，請參閱經常性存取層、非經常性存取層和封存存取層。 作業將會透過指定的認證進行驗證和授權。 請參閱 Blob 批次授權詳細資料。

function setBlobAccessTier(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions)

參數

url

string

要刪除之 Blob 資源的 URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自封裝的 @azure/identity 認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。

tier

AccessTier

options

BlobSetTierOptions

傳回

Promise<void>