Share via

BlobProperties interface

  • Reference
Package:
@azure/storage-blob

Properties of a blob

Properties

accessTier
accessTierChangedOn
accessTierInferred
archiveStatus
blobSequenceNumber
blobType
cacheControl
contentDisposition
contentEncoding
contentLanguage
contentLength

Size in bytes
contentMD5
contentType
copyCompletedOn
copyId
copyProgress
copySource
copyStatus
copyStatusDescription
createdOn
customerProvidedKeySha256
deletedOn
destinationSnapshot
encryptionScope

The name of the encryption scope under which the blob is encrypted.
etag
expiresOn
immutabilityPolicyExpiresOn

UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
immutabilityPolicyMode

Indicates immutability policy mode.
incrementalCopy
isSealed
lastAccessedOn
lastModified
leaseDuration
leaseState
leaseStatus
legalHold

Indicates if a legal hold is present on the blob.
rehydratePriority

If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.
remainingRetentionDays
serverEncrypted
tagCount

Property Details

accessTier 

accessTier?: AccessTier

Property Value

AccessTier

accessTierChangedOn 

accessTierChangedOn?: Date

Property Value

Date

accessTierInferred 

accessTierInferred?: boolean

Property Value

boolean

archiveStatus 

archiveStatus?: ArchiveStatus

Property Value

ArchiveStatus

blobSequenceNumber 

blobSequenceNumber?: number

Property Value

number

blobType 

blobType?: BlobType

Property Value

BlobType

cacheControl 

cacheControl?: string

Property Value

string

contentDisposition 

contentDisposition?: string

Property Value

string

contentEncoding 

contentEncoding?: string

Property Value

string

contentLanguage 

contentLanguage?: string

Property Value

string

contentLength

Size in bytes

contentLength?: number

Property Value

number

contentMD5 

contentMD5?: Uint8Array

Property Value

Uint8Array

contentType 

contentType?: string

Property Value

string

copyCompletedOn 

copyCompletedOn?: Date

Property Value

Date

copyId 

copyId?: string

Property Value

string

copyProgress 

copyProgress?: string

Property Value

string

copySource 

copySource?: string

Property Value

string

copyStatus 

copyStatus?: CopyStatusType

Property Value

CopyStatusType

copyStatusDescription 

copyStatusDescription?: string

Property Value

string

createdOn 

createdOn?: Date

Property Value

Date

customerProvidedKeySha256 

customerProvidedKeySha256?: string

Property Value

string

deletedOn 

deletedOn?: Date

Property Value

Date

destinationSnapshot 

destinationSnapshot?: string

Property Value

string

encryptionScope

The name of the encryption scope under which the blob is encrypted.

encryptionScope?: string

Property Value

string

etag 

etag: string

Property Value

string

expiresOn 

expiresOn?: Date

Property Value

Date

immutabilityPolicyExpiresOn

UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.

immutabilityPolicyExpiresOn?: Date

Property Value

Date

immutabilityPolicyMode

Indicates immutability policy mode.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Property Value

BlobImmutabilityPolicyMode

incrementalCopy 

incrementalCopy?: boolean

Property Value

boolean

isSealed 

isSealed?: boolean

Property Value

boolean

lastAccessedOn 

lastAccessedOn?: Date

Property Value

Date

lastModified 

lastModified: Date

Property Value

Date

leaseDuration 

leaseDuration?: LeaseDurationType

Property Value

LeaseDurationType

leaseState 

leaseState?: LeaseStateType

Property Value

LeaseStateType

leaseStatus 

leaseStatus?: LeaseStatusType

Property Value

LeaseStatusType

legalHold

Indicates if a legal hold is present on the blob.

legalHold?: boolean

Property Value

boolean

rehydratePriority

If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.

rehydratePriority?: RehydratePriority

Property Value

RehydratePriority

remainingRetentionDays 

remainingRetentionDays?: number

Property Value

number

serverEncrypted 

serverEncrypted?: boolean

Property Value

boolean

tagCount 

tagCount?: number

Property Value

number