Share via

CopyProperties Class

Blob Copy Properties.

These properties will be None if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation, for example, using Set Blob Properties, Upload Blob, or Commit Block List.

Constructor

Python 
CopyProperties(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get

Python 
get(key, default=None)

Parameters

Name Description
key
Required
default
Required
Default value: None

has_key

Python 
has_key(k)

Parameters

Name Description
k
Required

items

Python 
items()

keys

Python 
keys()

update

Python 
update(*args, **kwargs)

values

Python 
values()

Attributes

completion_time

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt.

Python 
completion_time: datetime | None

destination_snapshot

Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob.

Python 
destination_snapshot: datetime | None

id

String identifier for the last attempted Copy Blob operation where this blob was the destination blob.

Python 
id: str | None

incremental_copy

Copies the snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination.

Python 
incremental_copy: bool | None

progress

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied.

Python 
progress: str | None

source

URL up to 2 KB in length that specifies the source blob used in the last attempted Copy Blob operation where this blob was the destination blob.

Python 
source: str | None

status

State of the copy operation identified by Copy ID, with these values: success: Copy completed successfully. pending: Copy is in progress. Check copy_status_description if intermittent, non-fatal errors impede copy progress but don't cause failure. aborted: Copy was ended by Abort Copy Blob. failed: Copy failed. See copy_status_description for failure details.

Python 
status: str | None

status_description

Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.

Python 
status_description: str | None