PageBlobUploadPagesOptions interface

Package:

@azure/storage-blob

Options to configure the <xref:PageBlobClient.uploadPages> operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
conditions	Conditions to meet when uploading pages.
customerProvidedKey	Customer Provided Key Info.
encryptionScope	Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.
onProgress	Callback to receive events on the progress of upload pages operation.
tracingOptions	Options to configure spans created when tracing is enabled.
transactionalContentCrc64	A CRC64 hash of the content. This hash is used to verify the integrity of the content during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value. transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.
transactionalContentMD5	An MD5 hash of the content. This hash is used to verify the integrity of the content during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value. transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

conditions

Conditions to meet when uploading pages.

conditions?: PageBlobRequestConditions

Property Value

PageBlobRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

encryptionScope

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

encryptionScope?: string

Property Value

string

onProgress

Callback to receive events on the progress of upload pages operation.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

transactionalContentCrc64

A CRC64 hash of the content. This hash is used to verify the integrity of the content during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value. transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

transactionalContentCrc64?: Uint8Array

Property Value

Uint8Array

transactionalContentMD5

An MD5 hash of the content. This hash is used to verify the integrity of the content during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value. transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

transactionalContentMD5?: Uint8Array

Property Value

Uint8Array