Share via

PageBlobCreateIfNotExistsOptions interface

  • Reference
Package:
@azure/storage-blob

Options to configure the createIfNotExists 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.
blobHTTPHeaders

HTTP headers to set when creating a page blob.
blobSequenceNumber

A user-controlled value that can be used to track requests. The value must be between 0 and 2^63 - 1. The default value is 0.
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.
immutabilityPolicy

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.
legalHold

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.
metadata

A collection of key-value string pair to associate with the blob when creating append blobs.
tier

Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

Inherited Properties

tracingOptions

Options to configure spans created when tracing is enabled.

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

blobHTTPHeaders

HTTP headers to set when creating a page blob.

blobHTTPHeaders?: BlobHTTPHeaders

Property Value

BlobHTTPHeaders

blobSequenceNumber

A user-controlled value that can be used to track requests. The value must be between 0 and 2^63 - 1. The default value is 0.

blobSequenceNumber?: number

Property Value

number

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

immutabilityPolicy

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

immutabilityPolicy?: BlobImmutabilityPolicy

Property Value

BlobImmutabilityPolicy

legalHold

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

legalHold?: boolean

Property Value

boolean

metadata

A collection of key-value string pair to associate with the blob when creating append blobs.

metadata?: Metadata

Property Value

Metadata

tier

Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

tier?: string

Property Value

string

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions