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.
@@ -84,7 +84,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
84
84
 
85
85
  For more optional configuration, please click
86
86
  `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
87
- #optional-configuration>`__.
87
+ #optional-configuration>`_.
88
88
 
89
89
  :param str account_url:
90
90
  The URI to the storage account. In order to create a client given the full URI to the container,
@@ -306,7 +306,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
306
306
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
307
307
  This value is not tracked or validated on the client. To configure client-side network timesouts
308
308
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
309
- #other-client--per-operation-configuration>`__.
309
+ #other-client--per-operation-configuration>`_.
310
310
  :returns: A dictionary of response headers.
311
311
  :rtype: Dict[str, Union[str, datetime]]
312
312
 
@@ -352,7 +352,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
352
352
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
353
353
  This value is not tracked or validated on the client. To configure client-side network timesouts
354
354
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
355
- #other-client--per-operation-configuration>`__.
355
+ #other-client--per-operation-configuration>`_.
356
356
  :returns: The renamed container client.
357
357
  :rtype: ~azure.storage.blob.ContainerClient
358
358
  """
@@ -408,7 +408,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
408
408
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
409
409
  This value is not tracked or validated on the client. To configure client-side network timesouts
410
410
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
411
- #other-client--per-operation-configuration>`__.
411
+ #other-client--per-operation-configuration>`_.
412
412
  :rtype: None
413
413
 
414
414
  .. admonition:: Example:
@@ -474,7 +474,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
474
474
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
475
475
  This value is not tracked or validated on the client. To configure client-side network timesouts
476
476
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
477
- #other-client--per-operation-configuration>`__.
477
+ #other-client--per-operation-configuration>`_.
478
478
  :returns: A BlobLeaseClient object, that can be run in a context manager.
479
479
  :rtype: ~azure.storage.blob.BlobLeaseClient
480
480
 
@@ -524,7 +524,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
524
524
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
525
525
  This value is not tracked or validated on the client. To configure client-side network timesouts
526
526
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
527
- #other-client--per-operation-configuration>`__.
527
+ #other-client--per-operation-configuration>`_.
528
528
  :return: Properties for the specified container within a container object.
529
529
  :rtype: ~azure.storage.blob.ContainerProperties
530
530
 
@@ -562,7 +562,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
562
562
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
563
563
  This value is not tracked or validated on the client. To configure client-side network timesouts
564
564
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
565
- #other-client--per-operation-configuration>`__.
565
+ #other-client--per-operation-configuration>`_.
566
566
  :returns: boolean
567
567
  :rtype: bool
568
568
  """
@@ -614,7 +614,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
614
614
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
615
615
  This value is not tracked or validated on the client. To configure client-side network timesouts
616
616
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
617
- #other-client--per-operation-configuration>`__.
617
+ #other-client--per-operation-configuration>`_.
618
618
  :returns: Container-updated property dict (Etag and last modified).
619
619
  :rtype: dict[str, str or datetime]
620
620
 
@@ -693,7 +693,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
693
693
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
694
694
  This value is not tracked or validated on the client. To configure client-side network timesouts
695
695
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
696
- #other-client--per-operation-configuration>`__.
696
+ #other-client--per-operation-configuration>`_.
697
697
  :returns: Access policy information in a dict.
698
698
  :rtype: dict[str, Any]
699
699
 
@@ -760,7 +760,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
760
760
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
761
761
  This value is not tracked or validated on the client. To configure client-side network timesouts
762
762
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
763
- #other-client--per-operation-configuration>`__.
763
+ #other-client--per-operation-configuration>`_.
764
764
  :returns: Container-updated property dict (Etag and last modified).
765
765
  :rtype: dict[str, str or ~datetime.datetime]
766
766
 
@@ -823,7 +823,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
823
823
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
824
824
  This value is not tracked or validated on the client. To configure client-side network timesouts
825
825
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
826
- #other-client--per-operation-configuration>`__.
826
+ #other-client--per-operation-configuration>`_.
827
827
  :returns: An iterable (auto-paging) response of BlobProperties.
828
828
  :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
829
829
 
@@ -872,7 +872,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
872
872
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
873
873
  This value is not tracked or validated on the client. To configure client-side network timesouts
874
874
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
875
- #other-client--per-operation-configuration>`__.
875
+ #other-client--per-operation-configuration>`_.
876
876
  :returns: An iterable (auto-paging) response of blob names as strings.
877
877
  :rtype: ~azure.core.paging.ItemPaged[str]
878
878
  """
@@ -929,7 +929,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
929
929
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
930
930
  This value is not tracked or validated on the client. To configure client-side network timesouts
931
931
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
932
- #other-client--per-operation-configuration>`__.
932
+ #other-client--per-operation-configuration>`_.
933
933
  :returns: An iterable (auto-paging) response of BlobProperties.
934
934
  :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
935
935
  """
@@ -975,7 +975,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
975
975
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
976
976
  This value is not tracked or validated on the client. To configure client-side network timesouts
977
977
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
978
- #other-client--per-operation-configuration>`__.
978
+ #other-client--per-operation-configuration>`_.
979
979
  :returns: An iterable (auto-paging) response of FilteredBlob.
980
980
  :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
981
981
  """
@@ -1062,7 +1062,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1062
1062
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1063
1063
  This value is not tracked or validated on the client. To configure client-side network timesouts
1064
1064
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1065
- #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
1065
+ #other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
1066
1066
  the timeout will apply to each call individually.
1067
1067
  :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier:
1068
1068
  A page blob tier value to set the blob to. The tier correlates to the size of the
@@ -1163,7 +1163,6 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1163
1163
  value that, when present, specifies the version of the blob to delete.
1164
1164
 
1165
1165
  .. versionadded:: 12.4.0
1166
-
1167
1166
  This keyword argument was introduced in API version '2019-12-12'.
1168
1167
 
1169
1168
  :keyword lease:
@@ -1198,7 +1197,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1198
1197
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1199
1198
  This value is not tracked or validated on the client. To configure client-side network timesouts
1200
1199
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1201
- #other-client--per-operation-configuration>`__.
1200
+ #other-client--per-operation-configuration>`_.
1202
1201
  :rtype: None
1203
1202
  """
1204
1203
  if isinstance(blob, BlobProperties):
@@ -1262,7 +1261,6 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1262
1261
  value that, when present, specifies the version of the blob to download.
1263
1262
 
1264
1263
  .. versionadded:: 12.4.0
1265
-
1266
1264
  This keyword argument was introduced in API version '2019-12-12'.
1267
1265
 
1268
1266
  :keyword bool validate_content:
@@ -1321,7 +1319,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1321
1319
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1322
1320
  This value is not tracked or validated on the client. To configure client-side network timesouts
1323
1321
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1324
- #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
1322
+ #other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
1325
1323
  the timeout will apply to each call individually.
1326
1324
  multiple calls to the Azure service and the timeout will apply to
1327
1325
  each call individually.
@@ -1540,7 +1538,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1540
1538
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1541
1539
  This value is not tracked or validated on the client. To configure client-side network timesouts
1542
1540
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1543
- #other-client--per-operation-configuration>`__.
1541
+ #other-client--per-operation-configuration>`_.
1544
1542
  :return: An iterator of responses, one for each blob in order
1545
1543
  :rtype: Iterator[~azure.core.pipeline.transport.HttpResponse]
1546
1544
 
@@ -1710,7 +1708,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1710
1708
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1711
1709
  This value is not tracked or validated on the client. To configure client-side network timesouts
1712
1710
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1713
- #other-client--per-operation-configuration>`__.
1711
+ #other-client--per-operation-configuration>`_.
1714
1712
  :keyword bool raise_on_any_failure:
1715
1713
  This is a boolean param which defaults to True. When this is set, an exception
1716
1714
  is raised even if there is a single operation failure.
@@ -1763,7 +1761,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py
1763
1761
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1764
1762
  This value is not tracked or validated on the client. To configure client-side network timesouts
1765
1763
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1766
- #other-client--per-operation-configuration>`__.
1764
+ #other-client--per-operation-configuration>`_.
1767
1765
  :keyword bool raise_on_any_failure:
1768
1766
  This is a boolean param which defaults to True. When this is set, an exception
1769
1767
  is raised even if there is a single operation failure.