BlobProperties Class
Blob Properties.
- Inheritance
-
azure.storage.blob._shared.models.DictMixinBlobProperties
Constructor
BlobProperties(**kwargs: Any)
Methods
get | |
has_key | |
items | |
keys | |
update | |
values |
get
get(key, default=None)
Parameters
Name | Description |
---|---|
key
Required
|
|
default
|
Default value: None
|
has_key
has_key(k)
Parameters
Name | Description |
---|---|
k
Required
|
|
items
items()
keys
keys()
update
update(*args, **kwargs)
values
values()
Attributes
append_blob_committed_block_count
(For Append Blobs) Number of committed blocks in the blob.
append_blob_committed_block_count: int | None
archive_status
Archive status of blob.
archive_status: str | None
blob_tier
Indicates the access tier of the blob. The hot tier is optimized for storing data that is accessed frequently. The cool storage tier is optimized for storing data that is infrequently accessed and stored for at least a month. The archive tier is optimized for storing data that is rarely accessed and stored for at least six months with flexible latency requirements.
blob_tier: StandardBlobTier | None
blob_tier_change_time
Indicates when the access tier was last changed.
blob_tier_change_time: datetime | None
blob_tier_inferred
Indicates whether the access tier was inferred by the service. If false, it indicates that the tier was set explicitly.
blob_tier_inferred: bool | None
blob_type
String indicating this blob's type.
blob_type: BlobType
container
The container in which the blob resides.
container: str
content_range
Indicates the range of bytes returned in the event that the client requested a subset of the blob.
content_range: str | None
content_settings
Stores all the content settings for the blob.
content_settings: ContentSettings
copy
Stores all the copy properties for the blob.
copy: CopyProperties
creation_time
Indicates when the blob was created, in UTC.
creation_time: datetime
deleted
Whether this blob was deleted.
deleted: bool | None
deleted_time
A datetime object representing the time at which the blob was deleted.
deleted_time: datetime | None
encryption_key_sha256
The SHA-256 hash of the provided encryption key.
encryption_key_sha256: str | None
encryption_scope
A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised.
encryption_scope: str | None
etag
The ETag contains a value that you can use to perform operations conditionally.
etag: str
has_legal_hold
Specified if a legal hold should be set on the blob. Currently this parameter of upload_blob() API is for BlockBlob only.
has_legal_hold: bool | None
has_versions_only
A true value indicates the root blob is deleted
has_versions_only: bool | None
immutability_policy
Specifies the immutability policy of a blob, blob snapshot or blob version.
immutability_policy: ImmutabilityPolicy
is_append_blob_sealed
Indicate if the append blob is sealed or not.
is_append_blob_sealed: bool | None
last_accessed_on
Indicates when the last Read/Write operation was performed on a Blob.
last_accessed_on: datetime | None
last_modified
A datetime object representing the last time the blob was modified.
last_modified: datetime
lease
Stores all the lease information for the blob.
lease: LeaseProperties
metadata
Name-value pairs associated with the blob as metadata.
metadata: Dict[str, str]
name
The name of the blob.
name: str
object_replication_destination_policy
Represents the Object Replication Policy Id that created this blob.
object_replication_destination_policy: str | None
object_replication_source_properties
Only present for blobs that have policy ids and rule ids applied to them.
object_replication_source_properties: List[ObjectReplicationPolicy] | None
page_blob_sequence_number
(For Page Blobs) Sequence number for page blob used for coordinating concurrent writes.
page_blob_sequence_number: int | None
rehydrate_priority
Indicates the priority with which to rehydrate an archived blob
rehydrate_priority: str | None
remaining_retention_days
The number of days that the blob will be retained before being permanently deleted by the service.
remaining_retention_days: int | None
request_server_encrypted
Whether this blob is encrypted.
request_server_encrypted: bool | None
server_encrypted
Set to true if the blob is encrypted on the server.
server_encrypted: bool
size
The size of the content returned. If the entire blob was requested, the length of blob in bytes. If a subset of the blob was requested, the length of the returned subset.
size: int
snapshot
Datetime value that uniquely identifies the blob snapshot.
snapshot: str | None
tag_count
Tags count on this blob.
tag_count: int | None
tags
Key value pair of tags on this blob.
tags: Dict[str, str] | None
Azure SDK for Python