Share via


BatchSetTierRequest class

A BatchSetTierRequest represents a batch set tier request, which consists of one or more set tier operations.

Extends

Constructors

BatchSetTierRequest()

Methods

addSubRequest(BlobURL, Models.AccessTier, IBlobSetTierOptions)

Add a set tier operation(subrequest) to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See set blob tier details. The operation(subrequest) will be authenticated and authorized with specified credential.See blob batch authorization details.

addSubRequest(string, Credential, Models.AccessTier, IBlobSetTierOptions)

Add a set tier operation(subrequest) to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See set blob tier details. The operation(subrequest) will be authenticated and authorized with specified credential.See blob batch authorization details.

getHttpRequestBody()

Get assembled HTTP request body for sub requests.

getMultiPartContentType()

Get the value of Content-Type for a batch request. The value must be multipart/mixed with a batch boundary. Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

getSubRequests()

Get sub requests that are added into the batch request.

Constructor Details

BatchSetTierRequest()

new BatchSetTierRequest()

Method Details

addSubRequest(BlobURL, Models.AccessTier, IBlobSetTierOptions)

Add a set tier operation(subrequest) to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See set blob tier details. The operation(subrequest) will be authenticated and authorized with specified credential.See blob batch authorization details.

function addSubRequest(blobURL: BlobURL, tier: Models.AccessTier, options?: IBlobSetTierOptions)

Parameters

blobURL
BlobURL
tier
Models.AccessTier

Returns

Promise<void>

addSubRequest(string, Credential, Models.AccessTier, IBlobSetTierOptions)

Add a set tier operation(subrequest) to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See set blob tier details. The operation(subrequest) will be authenticated and authorized with specified credential.See blob batch authorization details.

function addSubRequest(url: string, credential: Credential, tier: Models.AccessTier, options?: IBlobSetTierOptions)

Parameters

url

string

The url of the blob resource to delete.

credential
Credential

The credential to be used for authentication and authorization.

tier
Models.AccessTier

Returns

Promise<void>

getHttpRequestBody()

Get assembled HTTP request body for sub requests.

function getHttpRequestBody()

Returns

string

getMultiPartContentType()

Get the value of Content-Type for a batch request. The value must be multipart/mixed with a batch boundary. Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

function getMultiPartContentType()

Returns

string

getSubRequests()

Get sub requests that are added into the batch request.

function getSubRequests()

Returns

Map<number, BatchSubRequest>