azure-storage-blob 12.20.0b1__py3-none-any.whl → 12.21.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- azure/storage/blob/__init__.py +12 -2
- azure/storage/blob/_blob_client.py +64 -51
- azure/storage/blob/_blob_service_client.py +17 -12
- azure/storage/blob/_container_client.py +33 -23
- azure/storage/blob/_download.py +277 -167
- azure/storage/blob/_generated/_azure_blob_storage.py +1 -1
- azure/storage/blob/_generated/_configuration.py +2 -2
- azure/storage/blob/_generated/_patch.py +2 -0
- azure/storage/blob/_generated/_serialization.py +1 -1
- azure/storage/blob/_generated/aio/_azure_blob_storage.py +1 -1
- azure/storage/blob/_generated/aio/_configuration.py +2 -2
- azure/storage/blob/_generated/aio/_patch.py +2 -0
- azure/storage/blob/_generated/aio/operations/_append_blob_operations.py +10 -5
- azure/storage/blob/_generated/aio/operations/_blob_operations.py +45 -26
- azure/storage/blob/_generated/aio/operations/_block_blob_operations.py +12 -7
- azure/storage/blob/_generated/aio/operations/_container_operations.py +39 -20
- azure/storage/blob/_generated/aio/operations/_page_blob_operations.py +15 -10
- azure/storage/blob/_generated/aio/operations/_patch.py +3 -0
- azure/storage/blob/_generated/aio/operations/_service_operations.py +28 -10
- azure/storage/blob/_generated/models/_patch.py +3 -0
- azure/storage/blob/_generated/operations/_append_blob_operations.py +14 -9
- azure/storage/blob/_generated/operations/_blob_operations.py +76 -51
- azure/storage/blob/_generated/operations/_block_blob_operations.py +18 -13
- azure/storage/blob/_generated/operations/_container_operations.py +64 -39
- azure/storage/blob/_generated/operations/_page_blob_operations.py +24 -19
- azure/storage/blob/_generated/operations/_patch.py +3 -0
- azure/storage/blob/_generated/operations/_service_operations.py +43 -19
- azure/storage/blob/_generated/py.typed +1 -0
- azure/storage/blob/_lease.py +6 -5
- azure/storage/blob/_models.py +1 -1
- azure/storage/blob/_serialize.py +1 -0
- azure/storage/blob/_shared/authentication.py +62 -4
- azure/storage/blob/_shared/base_client.py +1 -1
- azure/storage/blob/_shared/base_client_async.py +3 -2
- azure/storage/blob/_shared/models.py +13 -12
- azure/storage/blob/_shared/shared_access_signature.py +1 -0
- azure/storage/blob/_shared_access_signature.py +1 -0
- azure/storage/blob/_version.py +1 -1
- azure/storage/blob/aio/__init__.py +13 -4
- azure/storage/blob/aio/_blob_client_async.py +50 -47
- azure/storage/blob/aio/_blob_service_client_async.py +11 -11
- azure/storage/blob/aio/_container_client_async.py +23 -20
- azure/storage/blob/aio/_download_async.py +317 -209
- azure/storage/blob/aio/_lease_async.py +6 -6
- {azure_storage_blob-12.20.0b1.dist-info → azure_storage_blob-12.21.0.dist-info}/METADATA +2 -2
- azure_storage_blob-12.21.0.dist-info/RECORD +82 -0
- azure_storage_blob-12.20.0b1.dist-info/RECORD +0 -81
- {azure_storage_blob-12.20.0b1.dist-info → azure_storage_blob-12.21.0.dist-info}/LICENSE +0 -0
- {azure_storage_blob-12.20.0b1.dist-info → azure_storage_blob-12.21.0.dist-info}/WHEEL +0 -0
- {azure_storage_blob-12.20.0b1.dist-info → azure_storage_blob-12.21.0.dist-info}/top_level.txt +0 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
# Licensed under the MIT License. See License.txt in the project root for
|
4
4
|
# license information.
|
5
5
|
# --------------------------------------------------------------------------
|
6
|
-
# pylint: disable=too-many-lines, invalid-overridden-method
|
6
|
+
# pylint: disable=too-many-lines, invalid-overridden-method, docstring-keyword-should-match-keyword-only
|
7
7
|
|
8
8
|
import warnings
|
9
9
|
from functools import partial
|
@@ -167,9 +167,9 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
167
167
|
:param str source_url:
|
168
168
|
A URL of up to 2 KB in length that specifies a file or blob.
|
169
169
|
The value should be URL-encoded as it would appear in a request URI.
|
170
|
-
|
171
|
-
|
172
|
-
is public, no authentication is required.
|
170
|
+
The source must either be public or must be authenticated via a shared
|
171
|
+
access signature as part of the url or using the source_authorization keyword.
|
172
|
+
If the source is public, no authentication is required.
|
173
173
|
Examples:
|
174
174
|
https://myaccount.blob.core.windows.net/mycontainer/myblob
|
175
175
|
|
@@ -186,7 +186,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
186
186
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
187
187
|
and tag values must be between 0 and 256 characters.
|
188
188
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
189
|
-
space (
|
189
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
|
190
190
|
:paramtype tags: dict(str, str)
|
191
191
|
:keyword bytearray source_content_md5:
|
192
192
|
Specify the md5 that is used to verify the integrity of the source bytes.
|
@@ -234,7 +234,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
234
234
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
235
235
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
236
236
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
237
|
-
#other-client--per-operation-configuration>`
|
237
|
+
#other-client--per-operation-configuration>`__.
|
238
238
|
:keyword ~azure.storage.blob.ContentSettings content_settings:
|
239
239
|
ContentSettings object used to set blob properties. Used to set content type, encoding,
|
240
240
|
language, disposition, md5, and cache control.
|
@@ -289,7 +289,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
289
289
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
290
290
|
and tag values must be between 0 and 256 characters.
|
291
291
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
292
|
-
space (
|
292
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
|
293
293
|
|
294
294
|
.. versionadded:: 12.4.0
|
295
295
|
|
@@ -395,7 +395,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
395
395
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
396
396
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
397
397
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
398
|
-
#other-client--per-operation-configuration>`
|
398
|
+
#other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
|
399
399
|
the timeout will apply to each call individually.
|
400
400
|
multiple calls to the Azure service and the timeout will apply to
|
401
401
|
each call individually.
|
@@ -463,6 +463,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
463
463
|
value that, when present, specifies the version of the blob to download.
|
464
464
|
|
465
465
|
.. versionadded:: 12.4.0
|
466
|
+
|
466
467
|
This keyword argument was introduced in API version '2019-12-12'.
|
467
468
|
|
468
469
|
:keyword bool validate_content:
|
@@ -521,7 +522,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
521
522
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
522
523
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
523
524
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
524
|
-
#other-client--per-operation-configuration>`
|
525
|
+
#other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
|
525
526
|
the timeout will apply to each call individually.
|
526
527
|
multiple calls to the Azure service and the timeout will apply to
|
527
528
|
each call individually.
|
@@ -571,6 +572,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
571
572
|
value that, when present, specifies the version of the blob to delete.
|
572
573
|
|
573
574
|
.. versionadded:: 12.4.0
|
575
|
+
|
574
576
|
This keyword argument was introduced in API version '2019-12-12'.
|
575
577
|
|
576
578
|
:keyword lease:
|
@@ -606,7 +608,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
606
608
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
607
609
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
608
610
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
609
|
-
#other-client--per-operation-configuration>`
|
611
|
+
#other-client--per-operation-configuration>`__.
|
610
612
|
:rtype: None
|
611
613
|
|
612
614
|
.. admonition:: Example:
|
@@ -641,7 +643,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
641
643
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
642
644
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
643
645
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
644
|
-
#other-client--per-operation-configuration>`
|
646
|
+
#other-client--per-operation-configuration>`__.
|
645
647
|
:rtype: None
|
646
648
|
|
647
649
|
.. admonition:: Example:
|
@@ -673,7 +675,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
673
675
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
674
676
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
675
677
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
676
|
-
#other-client--per-operation-configuration>`
|
678
|
+
#other-client--per-operation-configuration>`__.
|
677
679
|
:returns: boolean
|
678
680
|
:rtype: bool
|
679
681
|
"""
|
@@ -708,6 +710,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
708
710
|
value that, when present, specifies the version of the blob to get properties.
|
709
711
|
|
710
712
|
.. versionadded:: 12.4.0
|
713
|
+
|
711
714
|
This keyword argument was introduced in API version '2019-12-12'.
|
712
715
|
|
713
716
|
:keyword ~datetime.datetime if_modified_since:
|
@@ -743,7 +746,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
743
746
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
744
747
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
745
748
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
746
|
-
#other-client--per-operation-configuration>`
|
749
|
+
#other-client--per-operation-configuration>`__.
|
747
750
|
:returns: BlobProperties
|
748
751
|
:rtype: ~azure.storage.blob.BlobProperties
|
749
752
|
|
@@ -829,7 +832,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
829
832
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
830
833
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
831
834
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
832
|
-
#other-client--per-operation-configuration>`
|
835
|
+
#other-client--per-operation-configuration>`__.
|
833
836
|
:returns: Blob-updated property dict (Etag and last modified)
|
834
837
|
:rtype: Dict[str, Any]
|
835
838
|
"""
|
@@ -894,7 +897,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
894
897
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
895
898
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
896
899
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
897
|
-
#other-client--per-operation-configuration>`
|
900
|
+
#other-client--per-operation-configuration>`__.
|
898
901
|
:returns: Blob-updated property dict (Etag and last modified)
|
899
902
|
:rtype: Dict[str, Union[str, datetime]]
|
900
903
|
"""
|
@@ -923,7 +926,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
923
926
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
924
927
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
925
928
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
926
|
-
#other-client--per-operation-configuration>`
|
929
|
+
#other-client--per-operation-configuration>`__.
|
927
930
|
:returns: Key value pairs of blob tags.
|
928
931
|
:rtype: Dict[str, str]
|
929
932
|
"""
|
@@ -945,7 +948,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
945
948
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
946
949
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
947
950
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
948
|
-
#other-client--per-operation-configuration>`
|
951
|
+
#other-client--per-operation-configuration>`__.
|
949
952
|
:returns: Key value pairs of blob tags.
|
950
953
|
:rtype: Dict[str, str]
|
951
954
|
"""
|
@@ -967,7 +970,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
967
970
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
968
971
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
969
972
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
970
|
-
#other-client--per-operation-configuration>`
|
973
|
+
#other-client--per-operation-configuration>`__.
|
971
974
|
:returns: Key value pairs of blob tags.
|
972
975
|
:rtype: Dict[str, Union[str, datetime, bool]]
|
973
976
|
"""
|
@@ -1003,7 +1006,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1003
1006
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
1004
1007
|
and tag values must be between 0 and 256 characters.
|
1005
1008
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
1006
|
-
space (
|
1009
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
|
1007
1010
|
|
1008
1011
|
.. versionadded:: 12.4.0
|
1009
1012
|
|
@@ -1063,7 +1066,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1063
1066
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1064
1067
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1065
1068
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1066
|
-
#other-client--per-operation-configuration>`
|
1069
|
+
#other-client--per-operation-configuration>`__.
|
1067
1070
|
:returns: Blob-updated property dict (Etag and last modified).
|
1068
1071
|
:rtype: dict[str, Any]
|
1069
1072
|
"""
|
@@ -1096,7 +1099,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1096
1099
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
1097
1100
|
and tag values must be between 0 and 256 characters.
|
1098
1101
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
1099
|
-
space (
|
1102
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
|
1100
1103
|
|
1101
1104
|
.. versionadded:: 12.4.0
|
1102
1105
|
|
@@ -1152,7 +1155,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1152
1155
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1153
1156
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1154
1157
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1155
|
-
#other-client--per-operation-configuration>`
|
1158
|
+
#other-client--per-operation-configuration>`__.
|
1156
1159
|
:returns: Blob-updated property dict (Etag and last modified).
|
1157
1160
|
:rtype: dict[str, Any]
|
1158
1161
|
"""
|
@@ -1226,7 +1229,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1226
1229
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1227
1230
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1228
1231
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1229
|
-
#other-client--per-operation-configuration>`
|
1232
|
+
#other-client--per-operation-configuration>`__.
|
1230
1233
|
:returns: Blob-updated property dict (Snapshot ID, Etag, and last modified).
|
1231
1234
|
:rtype: dict[str, Any]
|
1232
1235
|
|
@@ -1308,7 +1311,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1308
1311
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
1309
1312
|
and tag values must be between 0 and 256 characters.
|
1310
1313
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
1311
|
-
space (
|
1314
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_).
|
1312
1315
|
|
1313
1316
|
The (case-sensitive) literal "COPY" can instead be passed to copy tags from the source blob.
|
1314
1317
|
This option is only available when `incremental_copy=False` and `requires_sync=True`.
|
@@ -1386,7 +1389,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1386
1389
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1387
1390
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1388
1391
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1389
|
-
#other-client--per-operation-configuration>`
|
1392
|
+
#other-client--per-operation-configuration>`__.
|
1390
1393
|
:keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier:
|
1391
1394
|
A page blob tier value to set the blob to. The tier correlates to the size of the
|
1392
1395
|
blob and number of allowed IOPS. This is only applicable to page blobs on
|
@@ -1516,7 +1519,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1516
1519
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1517
1520
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1518
1521
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1519
|
-
#other-client--per-operation-configuration>`
|
1522
|
+
#other-client--per-operation-configuration>`__.
|
1520
1523
|
:returns: A BlobLeaseClient object.
|
1521
1524
|
:rtype: ~azure.storage.blob.aio.BlobLeaseClient
|
1522
1525
|
|
@@ -1562,7 +1565,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1562
1565
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1563
1566
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1564
1567
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1565
|
-
#other-client--per-operation-configuration>`
|
1568
|
+
#other-client--per-operation-configuration>`__.
|
1566
1569
|
:keyword lease:
|
1567
1570
|
Required if the blob has an active lease. Value can be a BlobLeaseClient object
|
1568
1571
|
or the lease ID as a string.
|
@@ -1634,7 +1637,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1634
1637
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1635
1638
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1636
1639
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1637
|
-
#other-client--per-operation-configuration>`
|
1640
|
+
#other-client--per-operation-configuration>`__.
|
1638
1641
|
:returns: Blob property dict.
|
1639
1642
|
:rtype: Dict[str, Any]
|
1640
1643
|
"""
|
@@ -1694,7 +1697,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1694
1697
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1695
1698
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1696
1699
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1697
|
-
#other-client--per-operation-configuration>`
|
1700
|
+
#other-client--per-operation-configuration>`__.
|
1698
1701
|
:keyword str source_authorization:
|
1699
1702
|
Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is
|
1700
1703
|
the prefix of the source_authorization string.
|
@@ -1738,7 +1741,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1738
1741
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1739
1742
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1740
1743
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1741
|
-
#other-client--per-operation-configuration>`
|
1744
|
+
#other-client--per-operation-configuration>`__.
|
1742
1745
|
:returns: A tuple of two lists - committed and uncommitted blocks
|
1743
1746
|
:rtype: tuple(list(~azure.storage.blob.BlobBlock), list(~azure.storage.blob.BlobBlock))
|
1744
1747
|
"""
|
@@ -1780,7 +1783,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1780
1783
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
1781
1784
|
and tag values must be between 0 and 256 characters.
|
1782
1785
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
1783
|
-
space (
|
1786
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
|
1784
1787
|
|
1785
1788
|
.. versionadded:: 12.4.0
|
1786
1789
|
|
@@ -1852,7 +1855,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1852
1855
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1853
1856
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1854
1857
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1855
|
-
#other-client--per-operation-configuration>`
|
1858
|
+
#other-client--per-operation-configuration>`__.
|
1856
1859
|
:returns: Blob-updated property dict (Etag and last modified).
|
1857
1860
|
:rtype: dict(str, Any)
|
1858
1861
|
"""
|
@@ -1887,7 +1890,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1887
1890
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1888
1891
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1889
1892
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1890
|
-
#other-client--per-operation-configuration>`
|
1893
|
+
#other-client--per-operation-configuration>`__.
|
1891
1894
|
:keyword lease:
|
1892
1895
|
Required if the blob has an active lease. Value can be a BlobLeaseClient object
|
1893
1896
|
or the lease ID as a string.
|
@@ -1923,7 +1926,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1923
1926
|
The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
|
1924
1927
|
and tag values must be between 0 and 256 characters.
|
1925
1928
|
Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
|
1926
|
-
space (
|
1929
|
+
space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
|
1927
1930
|
:type tags: dict(str, str)
|
1928
1931
|
:keyword str version_id:
|
1929
1932
|
The version id parameter is an opaque DateTime
|
@@ -1947,7 +1950,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1947
1950
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1948
1951
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1949
1952
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1950
|
-
#other-client--per-operation-configuration>`
|
1953
|
+
#other-client--per-operation-configuration>`__.
|
1951
1954
|
:returns: Blob-updated property dict (Etag and last modified)
|
1952
1955
|
:rtype: Dict[str, Any]
|
1953
1956
|
"""
|
@@ -1980,7 +1983,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
1980
1983
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
1981
1984
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
1982
1985
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
1983
|
-
#other-client--per-operation-configuration>`
|
1986
|
+
#other-client--per-operation-configuration>`__.
|
1984
1987
|
:returns: Key value pairs of blob tags.
|
1985
1988
|
:rtype: Dict[str, str]
|
1986
1989
|
"""
|
@@ -2052,7 +2055,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2052
2055
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2053
2056
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2054
2057
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2055
|
-
#other-client--per-operation-configuration>`
|
2058
|
+
#other-client--per-operation-configuration>`__.
|
2056
2059
|
:returns:
|
2057
2060
|
A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys.
|
2058
2061
|
The first element are filled page ranges, the 2nd element is cleared page ranges.
|
@@ -2144,7 +2147,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2144
2147
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2145
2148
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2146
2149
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2147
|
-
#other-client--per-operation-configuration>`
|
2150
|
+
#other-client--per-operation-configuration>`__.
|
2148
2151
|
:returns: An iterable (auto-paging) of PageRange.
|
2149
2152
|
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange]
|
2150
2153
|
"""
|
@@ -2227,7 +2230,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2227
2230
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2228
2231
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2229
2232
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2230
|
-
#other-client--per-operation-configuration>`
|
2233
|
+
#other-client--per-operation-configuration>`__.
|
2231
2234
|
:returns:
|
2232
2235
|
A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys.
|
2233
2236
|
The first element are filled page ranges, the 2nd element is cleared page ranges.
|
@@ -2292,7 +2295,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2292
2295
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2293
2296
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2294
2297
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2295
|
-
#other-client--per-operation-configuration>`
|
2298
|
+
#other-client--per-operation-configuration>`__.
|
2296
2299
|
:returns: Blob-updated property dict (Etag and last modified).
|
2297
2300
|
:rtype: dict(str, Any)
|
2298
2301
|
"""
|
@@ -2350,7 +2353,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2350
2353
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2351
2354
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2352
2355
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2353
|
-
#other-client--per-operation-configuration>`
|
2356
|
+
#other-client--per-operation-configuration>`__.
|
2354
2357
|
:returns: Blob-updated property dict (Etag and last modified).
|
2355
2358
|
:rtype: dict(str, Any)
|
2356
2359
|
"""
|
@@ -2445,7 +2448,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2445
2448
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2446
2449
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2447
2450
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2448
|
-
#other-client--per-operation-configuration>`
|
2451
|
+
#other-client--per-operation-configuration>`__.
|
2449
2452
|
:returns: Blob-updated property dict (Etag and last modified).
|
2450
2453
|
:rtype: dict(str, Any)
|
2451
2454
|
"""
|
@@ -2560,7 +2563,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2560
2563
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2561
2564
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2562
2565
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2563
|
-
#other-client--per-operation-configuration>`
|
2566
|
+
#other-client--per-operation-configuration>`__.
|
2564
2567
|
:keyword str source_authorization:
|
2565
2568
|
Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is
|
2566
2569
|
the prefix of the source_authorization string.
|
@@ -2641,7 +2644,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2641
2644
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2642
2645
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2643
2646
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2644
|
-
#other-client--per-operation-configuration>`
|
2647
|
+
#other-client--per-operation-configuration>`__.
|
2645
2648
|
:returns: Blob-updated property dict (Etag and last modified).
|
2646
2649
|
:rtype: dict(str, Any)
|
2647
2650
|
"""
|
@@ -2731,7 +2734,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2731
2734
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2732
2735
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2733
2736
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2734
|
-
#other-client--per-operation-configuration>`
|
2737
|
+
#other-client--per-operation-configuration>`__.
|
2735
2738
|
:returns: Blob-updated property dict (Etag, last modified, append offset, committed block count).
|
2736
2739
|
:rtype: dict(str, Any)
|
2737
2740
|
"""
|
@@ -2838,7 +2841,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2838
2841
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2839
2842
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2840
2843
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2841
|
-
#other-client--per-operation-configuration>`
|
2844
|
+
#other-client--per-operation-configuration>`__.
|
2842
2845
|
:keyword str source_authorization:
|
2843
2846
|
Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is
|
2844
2847
|
the prefix of the source_authorization string.
|
@@ -2895,7 +2898,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
|
|
2895
2898
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
2896
2899
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
2897
2900
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
2898
|
-
#other-client--per-operation-configuration>`
|
2901
|
+
#other-client--per-operation-configuration>`__.
|
2899
2902
|
:returns: Blob-updated property dict (Etag, last modified, append offset, committed block count).
|
2900
2903
|
:rtype: dict(str, Any)
|
2901
2904
|
"""
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# Licensed under the MIT License. See License.txt in the project root for
|
4
4
|
# license information.
|
5
5
|
# --------------------------------------------------------------------------
|
6
|
-
# pylint: disable=invalid-overridden-method
|
6
|
+
# pylint: disable=invalid-overridden-method, docstring-keyword-should-match-keyword-only
|
7
7
|
|
8
8
|
import functools
|
9
9
|
import warnings
|
@@ -151,7 +151,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
151
151
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
152
152
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
153
153
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
154
|
-
#other-client--per-operation-configuration>`
|
154
|
+
#other-client--per-operation-configuration>`__.
|
155
155
|
:return: The user delegation key.
|
156
156
|
:rtype: ~azure.storage.blob.UserDelegationKey
|
157
157
|
"""
|
@@ -217,7 +217,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
217
217
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
218
218
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
219
219
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
220
|
-
#other-client--per-operation-configuration>`
|
220
|
+
#other-client--per-operation-configuration>`__.
|
221
221
|
:return: The blob service stats.
|
222
222
|
:rtype: Dict[str, Any]
|
223
223
|
|
@@ -249,7 +249,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
249
249
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
250
250
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
251
251
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
252
|
-
#other-client--per-operation-configuration>`
|
252
|
+
#other-client--per-operation-configuration>`__.
|
253
253
|
:returns: An object containing blob service properties such as
|
254
254
|
analytics logging, hour/minute metrics, cors rules, etc.
|
255
255
|
:rtype: Dict[str, Any]
|
@@ -320,7 +320,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
320
320
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
321
321
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
322
322
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
323
|
-
#other-client--per-operation-configuration>`
|
323
|
+
#other-client--per-operation-configuration>`__.
|
324
324
|
:rtype: None
|
325
325
|
|
326
326
|
.. admonition:: Example:
|
@@ -385,7 +385,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
385
385
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
386
386
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
387
387
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
388
|
-
#other-client--per-operation-configuration>`
|
388
|
+
#other-client--per-operation-configuration>`__.
|
389
389
|
:returns: An iterable (auto-paging) of ContainerProperties.
|
390
390
|
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.ContainerProperties]
|
391
391
|
|
@@ -439,7 +439,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
439
439
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
440
440
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
441
441
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
442
|
-
#other-client--per-operation-configuration>`
|
442
|
+
#other-client--per-operation-configuration>`__.
|
443
443
|
:returns: An iterable (auto-paging) response of BlobProperties.
|
444
444
|
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.FilteredBlob]
|
445
445
|
"""
|
@@ -489,7 +489,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
489
489
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
490
490
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
491
491
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
492
|
-
#other-client--per-operation-configuration>`
|
492
|
+
#other-client--per-operation-configuration>`__.
|
493
493
|
:returns: A container client to interact with the newly created container.
|
494
494
|
:rtype: ~azure.storage.blob.aio.ContainerClient
|
495
495
|
|
@@ -551,7 +551,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
551
551
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
552
552
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
553
553
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
554
|
-
#other-client--per-operation-configuration>`
|
554
|
+
#other-client--per-operation-configuration>`__.
|
555
555
|
:rtype: None
|
556
556
|
|
557
557
|
.. admonition:: Example:
|
@@ -591,7 +591,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
591
591
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
592
592
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
593
593
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
594
|
-
#other-client--per-operation-configuration>`
|
594
|
+
#other-client--per-operation-configuration>`__.
|
595
595
|
:returns: A container client for the renamed container.
|
596
596
|
:rtype: ~azure.storage.blob.ContainerClient
|
597
597
|
"""
|
@@ -627,7 +627,7 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase, St
|
|
627
627
|
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
|
628
628
|
This value is not tracked or validated on the client. To configure client-side network timesouts
|
629
629
|
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
|
630
|
-
#other-client--per-operation-configuration>`
|
630
|
+
#other-client--per-operation-configuration>`__.
|
631
631
|
:returns: The recovered soft-deleted ContainerClient.
|
632
632
|
:rtype: ~azure.storage.blob.aio.ContainerClient
|
633
633
|
"""
|