@@ -1126,12 +1126,15 @@ async def create_snapshot(self, metadata=None, **kwargs):
1126
1126
1127
1127
@distributed_trace_async
1128
1128
async def start_copy_from_url (self , source_url , metadata = None , incremental_copy = False , ** kwargs ):
1129
- # type: (str, Optional[Dict[str, str]], bool, Any) -> Any
1130
- """Copies a blob asynchronously.
1131
-
1132
- This operation returns a copy operation
1133
- object that can be used to wait on the completion of the operation,
1134
- as well as check status or abort the copy operation.
1129
+ # type: (str, Optional[Dict[str, str]], bool, Any) -> Dict[str, Union[str, datetime]]
1130
+ """Copies a blob from the given URL.
1131
+
1132
+ This operation returns a dictionary containing `copy_status` and `copy_id`,
1133
+ which can be used to check the status of or abort the copy operation.
1134
+ `copy_status` will be 'success' if the copy completed synchronously or
1135
+ 'pending' if the copy has been started asynchronously. For asynchronous copies,
1136
+ the status can be checked by polling the :func:`get_blob_properties` method and
1137
+ checking the copy status. Set `requires_sync` to True to force the copy to be synchronous.
1135
1138
The Blob service copies blobs on a best-effort basis.
1136
1139
1137
1140
The source blob for a copy operation may be a block blob, an append blob,
@@ -1154,10 +1157,6 @@ async def start_copy_from_url(self, source_url, metadata=None, incremental_copy=
1154
1157
end of the copy operation, the destination blob will have the same committed
1155
1158
block count as the source.
1156
1159
1157
- For all blob types, you can call status() on the returned polling object
1158
- to check the status of the copy operation, or wait() to block until the
1159
- operation is complete. The final blob will be committed when the copy completes.
1160
-
1161
1160
:param str source_url:
1162
1161
A URL of up to 2 KB in length that specifies a file or blob.
1163
1162
The value should be URL-encoded as it would appear in a request URI.
0 commit comments