Skip to content

Commit e4edec7

Browse files
[Storage] Fix documentation for timeout in all Storage packages (Azure#28513)
1 parent c3c3ad5 commit e4edec7

34 files changed

+2057
-428
lines changed

sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py

Lines changed: 189 additions & 43 deletions
Large diffs are not rendered by default.

sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,11 @@ def get_user_delegation_key(self, key_start_time, # type: datetime
196196
:param ~datetime.datetime key_expiry_time:
197197
A DateTime value. Indicates when the key stops being valid.
198198
:keyword int timeout:
199-
The timeout parameter is expressed in seconds.
199+
Sets the server-side timeout for the operation in seconds. For more details see
200+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
201+
This value is not tracked or validated on the client. To configure client-side network timesouts
202+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
203+
#other-client--per-operation-configuration>`_.
200204
:return: The user delegation key.
201205
:rtype: ~azure.storage.blob.UserDelegationKey
202206
"""
@@ -258,7 +262,11 @@ def get_service_stats(self, **kwargs):
258262
replication is enabled for your storage account.
259263
260264
:keyword int timeout:
261-
The timeout parameter is expressed in seconds.
265+
Sets the server-side timeout for the operation in seconds. For more details see
266+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
267+
This value is not tracked or validated on the client. To configure client-side network timesouts
268+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
269+
#other-client--per-operation-configuration>`_.
262270
:return: The blob service stats.
263271
:rtype: Dict[str, Any]
264272
@@ -286,7 +294,11 @@ def get_service_properties(self, **kwargs):
286294
Azure Storage Analytics.
287295
288296
:keyword int timeout:
289-
The timeout parameter is expressed in seconds.
297+
Sets the server-side timeout for the operation in seconds. For more details see
298+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
299+
This value is not tracked or validated on the client. To configure client-side network timesouts
300+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
301+
#other-client--per-operation-configuration>`_.
290302
:returns: An object containing blob service properties such as
291303
analytics logging, hour/minute metrics, cors rules, etc.
292304
:rtype: Dict[str, Any]
@@ -353,7 +365,11 @@ def set_service_properties(
353365
and if yes, indicates the index document and 404 error document to use.
354366
:type static_website: ~azure.storage.blob.StaticWebsite
355367
:keyword int timeout:
356-
The timeout parameter is expressed in seconds.
368+
Sets the server-side timeout for the operation in seconds. For more details see
369+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
370+
This value is not tracked or validated on the client. To configure client-side network timesouts
371+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
372+
#other-client--per-operation-configuration>`_.
357373
:rtype: None
358374
359375
.. admonition:: Example:
@@ -414,7 +430,11 @@ def list_containers(
414430
The maximum number of container names to retrieve per API
415431
call. If the request does not specify the server will return up to 5,000 items.
416432
:keyword int timeout:
417-
The timeout parameter is expressed in seconds.
433+
Sets the server-side timeout for the operation in seconds. For more details see
434+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
435+
This value is not tracked or validated on the client. To configure client-side network timesouts
436+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
437+
#other-client--per-operation-configuration>`_.
418438
:returns: An iterable (auto-paging) of ContainerProperties.
419439
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.ContainerProperties]
420440
@@ -465,7 +485,11 @@ def find_blobs_by_tags(self, filter_expression, **kwargs):
465485
:keyword int results_per_page:
466486
The max result per page when paginating.
467487
:keyword int timeout:
468-
The timeout parameter is expressed in seconds.
488+
Sets the server-side timeout for the operation in seconds. For more details see
489+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
490+
This value is not tracked or validated on the client. To configure client-side network timesouts
491+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
492+
#other-client--per-operation-configuration>`_.
469493
:returns: An iterable (auto-paging) response of BlobProperties.
470494
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.FilteredBlob]
471495
"""
@@ -511,7 +535,11 @@ def create_container(
511535
512536
:paramtype container_encryption_scope: dict or ~azure.storage.blob.ContainerEncryptionScope
513537
:keyword int timeout:
514-
The timeout parameter is expressed in seconds.
538+
Sets the server-side timeout for the operation in seconds. For more details see
539+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
540+
This value is not tracked or validated on the client. To configure client-side network timesouts
541+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
542+
#other-client--per-operation-configuration>`_.
515543
:rtype: ~azure.storage.blob.ContainerClient
516544
517545
.. admonition:: Example:
@@ -569,7 +597,11 @@ def delete_container(
569597
:keyword ~azure.core.MatchConditions match_condition:
570598
The match condition to use upon the etag.
571599
:keyword int timeout:
572-
The timeout parameter is expressed in seconds.
600+
Sets the server-side timeout for the operation in seconds. For more details see
601+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
602+
This value is not tracked or validated on the client. To configure client-side network timesouts
603+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
604+
#other-client--per-operation-configuration>`_.
573605
:rtype: None
574606
575607
.. admonition:: Example:
@@ -605,7 +637,11 @@ def _rename_container(self, name, new_name, **kwargs):
605637
matches the active lease ID of the source container.
606638
:paramtype lease: ~azure.storage.blob.BlobLeaseClient or str
607639
:keyword int timeout:
608-
The timeout parameter is expressed in seconds.
640+
Sets the server-side timeout for the operation in seconds. For more details see
641+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
642+
This value is not tracked or validated on the client. To configure client-side network timesouts
643+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
644+
#other-client--per-operation-configuration>`_.
609645
:rtype: ~azure.storage.blob.ContainerClient
610646
"""
611647
renamed_container = self.get_container_client(new_name)
@@ -636,7 +672,11 @@ def undelete_container(self, deleted_container_name, deleted_container_version,
636672
:param str deleted_container_version:
637673
Specifies the version of the deleted container to restore.
638674
:keyword int timeout:
639-
The timeout parameter is expressed in seconds.
675+
Sets the server-side timeout for the operation in seconds. For more details see
676+
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
677+
This value is not tracked or validated on the client. To configure client-side network timesouts
678+
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
679+
#other-client--per-operation-configuration>`_.
640680
:rtype: ~azure.storage.blob.ContainerClient
641681
"""
642682
new_name = kwargs.pop('new_name', None)

0 commit comments

Comments
 (0)