azure-storage-blob 12.21.0__py3-none-any.whl → 12.21.0b1__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.
@@ -108,7 +108,7 @@ class BlobLeaseClient(object): # pylint: disable=client-accepts-api-version-key
108
108
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
109
109
  This value is not tracked or validated on the client. To configure client-side network timesouts
110
110
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
111
- #other-client--per-operation-configuration>`__.
111
+ #other-client--per-operation-configuration>`_.
112
112
  :rtype: None
113
113
  """
114
114
  mod_conditions = get_modify_conditions(kwargs)
@@ -165,7 +165,7 @@ class BlobLeaseClient(object): # pylint: disable=client-accepts-api-version-key
165
165
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
166
166
  This value is not tracked or validated on the client. To configure client-side network timesouts
167
167
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
168
- #other-client--per-operation-configuration>`__.
168
+ #other-client--per-operation-configuration>`_.
169
169
  :return: None
170
170
  """
171
171
  mod_conditions = get_modify_conditions(kwargs)
@@ -219,7 +219,7 @@ class BlobLeaseClient(object): # pylint: disable=client-accepts-api-version-key
219
219
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
220
220
  This value is not tracked or validated on the client. To configure client-side network timesouts
221
221
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
222
- #other-client--per-operation-configuration>`__.
222
+ #other-client--per-operation-configuration>`_.
223
223
  :return: None
224
224
  """
225
225
  mod_conditions = get_modify_conditions(kwargs)
@@ -272,7 +272,7 @@ class BlobLeaseClient(object): # pylint: disable=client-accepts-api-version-key
272
272
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
273
273
  This value is not tracked or validated on the client. To configure client-side network timesouts
274
274
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
275
- #other-client--per-operation-configuration>`__.
275
+ #other-client--per-operation-configuration>`_.
276
276
  :return: None
277
277
  """
278
278
  mod_conditions = get_modify_conditions(kwargs)
@@ -335,7 +335,7 @@ class BlobLeaseClient(object): # pylint: disable=client-accepts-api-version-key
335
335
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
336
336
  This value is not tracked or validated on the client. To configure client-side network timesouts
337
337
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
338
- #other-client--per-operation-configuration>`__.
338
+ #other-client--per-operation-configuration>`_.
339
339
  :return: Approximate time remaining in the lease period, in seconds.
340
340
  :rtype: int
341
341
  """
@@ -1064,7 +1064,7 @@ class ContainerEncryptionScope(object):
1064
1064
  class DelimitedJsonDialect(DictMixin):
1065
1065
  """Defines the input or output JSON serialization for a blob data query.
1066
1066
 
1067
- :keyword str delimiter: The line separator character, default value is '\\\\n'.
1067
+ :keyword str delimiter: The line separator character, default value is '\n'
1068
1068
  """
1069
1069
 
1070
1070
  def __init__(self, **kwargs):
@@ -4,4 +4,4 @@
4
4
  # license information.
5
5
  # --------------------------------------------------------------------------
6
6
 
7
- VERSION = "12.21.0"
7
+ VERSION = "12.21.0b1"
@@ -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
- 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.
170
+ If the source is in another account, the source must either be public
171
+ or must be authenticated via a shared access signature. If the source
172
+ 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 (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
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 (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
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>`__. This method may make multiple calls to the service and
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,7 +463,6 @@ 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
-
467
466
  This keyword argument was introduced in API version '2019-12-12'.
468
467
 
469
468
  :keyword bool validate_content:
@@ -522,7 +521,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
522
521
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
523
522
  This value is not tracked or validated on the client. To configure client-side network timesouts
524
523
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
525
- #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
524
+ #other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
526
525
  the timeout will apply to each call individually.
527
526
  multiple calls to the Azure service and the timeout will apply to
528
527
  each call individually.
@@ -572,7 +571,6 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
572
571
  value that, when present, specifies the version of the blob to delete.
573
572
 
574
573
  .. versionadded:: 12.4.0
575
-
576
574
  This keyword argument was introduced in API version '2019-12-12'.
577
575
 
578
576
  :keyword lease:
@@ -608,7 +606,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
608
606
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
609
607
  This value is not tracked or validated on the client. To configure client-side network timesouts
610
608
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
611
- #other-client--per-operation-configuration>`__.
609
+ #other-client--per-operation-configuration>`_.
612
610
  :rtype: None
613
611
 
614
612
  .. admonition:: Example:
@@ -643,7 +641,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
643
641
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
644
642
  This value is not tracked or validated on the client. To configure client-side network timesouts
645
643
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
646
- #other-client--per-operation-configuration>`__.
644
+ #other-client--per-operation-configuration>`_.
647
645
  :rtype: None
648
646
 
649
647
  .. admonition:: Example:
@@ -675,7 +673,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
675
673
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
676
674
  This value is not tracked or validated on the client. To configure client-side network timesouts
677
675
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
678
- #other-client--per-operation-configuration>`__.
676
+ #other-client--per-operation-configuration>`_.
679
677
  :returns: boolean
680
678
  :rtype: bool
681
679
  """
@@ -710,7 +708,6 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
710
708
  value that, when present, specifies the version of the blob to get properties.
711
709
 
712
710
  .. versionadded:: 12.4.0
713
-
714
711
  This keyword argument was introduced in API version '2019-12-12'.
715
712
 
716
713
  :keyword ~datetime.datetime if_modified_since:
@@ -746,7 +743,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
746
743
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
747
744
  This value is not tracked or validated on the client. To configure client-side network timesouts
748
745
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
749
- #other-client--per-operation-configuration>`__.
746
+ #other-client--per-operation-configuration>`_.
750
747
  :returns: BlobProperties
751
748
  :rtype: ~azure.storage.blob.BlobProperties
752
749
 
@@ -832,7 +829,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
832
829
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
833
830
  This value is not tracked or validated on the client. To configure client-side network timesouts
834
831
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
835
- #other-client--per-operation-configuration>`__.
832
+ #other-client--per-operation-configuration>`_.
836
833
  :returns: Blob-updated property dict (Etag and last modified)
837
834
  :rtype: Dict[str, Any]
838
835
  """
@@ -897,7 +894,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
897
894
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
898
895
  This value is not tracked or validated on the client. To configure client-side network timesouts
899
896
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
900
- #other-client--per-operation-configuration>`__.
897
+ #other-client--per-operation-configuration>`_.
901
898
  :returns: Blob-updated property dict (Etag and last modified)
902
899
  :rtype: Dict[str, Union[str, datetime]]
903
900
  """
@@ -926,7 +923,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
926
923
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
927
924
  This value is not tracked or validated on the client. To configure client-side network timesouts
928
925
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
929
- #other-client--per-operation-configuration>`__.
926
+ #other-client--per-operation-configuration>`_.
930
927
  :returns: Key value pairs of blob tags.
931
928
  :rtype: Dict[str, str]
932
929
  """
@@ -948,7 +945,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
948
945
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
949
946
  This value is not tracked or validated on the client. To configure client-side network timesouts
950
947
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
951
- #other-client--per-operation-configuration>`__.
948
+ #other-client--per-operation-configuration>`_.
952
949
  :returns: Key value pairs of blob tags.
953
950
  :rtype: Dict[str, str]
954
951
  """
@@ -970,7 +967,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
970
967
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
971
968
  This value is not tracked or validated on the client. To configure client-side network timesouts
972
969
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
973
- #other-client--per-operation-configuration>`__.
970
+ #other-client--per-operation-configuration>`_.
974
971
  :returns: Key value pairs of blob tags.
975
972
  :rtype: Dict[str, Union[str, datetime, bool]]
976
973
  """
@@ -1006,7 +1003,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1006
1003
  The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
1007
1004
  and tag values must be between 0 and 256 characters.
1008
1005
  Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
1009
- space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1006
+ space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1010
1007
 
1011
1008
  .. versionadded:: 12.4.0
1012
1009
 
@@ -1066,7 +1063,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1066
1063
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1067
1064
  This value is not tracked or validated on the client. To configure client-side network timesouts
1068
1065
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1069
- #other-client--per-operation-configuration>`__.
1066
+ #other-client--per-operation-configuration>`_.
1070
1067
  :returns: Blob-updated property dict (Etag and last modified).
1071
1068
  :rtype: dict[str, Any]
1072
1069
  """
@@ -1099,7 +1096,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1099
1096
  The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
1100
1097
  and tag values must be between 0 and 256 characters.
1101
1098
  Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
1102
- space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1099
+ space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1103
1100
 
1104
1101
  .. versionadded:: 12.4.0
1105
1102
 
@@ -1155,7 +1152,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1155
1152
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1156
1153
  This value is not tracked or validated on the client. To configure client-side network timesouts
1157
1154
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1158
- #other-client--per-operation-configuration>`__.
1155
+ #other-client--per-operation-configuration>`_.
1159
1156
  :returns: Blob-updated property dict (Etag and last modified).
1160
1157
  :rtype: dict[str, Any]
1161
1158
  """
@@ -1229,7 +1226,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1229
1226
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1230
1227
  This value is not tracked or validated on the client. To configure client-side network timesouts
1231
1228
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1232
- #other-client--per-operation-configuration>`__.
1229
+ #other-client--per-operation-configuration>`_.
1233
1230
  :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified).
1234
1231
  :rtype: dict[str, Any]
1235
1232
 
@@ -1311,7 +1308,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1311
1308
  The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
1312
1309
  and tag values must be between 0 and 256 characters.
1313
1310
  Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
1314
- space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_).
1311
+ space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_).
1315
1312
 
1316
1313
  The (case-sensitive) literal "COPY" can instead be passed to copy tags from the source blob.
1317
1314
  This option is only available when `incremental_copy=False` and `requires_sync=True`.
@@ -1389,7 +1386,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1389
1386
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1390
1387
  This value is not tracked or validated on the client. To configure client-side network timesouts
1391
1388
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1392
- #other-client--per-operation-configuration>`__.
1389
+ #other-client--per-operation-configuration>`_.
1393
1390
  :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier:
1394
1391
  A page blob tier value to set the blob to. The tier correlates to the size of the
1395
1392
  blob and number of allowed IOPS. This is only applicable to page blobs on
@@ -1519,7 +1516,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1519
1516
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1520
1517
  This value is not tracked or validated on the client. To configure client-side network timesouts
1521
1518
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1522
- #other-client--per-operation-configuration>`__.
1519
+ #other-client--per-operation-configuration>`_.
1523
1520
  :returns: A BlobLeaseClient object.
1524
1521
  :rtype: ~azure.storage.blob.aio.BlobLeaseClient
1525
1522
 
@@ -1565,7 +1562,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1565
1562
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1566
1563
  This value is not tracked or validated on the client. To configure client-side network timesouts
1567
1564
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1568
- #other-client--per-operation-configuration>`__.
1565
+ #other-client--per-operation-configuration>`_.
1569
1566
  :keyword lease:
1570
1567
  Required if the blob has an active lease. Value can be a BlobLeaseClient object
1571
1568
  or the lease ID as a string.
@@ -1637,7 +1634,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1637
1634
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1638
1635
  This value is not tracked or validated on the client. To configure client-side network timesouts
1639
1636
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1640
- #other-client--per-operation-configuration>`__.
1637
+ #other-client--per-operation-configuration>`_.
1641
1638
  :returns: Blob property dict.
1642
1639
  :rtype: Dict[str, Any]
1643
1640
  """
@@ -1697,7 +1694,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1697
1694
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1698
1695
  This value is not tracked or validated on the client. To configure client-side network timesouts
1699
1696
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1700
- #other-client--per-operation-configuration>`__.
1697
+ #other-client--per-operation-configuration>`_.
1701
1698
  :keyword str source_authorization:
1702
1699
  Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is
1703
1700
  the prefix of the source_authorization string.
@@ -1741,7 +1738,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1741
1738
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1742
1739
  This value is not tracked or validated on the client. To configure client-side network timesouts
1743
1740
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1744
- #other-client--per-operation-configuration>`__.
1741
+ #other-client--per-operation-configuration>`_.
1745
1742
  :returns: A tuple of two lists - committed and uncommitted blocks
1746
1743
  :rtype: tuple(list(~azure.storage.blob.BlobBlock), list(~azure.storage.blob.BlobBlock))
1747
1744
  """
@@ -1783,7 +1780,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1783
1780
  The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
1784
1781
  and tag values must be between 0 and 256 characters.
1785
1782
  Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
1786
- space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1783
+ space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1787
1784
 
1788
1785
  .. versionadded:: 12.4.0
1789
1786
 
@@ -1855,7 +1852,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1855
1852
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1856
1853
  This value is not tracked or validated on the client. To configure client-side network timesouts
1857
1854
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1858
- #other-client--per-operation-configuration>`__.
1855
+ #other-client--per-operation-configuration>`_.
1859
1856
  :returns: Blob-updated property dict (Etag and last modified).
1860
1857
  :rtype: dict(str, Any)
1861
1858
  """
@@ -1890,7 +1887,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1890
1887
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1891
1888
  This value is not tracked or validated on the client. To configure client-side network timesouts
1892
1889
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1893
- #other-client--per-operation-configuration>`__.
1890
+ #other-client--per-operation-configuration>`_.
1894
1891
  :keyword lease:
1895
1892
  Required if the blob has an active lease. Value can be a BlobLeaseClient object
1896
1893
  or the lease ID as a string.
@@ -1926,7 +1923,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1926
1923
  The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters,
1927
1924
  and tag values must be between 0 and 256 characters.
1928
1925
  Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9),
1929
- space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1926
+ space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)
1930
1927
  :type tags: dict(str, str)
1931
1928
  :keyword str version_id:
1932
1929
  The version id parameter is an opaque DateTime
@@ -1950,7 +1947,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1950
1947
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1951
1948
  This value is not tracked or validated on the client. To configure client-side network timesouts
1952
1949
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1953
- #other-client--per-operation-configuration>`__.
1950
+ #other-client--per-operation-configuration>`_.
1954
1951
  :returns: Blob-updated property dict (Etag and last modified)
1955
1952
  :rtype: Dict[str, Any]
1956
1953
  """
@@ -1983,7 +1980,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
1983
1980
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1984
1981
  This value is not tracked or validated on the client. To configure client-side network timesouts
1985
1982
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1986
- #other-client--per-operation-configuration>`__.
1983
+ #other-client--per-operation-configuration>`_.
1987
1984
  :returns: Key value pairs of blob tags.
1988
1985
  :rtype: Dict[str, str]
1989
1986
  """
@@ -2055,7 +2052,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2055
2052
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2056
2053
  This value is not tracked or validated on the client. To configure client-side network timesouts
2057
2054
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2058
- #other-client--per-operation-configuration>`__.
2055
+ #other-client--per-operation-configuration>`_.
2059
2056
  :returns:
2060
2057
  A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys.
2061
2058
  The first element are filled page ranges, the 2nd element is cleared page ranges.
@@ -2147,7 +2144,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2147
2144
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2148
2145
  This value is not tracked or validated on the client. To configure client-side network timesouts
2149
2146
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2150
- #other-client--per-operation-configuration>`__.
2147
+ #other-client--per-operation-configuration>`_.
2151
2148
  :returns: An iterable (auto-paging) of PageRange.
2152
2149
  :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange]
2153
2150
  """
@@ -2230,7 +2227,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2230
2227
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2231
2228
  This value is not tracked or validated on the client. To configure client-side network timesouts
2232
2229
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2233
- #other-client--per-operation-configuration>`__.
2230
+ #other-client--per-operation-configuration>`_.
2234
2231
  :returns:
2235
2232
  A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys.
2236
2233
  The first element are filled page ranges, the 2nd element is cleared page ranges.
@@ -2295,7 +2292,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2295
2292
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2296
2293
  This value is not tracked or validated on the client. To configure client-side network timesouts
2297
2294
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2298
- #other-client--per-operation-configuration>`__.
2295
+ #other-client--per-operation-configuration>`_.
2299
2296
  :returns: Blob-updated property dict (Etag and last modified).
2300
2297
  :rtype: dict(str, Any)
2301
2298
  """
@@ -2353,7 +2350,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2353
2350
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2354
2351
  This value is not tracked or validated on the client. To configure client-side network timesouts
2355
2352
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2356
- #other-client--per-operation-configuration>`__.
2353
+ #other-client--per-operation-configuration>`_.
2357
2354
  :returns: Blob-updated property dict (Etag and last modified).
2358
2355
  :rtype: dict(str, Any)
2359
2356
  """
@@ -2448,7 +2445,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2448
2445
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2449
2446
  This value is not tracked or validated on the client. To configure client-side network timesouts
2450
2447
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2451
- #other-client--per-operation-configuration>`__.
2448
+ #other-client--per-operation-configuration>`_.
2452
2449
  :returns: Blob-updated property dict (Etag and last modified).
2453
2450
  :rtype: dict(str, Any)
2454
2451
  """
@@ -2563,7 +2560,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2563
2560
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2564
2561
  This value is not tracked or validated on the client. To configure client-side network timesouts
2565
2562
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2566
- #other-client--per-operation-configuration>`__.
2563
+ #other-client--per-operation-configuration>`_.
2567
2564
  :keyword str source_authorization:
2568
2565
  Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is
2569
2566
  the prefix of the source_authorization string.
@@ -2644,7 +2641,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2644
2641
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2645
2642
  This value is not tracked or validated on the client. To configure client-side network timesouts
2646
2643
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2647
- #other-client--per-operation-configuration>`__.
2644
+ #other-client--per-operation-configuration>`_.
2648
2645
  :returns: Blob-updated property dict (Etag and last modified).
2649
2646
  :rtype: dict(str, Any)
2650
2647
  """
@@ -2734,7 +2731,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2734
2731
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2735
2732
  This value is not tracked or validated on the client. To configure client-side network timesouts
2736
2733
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2737
- #other-client--per-operation-configuration>`__.
2734
+ #other-client--per-operation-configuration>`_.
2738
2735
  :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count).
2739
2736
  :rtype: dict(str, Any)
2740
2737
  """
@@ -2841,7 +2838,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2841
2838
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2842
2839
  This value is not tracked or validated on the client. To configure client-side network timesouts
2843
2840
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2844
- #other-client--per-operation-configuration>`__.
2841
+ #other-client--per-operation-configuration>`_.
2845
2842
  :keyword str source_authorization:
2846
2843
  Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is
2847
2844
  the prefix of the source_authorization string.
@@ -2898,7 +2895,7 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase, StorageEncryptio
2898
2895
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
2899
2896
  This value is not tracked or validated on the client. To configure client-side network timesouts
2900
2897
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
2901
- #other-client--per-operation-configuration>`__.
2898
+ #other-client--per-operation-configuration>`_.
2902
2899
  :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count).
2903
2900
  :rtype: dict(str, Any)
2904
2901
  """
@@ -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
  """