CopyProperties class

Definition

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.

CopyProperties(**kwargs)
Inheritance
builtins.object
azure.storage.blob._shared.models.DictMixin
CopyProperties

Parameters

id
str

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

source
str

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.

status
str

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.

progress
str

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.

completion_time
datetime

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.

status_description
str

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

incremental_copy
bool

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

destination_snapshot
datetime

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.