From e4edec7a89f644a82a68bbdfe40f7f7f64c3d021 Mon Sep 17 00:00:00 2001 From: Jacob Lauzon <96087589+jalauzon-msft@users.noreply.github.com> Date: Fri, 27 Jan 2023 17:51:59 -0800 Subject: [PATCH] [Storage] Fix documentation for `timeout` in all Storage packages (#28513) --- .../azure/storage/blob/_blob_client.py | 232 ++++++++++++++---- .../storage/blob/_blob_service_client.py | 60 ++++- .../azure/storage/blob/_container_client.py | 120 +++++++-- .../azure/storage/blob/_lease.py | 30 ++- .../storage/blob/aio/_blob_client_async.py | 224 ++++++++++++++--- .../blob/aio/_blob_service_client_async.py | 60 ++++- .../blob/aio/_container_client_async.py | 118 +++++++-- .../azure/storage/blob/aio/_lease_async.py | 30 ++- .../_data_lake_directory_client.py | 48 +++- .../filedatalake/_data_lake_file_client.py | 58 ++++- .../storage/filedatalake/_data_lake_lease.py | 30 ++- .../filedatalake/_data_lake_service_client.py | 48 +++- .../filedatalake/_file_system_client.py | 96 ++++++-- .../storage/filedatalake/_path_client.py | 79 +++++- .../aio/_data_lake_directory_client_async.py | 48 +++- .../aio/_data_lake_file_client_async.py | 52 +++- .../aio/_data_lake_lease_async.py | 30 ++- .../aio/_data_lake_service_client_async.py | 48 +++- .../aio/_file_system_client_async.py | 96 ++++++-- .../filedatalake/aio/_path_client_async.py | 78 +++++- .../storage/fileshare/_directory_client.py | 90 +++++-- .../azure/storage/fileshare/_file_client.py | 120 +++++++-- .../azure/storage/fileshare/_lease.py | 30 ++- .../azure/storage/fileshare/_share_client.py | 96 ++++++-- .../fileshare/_share_service_client.py | 36 ++- .../fileshare/aio/_directory_client_async.py | 90 +++++-- .../fileshare/aio/_file_client_async.py | 120 +++++++-- .../storage/fileshare/aio/_lease_async.py | 30 ++- .../fileshare/aio/_share_client_async.py | 96 ++++++-- .../aio/_share_service_client_async.py | 36 ++- .../azure/storage/queue/_queue_client.py | 72 +++++- .../storage/queue/_queue_service_client.py | 6 +- .../storage/queue/aio/_queue_client_async.py | 72 +++++- .../queue/aio/_queue_service_client_async.py | 6 +- 34 files changed, 2057 insertions(+), 428 deletions(-) diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py index 7070da77aabf..c0a8ae46c5f2 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py @@ -559,7 +559,11 @@ def upload_blob_from_url(self, source_url, **kwargs): valid, the operation fails with status code 412 (Precondition Failed). :paramtype destination_lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword ~azure.storage.blob.ContentSettings content_settings: ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control. @@ -714,9 +718,12 @@ def upload_blob( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[int]], None] :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. :returns: Blob-updated property dict (Etag and last modified) :rtype: dict[str, Any] @@ -879,7 +886,12 @@ def download_blob( so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], None] :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. :returns: A streaming object (StorageStreamDownloader) @@ -1025,7 +1037,11 @@ def query_blob(self, query_expression, **kwargs): As the encryption key itself is provided in the request, a secure connection must be established to transfer the key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A streaming object (BlobQueryReader) :rtype: ~azure.storage.blob.BlobQueryReader @@ -1138,7 +1154,11 @@ def delete_blob(self, delete_snapshots=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -1169,7 +1189,11 @@ def undelete_blob(self, **kwargs): you wish to promote to the current version. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -1193,11 +1217,15 @@ def exists(self, **kwargs): Returns True if a blob exists with the defined parameters, and returns False otherwise. - :kwarg str version_id: + :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to check if it exists. - :kwarg int timeout: - The timeout parameter is expressed in seconds. + :keyword int timeout: + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ try: @@ -1260,7 +1288,11 @@ def get_blob_properties(self, **kwargs): As the encryption key itself is provided in the request, a secure connection must be established to transfer the key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: BlobProperties :rtype: ~azure.storage.blob.BlobProperties @@ -1365,7 +1397,11 @@ def set_http_headers(self, content_settings=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -1452,7 +1488,11 @@ def set_blob_metadata(self, metadata=None, **kwargs): .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified) """ options = self._set_blob_metadata_options(metadata=metadata, **kwargs) @@ -1476,7 +1516,11 @@ def set_immutability_policy(self, immutability_policy, **kwargs): This was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -1494,7 +1538,11 @@ def delete_immutability_policy(self, **kwargs): This operation was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -1512,7 +1560,11 @@ def set_legal_hold(self, legal_hold, **kwargs): :param bool legal_hold: Specified if a legal hold should be set on the blob. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] """ @@ -1670,7 +1722,11 @@ def create_page_blob( # type: ignore .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1802,7 +1858,11 @@ def create_append_blob(self, content_settings=None, metadata=None, **kwargs): .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1897,7 +1957,11 @@ def create_snapshot(self, metadata=None, **kwargs): .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] @@ -2124,7 +2188,11 @@ def start_copy_from_url(self, source_url, metadata=None, incremental_copy=False, the lease ID given matches the active lease ID of the source blob. :paramtype source_lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier: A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on @@ -2267,7 +2335,11 @@ def acquire_lease(self, lease_duration=-1, lease_id=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A BlobLeaseClient object. :rtype: ~azure.storage.blob.BlobLeaseClient @@ -2314,7 +2386,11 @@ def set_standard_blob_tier(self, standard_blob_tier, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -2427,7 +2503,11 @@ def stage_block( .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob property dict. :rtype: dict[str, Any] """ @@ -2527,7 +2607,11 @@ def stage_block_from_url( .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -2576,7 +2660,11 @@ def get_block_list(self, block_list_type="committed", **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists - committed and uncommitted blocks :rtype: tuple(list(~azure.storage.blob.BlobBlock), list(~azure.storage.blob.BlobBlock)) """ @@ -2755,7 +2843,11 @@ def commit_block_list( # type: ignore .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2786,9 +2878,11 @@ def set_premium_page_blob_tier(self, premium_page_blob_tier, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -2858,7 +2952,11 @@ def set_blob_tags(self, tags=None, **kwargs): or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -2901,7 +2999,11 @@ def get_blob_tags(self, **kwargs): or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -3002,7 +3104,11 @@ def get_page_ranges( # type: ignore .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -3090,7 +3196,11 @@ def list_page_ranges( :keyword int results_per_page: The maximum number of page ranges to retrieve per API call. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) of PageRange. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange] """ @@ -3169,7 +3279,11 @@ def get_page_range_diff_for_managed_disk( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -3242,7 +3356,11 @@ def set_sequence_number(self, sequence_number_action, sequence_number=None, **kw .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3320,7 +3438,11 @@ def resize_blob(self, size, **kwargs): blob and number of allowed IOPS. This is only applicable to page blobs on premium storage accounts. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3461,7 +3583,11 @@ def upload_page( # type: ignore :keyword str encoding: Defaults to UTF-8. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3633,7 +3759,11 @@ def upload_pages_from_url(self, source_url, # type: str .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -3745,7 +3875,11 @@ def clear_page(self, offset, length, **kwargs): As the encryption key itself is provided in the request, a secure connection must be established to transfer the key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3885,7 +4019,11 @@ def append_block( # type: ignore .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ @@ -4049,7 +4187,11 @@ def append_block_from_url(self, copy_source_url, # type: str .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -4123,7 +4265,11 @@ def seal_append_blob(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py index 154abaf35519..8db8b22077c7 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py @@ -196,7 +196,11 @@ def get_user_delegation_key(self, key_start_time, # type: datetime :param ~datetime.datetime key_expiry_time: A DateTime value. Indicates when the key stops being valid. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: The user delegation key. :rtype: ~azure.storage.blob.UserDelegationKey """ @@ -258,7 +262,11 @@ def get_service_stats(self, **kwargs): replication is enabled for your storage account. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: The blob service stats. :rtype: Dict[str, Any] @@ -286,7 +294,11 @@ def get_service_properties(self, **kwargs): Azure Storage Analytics. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An object containing blob service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] @@ -353,7 +365,11 @@ def set_service_properties( and if yes, indicates the index document and 404 error document to use. :type static_website: ~azure.storage.blob.StaticWebsite :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -414,7 +430,11 @@ def list_containers( The maximum number of container names to retrieve per API call. If the request does not specify the server will return up to 5,000 items. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) of ContainerProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.ContainerProperties] @@ -465,7 +485,11 @@ def find_blobs_by_tags(self, filter_expression, **kwargs): :keyword int results_per_page: The max result per page when paginating. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.FilteredBlob] """ @@ -511,7 +535,11 @@ def create_container( :paramtype container_encryption_scope: dict or ~azure.storage.blob.ContainerEncryptionScope :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.ContainerClient .. admonition:: Example: @@ -569,7 +597,11 @@ def delete_container( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -605,7 +637,11 @@ def _rename_container(self, name, new_name, **kwargs): matches the active lease ID of the source container. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.ContainerClient """ renamed_container = self.get_container_client(new_name) @@ -636,7 +672,11 @@ def undelete_container(self, deleted_container_name, deleted_container_version, :param str deleted_container_version: Specifies the version of the deleted container to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.ContainerClient """ new_name = kwargs.pop('new_name', None) diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py index 295d864a1fdd..15e45143a528 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py @@ -287,7 +287,11 @@ def create_container(self, metadata=None, public_access=None, **kwargs): :paramtype container_encryption_scope: dict or ~azure.storage.blob.ContainerEncryptionScope :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -329,7 +333,11 @@ def _rename_container(self, new_name, **kwargs): matches the active lease ID of the source container. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.ContainerClient """ lease = kwargs.pop('lease', None) @@ -380,7 +388,11 @@ def delete_container( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -442,7 +454,11 @@ def acquire_lease( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A BlobLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.blob.BlobLeaseClient @@ -488,7 +504,11 @@ def get_container_properties(self, **kwargs): container's lease is active and matches this ID. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Properties for the specified container within a container object. :rtype: ~azure.storage.blob.ContainerProperties @@ -522,7 +542,11 @@ def exists(self, **kwargs): Returns True if a container exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ try: @@ -569,7 +593,11 @@ def set_container_metadata( # type: ignore An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Container-updated property dict (Etag and last modified). :rtype: dict[str, str or datetime] @@ -644,7 +672,11 @@ def get_container_access_policy(self, **kwargs): container's lease is active and matches this ID. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Access policy information in a dict. :rtype: dict[str, Any] @@ -707,7 +739,11 @@ def set_container_access_policy( Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Container-updated property dict (Etag and last modified). :rtype: dict[str, str or ~datetime.datetime] @@ -763,7 +799,11 @@ def list_blobs(self, name_starts_with=None, include=None, **kwargs): 'tags', 'versions', 'immutabilitypolicy', 'legalhold'. :type include: list[str] or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] @@ -804,7 +844,11 @@ def list_blob_names(self, **kwargs: Any) -> ItemPaged[str]: Filters the results to return only blobs whose names begin with the specified prefix. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of blob names as strings. :rtype: ~azure.core.paging.ItemPaged[str] """ @@ -854,7 +898,11 @@ def walk_blobs( names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] """ @@ -892,7 +940,11 @@ def find_blobs_by_tags( :keyword int results_per_page: The max result per page when paginating. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of FilteredBlob. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] """ @@ -976,9 +1028,12 @@ def upload_blob( .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier: A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on @@ -1104,7 +1159,11 @@ def delete_blob( .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ blob_client = self.get_blob_client(blob) # type: ignore @@ -1215,7 +1274,12 @@ def download_blob( so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], None] :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. :returns: A streaming object (StorageStreamDownloader) @@ -1425,7 +1489,11 @@ def delete_blobs( This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: An iterator of responses, one for each blob in order :rtype: Iterator[~azure.core.pipeline.transport.HttpResponse] @@ -1593,7 +1661,11 @@ def set_standard_blob_tier_blobs( .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. @@ -1642,9 +1714,11 @@ def set_premium_page_blob_tier_blobs( :type blobs: str or dict(str, Any) or ~azure.storage.blob.BlobProperties :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py index 258b1769dbc5..dbeb335d0a96 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py @@ -103,7 +103,11 @@ def acquire(self, lease_duration=-1, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ mod_conditions = get_modify_conditions(kwargs) @@ -156,7 +160,11 @@ def renew(self, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -206,7 +214,11 @@ def release(self, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -255,7 +267,11 @@ def change(self, proposed_lease_id, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -314,7 +330,11 @@ def break_lease(self, lease_break_period=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py index 628620c4a94a..4266d36f5430 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py @@ -224,7 +224,11 @@ async def upload_blob_from_url(self, source_url, **kwargs): valid, the operation fails with status code 412 (Precondition Failed). :paramtype destination_lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword ~azure.storage.blob.ContentSettings content_settings: ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control. @@ -379,7 +383,12 @@ async def upload_blob( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[int]], Awaitable[None]] :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. :returns: Blob-updated property dict (Etag and last modified) @@ -500,7 +509,12 @@ async def download_blob( so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], Awaitable[None]] :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. :returns: A streaming object (StorageStreamDownloader) @@ -580,7 +594,11 @@ async def delete_blob(self, delete_snapshots=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -611,7 +629,11 @@ async def undelete_blob(self, **kwargs): you wish to promote to the current version. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -635,11 +657,15 @@ async def exists(self, **kwargs): Returns True if a blob exists with the defined parameters, and returns False otherwise. - :kwarg str version_id: + :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to check if it exists. - :kwarg int timeout: - The timeout parameter is expressed in seconds. + :keyword int timeout: + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ try: @@ -702,7 +728,11 @@ async def get_blob_properties(self, **kwargs): As the encryption key itself is provided in the request, a secure connection must be established to transfer the key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: BlobProperties :rtype: ~azure.storage.blob.BlobProperties @@ -783,7 +813,11 @@ async def set_http_headers(self, content_settings=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -844,7 +878,11 @@ async def set_blob_metadata(self, metadata=None, **kwargs): .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified) """ options = self._set_blob_metadata_options(metadata=metadata, **kwargs) @@ -868,7 +906,11 @@ async def set_immutability_policy(self, immutability_policy, **kwargs): This was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -886,7 +928,11 @@ async def delete_immutability_policy(self, **kwargs): This operation was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -904,7 +950,11 @@ async def set_legal_hold(self, legal_hold, **kwargs): :param bool legal_hold: Specified if a legal hold should be set on the blob. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] """ @@ -996,7 +1046,11 @@ async def create_page_blob( # type: ignore .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1079,7 +1133,11 @@ async def create_append_blob(self, content_settings=None, metadata=None, **kwarg .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1149,7 +1207,11 @@ async def create_snapshot(self, metadata=None, **kwargs): .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] @@ -1305,7 +1367,11 @@ async def start_copy_from_url(self, source_url, metadata=None, incremental_copy= the lease ID given matches the active lease ID of the source blob. :paramtype source_lease: ~azure.storage.blob.aio.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier: A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on @@ -1431,7 +1497,11 @@ async def acquire_lease(self, lease_duration=-1, lease_id=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A BlobLeaseClient object. :rtype: ~azure.storage.blob.aio.BlobLeaseClient @@ -1473,7 +1543,11 @@ async def set_standard_blob_tier(self, standard_blob_tier, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -1538,7 +1612,11 @@ async def stage_block( .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ options = self._stage_block_options( @@ -1593,7 +1671,11 @@ async def stage_block_from_url( .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -1632,7 +1714,11 @@ async def get_block_list(self, block_list_type="committed", **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists - committed and uncommitted blocks :rtype: tuple(list(~azure.storage.blob.BlobBlock), list(~azure.storage.blob.BlobBlock)) """ @@ -1742,7 +1828,11 @@ async def commit_block_list( # type: ignore .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -1773,9 +1863,11 @@ async def set_premium_page_blob_tier(self, premium_page_blob_tier, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -1831,7 +1923,11 @@ async def set_blob_tags(self, tags=None, **kwargs): or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -1860,7 +1956,11 @@ async def get_blob_tags(self, **kwargs): or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -1928,7 +2028,11 @@ async def get_page_ranges( # type: ignore .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -2016,7 +2120,11 @@ def list_page_ranges( :keyword int results_per_page: The maximum number of page ranges to retrieve per API call. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) of PageRange. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange] """ @@ -2095,7 +2203,11 @@ async def get_page_range_diff_for_managed_disk( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -2156,7 +2268,11 @@ async def set_sequence_number( # type: ignore .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2210,7 +2326,11 @@ async def resize_blob(self, size, **kwargs): blob and number of allowed IOPS. This is only applicable to page blobs on premium storage accounts. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2301,7 +2421,11 @@ async def upload_page( # type: ignore :keyword str encoding: Defaults to UTF-8. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2412,7 +2536,11 @@ async def upload_pages_from_url(self, source_url, # type: str .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -2487,7 +2615,11 @@ async def clear_page(self, offset, length, **kwargs): As the encryption key itself is provided in the request, a secure connection must be established to transfer the key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2572,7 +2704,11 @@ async def append_block( # type: ignore .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ @@ -2675,7 +2811,11 @@ async def append_block_from_url(self, copy_source_url, # type: str .. versionadded:: 12.2.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -2726,7 +2866,11 @@ async def seal_append_blob(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py index 8c962169ad13..ca006c30b205 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py @@ -144,7 +144,11 @@ async def get_user_delegation_key(self, key_start_time, # type: datetime :param ~datetime.datetime key_expiry_time: A DateTime value. Indicates when the key stops being valid. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: The user delegation key. :rtype: ~azure.storage.blob.UserDelegationKey """ @@ -206,7 +210,11 @@ async def get_service_stats(self, **kwargs): replication is enabled for your storage account. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: The blob service stats. :rtype: Dict[str, Any] @@ -234,7 +242,11 @@ async def get_service_properties(self, **kwargs): Azure Storage Analytics. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An object containing blob service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] @@ -301,7 +313,11 @@ async def set_service_properties( and if yes, indicates the index document and 404 error document to use. :type static_website: ~azure.storage.blob.StaticWebsite :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -362,7 +378,11 @@ def list_containers( The maximum number of container names to retrieve per API call. If the request does not specify the server will return up to 5,000 items. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) of ContainerProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.ContainerProperties] @@ -412,7 +432,11 @@ def find_blobs_by_tags(self, filter_expression, **kwargs): :keyword int results_per_page: The max result per page when paginating. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.FilteredBlob] """ @@ -458,7 +482,11 @@ async def create_container( :paramtype container_encryption_scope: dict or ~azure.storage.blob.ContainerEncryptionScope :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.aio.ContainerClient .. admonition:: Example: @@ -516,7 +544,11 @@ async def delete_container( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -552,7 +584,11 @@ async def _rename_container(self, name, new_name, **kwargs): matches the active lease ID of the source container. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.ContainerClient """ renamed_container = self.get_container_client(new_name) @@ -583,7 +619,11 @@ async def undelete_container(self, deleted_container_name, deleted_container_ver :param str deleted_container_version: Specifies the version of the deleted container to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.aio.ContainerClient """ new_name = kwargs.pop('new_name', None) diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py index c2f259a2bca8..70362656d342 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py @@ -152,7 +152,11 @@ async def create_container(self, metadata=None, public_access=None, **kwargs): :paramtype container_encryption_scope: dict or ~azure.storage.blob.ContainerEncryptionScope :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -194,7 +198,11 @@ async def _rename_container(self, new_name, **kwargs): matches the active lease ID of the source container. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.blob.ContainerClient """ lease = kwargs.pop('lease', None) @@ -245,7 +253,11 @@ async def delete_container( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -307,7 +319,11 @@ async def acquire_lease( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A BlobLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.blob.aio.BlobLeaseClient @@ -353,7 +369,11 @@ async def get_container_properties(self, **kwargs): container's lease is active and matches this ID. :paramtype lease: ~azure.storage.blob.aio.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Properties for the specified container within a container object. :rtype: ~azure.storage.blob.ContainerProperties @@ -387,7 +407,11 @@ async def exists(self, **kwargs): Returns True if a container exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ try: @@ -425,7 +449,11 @@ async def set_container_metadata( # type: ignore Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Container-updated property dict (Etag and last modified). .. admonition:: Example: @@ -500,7 +528,11 @@ async def get_container_access_policy(self, **kwargs): container's lease is active and matches this ID. :paramtype lease: ~azure.storage.blob.aio.BlobLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Access policy information in a dict. :rtype: dict[str, Any] @@ -563,7 +595,11 @@ async def set_container_access_policy( Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Container-updated property dict (Etag and last modified). :rtype: dict[str, str or ~datetime.datetime] @@ -620,7 +656,11 @@ def list_blobs(self, name_starts_with=None, include=None, **kwargs): 'tags', 'versions', 'immutabilitypolicy', 'legalhold'. :type include: list[str] or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties] @@ -664,7 +704,11 @@ def list_blob_names(self, **kwargs: Any) -> AsyncItemPaged[str]: Filters the results to return only blobs whose names begin with the specified prefix. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of blob names as strings. :rtype: ~azure.core.async_paging.AsyncItemPaged[str] """ @@ -714,7 +758,11 @@ def walk_blobs( names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties] """ @@ -752,7 +800,11 @@ def find_blobs_by_tags( :keyword int results_per_page: The max result per page when paginating. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of FilteredBlob. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] """ @@ -836,7 +888,12 @@ async def upload_blob( .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier: @@ -964,7 +1021,11 @@ async def delete_blob( .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ blob = self.get_blob_client(blob) # type: ignore @@ -1075,7 +1136,12 @@ async def download_blob( so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], Awaitable[None]] :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. :returns: A streaming object. (StorageStreamDownloader) @@ -1162,7 +1228,11 @@ async def delete_blobs( is raised even if there is a single operation failure. For optimal performance, this should be set to False :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: An async iterator of responses, one for each blob in order :rtype: asynciterator[~azure.core.pipeline.transport.AsyncHttpResponse] @@ -1237,7 +1307,11 @@ async def set_standard_blob_tier_blobs( .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. For optimal performance, @@ -1286,9 +1360,11 @@ async def set_premium_page_blob_tier_blobs( :type blobs: str or dict(str, Any) or ~azure.storage.blob.BlobProperties :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. For optimal performance, diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py index 79e67337dd62..7759f108d496 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py @@ -97,7 +97,11 @@ async def acquire(self, lease_duration=-1, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ mod_conditions = get_modify_conditions(kwargs) @@ -150,7 +154,11 @@ async def renew(self, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -200,7 +208,11 @@ async def release(self, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -249,7 +261,11 @@ async def change(self, proposed_lease_id, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -308,7 +324,11 @@ async def break_lease(self, lease_break_period=None, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_directory_client.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_directory_client.py index 724469cd9ee7..227d1c7be6a2 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_directory_client.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_directory_client.py @@ -179,7 +179,11 @@ def create_directory(self, metadata=None, # type: Optional[Dict[str, str]] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -221,7 +225,11 @@ def delete_directory(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None .. admonition:: Example: @@ -266,7 +274,11 @@ def get_directory_properties(self, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the directory was created with a customer-provided key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: DirectoryProperties .. admonition:: Example: @@ -286,7 +298,11 @@ def exists(self, **kwargs): Returns True if a directory exists and returns False otherwise. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return self._exists(**kwargs) @@ -343,7 +359,11 @@ def rename_directory(self, new_name, **kwargs): :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient .. admonition:: Example: @@ -451,7 +471,11 @@ def create_sub_directory(self, sub_directory, # type: Union[DirectoryProperties Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient for the subdirectory. """ subdir = self.get_sub_directory_client(sub_directory) @@ -490,7 +514,11 @@ def delete_sub_directory(self, sub_directory, # type: Union[DirectoryProperties :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient for the subdirectory """ subdir = self.get_sub_directory_client(sub_directory) @@ -577,7 +605,11 @@ def create_file(self, file, # type: Union[FileProperties, str] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeFileClient """ file_client = self.get_file_client(file) diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_file_client.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_file_client.py index 6237dfcf10c9..74948b5a7220 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_file_client.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_file_client.py @@ -196,7 +196,11 @@ def create_file(self, content_settings=None, # type: Optional[ContentSettings] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: response dict (Etag and last modified). .. admonition:: Example: @@ -237,7 +241,11 @@ def delete_file(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None .. admonition:: Example: @@ -282,7 +290,11 @@ def get_file_properties(self, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the file was created with a customer-provided key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: FileProperties .. admonition:: Example: @@ -310,7 +322,11 @@ def set_file_expiry(self, expiry_options, # type: str When expiry_options is RelativeTo*, expires_on should be an int in milliseconds. If the type of expires_on is datetime, it should be in UTC time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ try: @@ -430,7 +446,12 @@ def upload_data( Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. :keyword int chunk_size: The maximum chunk size for uploading a file in chunks. Defaults to 100*1024*1024, or 100MB. @@ -705,9 +726,12 @@ def download_file(self, offset=None, length=None, **kwargs): :keyword int max_concurrency: The number of parallel connections with which to download. :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. :returns: A streaming object (StorageStreamDownloader) :rtype: ~azure.storage.filedatalake.StorageStreamDownloader @@ -729,7 +753,11 @@ def exists(self, **kwargs): Returns True if a file exists and returns False otherwise. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return self._exists(**kwargs) @@ -786,7 +814,11 @@ def rename_file(self, new_name, **kwargs): :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: the renamed file client :rtype: DataLakeFileClient @@ -878,7 +910,11 @@ def query_file(self, query_expression, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the file was created with a Customer-Provided Key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A streaming object (DataLakeFileQueryReader) :rtype: ~azure.storage.filedatalake.DataLakeFileQueryReader diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_lease.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_lease.py index 7b9d9acb287e..c77c8f7b4854 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_lease.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_lease.py @@ -96,7 +96,11 @@ def acquire(self, lease_duration=-1, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ self._blob_lease_client.acquire(lease_duration=lease_duration, **kwargs) @@ -130,7 +134,11 @@ def renew(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ self._blob_lease_client.renew(**kwargs) @@ -162,7 +170,11 @@ def release(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ self._blob_lease_client.release(**kwargs) @@ -193,7 +205,11 @@ def change(self, proposed_lease_id, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ self._blob_lease_client.change(proposed_lease_id=proposed_lease_id, **kwargs) @@ -233,7 +249,11 @@ def break_lease(self, lease_break_period=None, **kwargs): Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_service_client.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_service_client.py index d2d58da275b7..e0a81d60b328 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_service_client.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_data_lake_service_client.py @@ -170,7 +170,11 @@ def get_user_delegation_key(self, key_start_time, # type: datetime :param ~datetime.datetime key_expiry_time: A DateTime value. Indicates when the key stops being valid. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: The user delegation key. :rtype: ~azure.storage.filedatalake.UserDelegationKey @@ -207,7 +211,11 @@ def list_file_systems(self, name_starts_with=None, # type: Optional[str] The maximum number of file system names to retrieve per API call. If the request does not specify the server will return up to 5,000 items per page. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool include_deleted: Specifies that deleted file systems to be returned in the response. This is for file system restore enabled account. The default value is `False`. @@ -261,7 +269,11 @@ def create_file_system(self, file_system, # type: Union[FileSystemProperties, s :paramtype encryption_scope_options: dict or ~azure.storage.filedatalake.EncryptionScopeOptions :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient .. admonition:: Example: @@ -292,7 +304,11 @@ def _rename_file_system(self, name, new_name, **kwargs): matches the active lease ID of the source filesystem. :paramtype lease: ~azure.storage.filedatalake.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient """ self._blob_service_client._rename_container(name, new_name, **kwargs) # pylint: disable=protected-access @@ -314,7 +330,11 @@ def undelete_file_system(self, name, deleted_version, **kwargs): :param str deleted_version: Specifies the version of the deleted filesystem to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient """ new_name = kwargs.pop('new_name', None) @@ -358,7 +378,11 @@ def delete_file_system(self, file_system, # type: Union[FileSystemProperties, s :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -543,7 +567,11 @@ def set_service_properties(self, **kwargs): and if yes, indicates the index document and 404 error document to use. :type static_website: ~azure.storage.filedatalake.StaticWebsite :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ return self._blob_service_client.set_service_properties(**kwargs) # pylint: disable=protected-access @@ -557,7 +585,11 @@ def get_service_properties(self, **kwargs): This operation was introduced in API version '2020-06-12'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An object containing datalake service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_file_system_client.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_file_system_client.py index 26081ff054c1..6a413aa25b13 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_file_system_client.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_file_system_client.py @@ -216,7 +216,11 @@ def acquire_lease( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A DataLakeLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.filedatalake.DataLakeLeaseClient @@ -258,7 +262,11 @@ def create_file_system(self, metadata=None, # type: Optional[Dict[str, str]] :paramtype encryption_scope_options: dict or ~azure.storage.filedatalake.EncryptionScopeOptions :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -283,7 +291,11 @@ def exists(self, **kwargs): Returns True if a file system exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return self._container_client.exists(**kwargs) @@ -301,7 +313,11 @@ def _rename_file_system(self, new_name, **kwargs): matches the active lease ID of the source filesystem. :paramtype lease: ~azure.storage.filedatalake.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient """ self._container_client._rename_container(new_name, **kwargs) # pylint: disable=protected-access @@ -341,7 +357,11 @@ def delete_file_system(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -364,7 +384,11 @@ def get_file_system_properties(self, **kwargs): If specified, get_file_system_properties only succeeds if the file system's lease is active and matches this ID. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Properties for the specified file system within a file system object. :rtype: ~azure.storage.filedatalake.FileSystemProperties @@ -415,7 +439,11 @@ def set_file_system_metadata( # type: ignore :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: filesystem-updated property dict (Etag and last modified). .. admonition:: Example: @@ -462,7 +490,11 @@ def set_file_system_access_policy( Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File System-updated property dict (Etag and last modified). :rtype: dict[str, str or ~datetime.datetime] """ @@ -479,7 +511,11 @@ def get_file_system_access_policy(self, **kwargs): file system's lease is active and matches this ID. :paramtype lease: ~azure.storage.filedatalake.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Access policy information in a dict. :rtype: dict[str, Any] """ @@ -514,7 +550,11 @@ def get_paths(self, path=None, # type: Optional[str] unique friendly names. :type upn: bool :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of PathProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.filedatalake.PathProperties] @@ -607,7 +647,11 @@ def create_directory(self, directory, # type: Union[DirectoryProperties, str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient .. admonition:: Example: @@ -655,7 +699,11 @@ def delete_directory(self, directory, # type: Union[DirectoryProperties, str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient .. admonition:: Example: @@ -748,7 +796,11 @@ def create_file(self, file, # type: Union[FileProperties, str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeFileClient .. admonition:: Example: @@ -796,7 +848,11 @@ def delete_file(self, file, # type: Union[FileProperties, str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeFileClient .. admonition:: Example: @@ -840,7 +896,11 @@ def _undelete_path(self, deleted_path_name, deletion_id, **kwargs): :param str deletion_id: Specifies the version of the deleted path to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.file.datalake.DataLakeDirectoryClient or azure.storage.file.datalake.DataLakeFileClient """ _, url, undelete_source = self._undelete_path_options(deleted_path_name, deletion_id) @@ -956,7 +1016,11 @@ def list_deleted_paths(self, **kwargs): An optional value that specifies the maximum number of items to return per page. If omitted or greater than 5,000, the response will include up to 5,000 items per page. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of DeletedPathProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.filedatalake.DeletedPathProperties] diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_path_client.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_path_client.py index 92ed5fb04b8f..1e990fc76263 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_path_client.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_path_client.py @@ -1,3 +1,4 @@ +# pylint: disable=too-many-lines # ------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for @@ -261,7 +262,11 @@ def _create(self, resource_type, content_settings=None, metadata=None, **kwargs) Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] """ @@ -323,7 +328,11 @@ def _delete(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :param int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ options = self._delete_path_options(**kwargs) @@ -405,7 +414,11 @@ def set_access_control(self, owner=None, # type: Optional[str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword: response dict (Etag and last modified). """ if not any([owner, group, permissions, acl]): @@ -470,7 +483,11 @@ def get_access_control(self, upn=None, # type: Optional[bool] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword: response dict. """ options = self._get_access_control_options(upn=upn, **kwargs) @@ -529,7 +546,11 @@ def set_access_control_recursive(self, Continuation token will only be returned when continue_on_failure is True in case of user errors. If not set the default value is False for this. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A summary of the recursive operations, including the count of successes and failures, as well as a continuation token in case the operation was terminated prematurely. :rtype: :class:`~azure.storage.filedatalake.AccessControlChangeResult` @@ -580,7 +601,11 @@ def update_access_control_recursive(self, Continuation token will only be returned when continue_on_failure is True in case of user errors. If not set the default value is False for this. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A summary of the recursive operations, including the count of successes and failures, as well as a continuation token in case the operation was terminated prematurely. :rtype: :class:`~azure.storage.filedatalake.AccessControlChangeResult` @@ -630,7 +655,11 @@ def remove_access_control_recursive(self, Continuation token will only be returned when continue_on_failure is True in case of user errors. If not set the default value is False for this. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A summary of the recursive operations, including the count of successes and failures, as well as a continuation token in case the operation was terminated prematurely. :rtype: :class:`~azure.storage.filedatalake.AccessControlChangeResult` @@ -793,7 +822,11 @@ def _rename_path(self, rename_source, **kwargs): :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. """ options = self._rename_path_options( rename_source, @@ -834,7 +867,11 @@ def _get_path_properties(self, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the file/directory was created with a customer-provided key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: DirectoryProperties or FileProperties .. admonition:: Example: @@ -855,7 +892,11 @@ def _exists(self, **kwargs): Returns True if a path exists and returns False otherwise. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return self._blob_client.exists(**kwargs) @@ -897,7 +938,11 @@ def set_metadata(self, metadata, # type: Dict[str, str] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: file system-updated property dict (Etag and last modified). """ return self._blob_client.set_blob_metadata(metadata=metadata, **kwargs) @@ -933,7 +978,11 @@ def set_http_headers(self, content_settings=None, # type: Optional[ContentSetti :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: file/directory-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -974,7 +1023,11 @@ def acquire_lease(self, lease_duration=-1, # type: Optional[int] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A DataLakeLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.filedatalake.DataLakeLeaseClient """ diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_directory_client_async.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_directory_client_async.py index 4c38d1e5af86..f5495b2a6f8d 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_directory_client_async.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_directory_client_async.py @@ -146,7 +146,11 @@ async def create_directory(self, metadata=None, # type: Optional[Dict[str, str] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -167,7 +171,11 @@ async def exists(self, **kwargs): Returns True if a directory exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return await self._exists(**kwargs) @@ -199,7 +207,11 @@ async def delete_directory(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None .. admonition:: Example: @@ -244,7 +256,11 @@ async def get_directory_properties(self, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the directory was created with a customer-provided key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: DirectoryProperties .. admonition:: Example: @@ -311,7 +327,11 @@ async def rename_directory(self, new_name, # type: str :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient .. admonition:: Example: @@ -419,7 +439,11 @@ async def create_sub_directory(self, sub_directory, # type: Union[DirectoryProp Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient for the subdirectory. """ subdir = self.get_sub_directory_client(sub_directory) @@ -458,7 +482,11 @@ async def delete_sub_directory(self, sub_directory, # type: Union[DirectoryProp :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient for the subdirectory """ subdir = self.get_sub_directory_client(sub_directory) @@ -545,7 +573,11 @@ async def create_file(self, file, # type: Union[FileProperties, str] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeFileClient """ file_client = self.get_file_client(file) diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_file_client_async.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_file_client_async.py index f95829e36258..dc28e36ca507 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_file_client_async.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_file_client_async.py @@ -152,7 +152,11 @@ async def create_file(self, content_settings=None, # type: Optional[ContentSett Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: response dict (Etag and last modified). .. admonition:: Example: @@ -172,7 +176,11 @@ async def exists(self, **kwargs): Returns True if a file exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return await self._exists(**kwargs) @@ -204,7 +212,11 @@ async def delete_file(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None .. admonition:: Example: @@ -249,7 +261,11 @@ async def get_file_properties(self, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the file was created with a customer-provided key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: FileProperties .. admonition:: Example: @@ -276,7 +292,11 @@ async def set_file_expiry(self, expiry_options, # type: str The time to set the file to expiry. When expiry_options is RelativeTo*, expires_on should be an int in milliseconds :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ try: @@ -349,7 +369,12 @@ async def upload_data( Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. :keyword int chunk_size: The maximum chunk size for uploading a file in chunks. Defaults to 100*1024*1024, or 100MB. @@ -559,9 +584,12 @@ async def download_file(self, offset=None, length=None, **kwargs): :keyword int max_concurrency: The number of parallel connections with which to download. :keyword int timeout: - The timeout parameter is expressed in seconds. This method may make - multiple calls to the Azure service and the timeout will apply to - each call individually. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This method may make multiple calls to the service and + the timeout will apply to each call individually. :returns: A streaming object (StorageStreamDownloader) :rtype: ~azure.storage.filedatalake.aio.StorageStreamDownloader @@ -630,7 +658,11 @@ async def rename_file(self, new_name, **kwargs): :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: the renamed file client :rtype: DataLakeFileClient diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_lease_async.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_lease_async.py index 12e3acb00b10..76194e6e92c4 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_lease_async.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_lease_async.py @@ -99,7 +99,11 @@ async def acquire(self, lease_duration=-1, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ await self._blob_lease_client.acquire(lease_duration=lease_duration, **kwargs) @@ -133,7 +137,11 @@ async def renew(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ await self._blob_lease_client.renew(**kwargs) @@ -165,7 +173,11 @@ async def release(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ await self._blob_lease_client.release(**kwargs) @@ -196,7 +208,11 @@ async def change(self, proposed_lease_id, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ await self._blob_lease_client.change(proposed_lease_id=proposed_lease_id, **kwargs) @@ -236,7 +252,11 @@ async def break_lease(self, lease_break_period=None, **kwargs): Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_service_client_async.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_service_client_async.py index c50290e1930a..4432edcdefbf 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_service_client_async.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_data_lake_service_client_async.py @@ -119,7 +119,11 @@ async def get_user_delegation_key(self, key_start_time, # type: datetime :param ~datetime.datetime key_expiry_time: A DateTime value. Indicates when the key stops being valid. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: The user delegation key. :rtype: ~azure.storage.filedatalake.UserDelegationKey @@ -157,7 +161,11 @@ def list_file_systems(self, name_starts_with=None, # type: Optional[str] The maximum number of file system names to retrieve per API call. If the request does not specify the server will return up to 5,000 items per page. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool include_deleted: Specifies that deleted file systems to be returned in the response. This is for file system restore enabled account. The default value is `False`. @@ -211,7 +219,11 @@ async def create_file_system(self, file_system, # type: Union[FileSystemPropert :paramtype encryption_scope_options: dict or ~azure.storage.filedatalake.EncryptionScopeOptions :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient .. admonition:: Example: @@ -242,7 +254,11 @@ async def _rename_file_system(self, name, new_name, **kwargs): matches the active lease ID of the source filesystem. :paramtype lease: ~azure.storage.filedatalake.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient """ await self._blob_service_client._rename_container(name, new_name, **kwargs) # pylint: disable=protected-access @@ -264,7 +280,11 @@ async def undelete_file_system(self, name, deleted_version, **kwargs): :param str deleted_version: Specifies the version of the deleted filesystem to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient """ new_name = kwargs.pop('new_name', None) @@ -307,7 +327,11 @@ async def delete_file_system(self, file_system, # type: Union[FileSystemPropert :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -492,7 +516,11 @@ async def set_service_properties(self, **kwargs): and if yes, indicates the index document and 404 error document to use. :type static_website: ~azure.storage.filedatalake.StaticWebsite :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ return await self._blob_service_client.set_service_properties(**kwargs) # pylint: disable=protected-access @@ -506,7 +534,11 @@ async def get_service_properties(self, **kwargs): This operation was introduced in API version '2020-06-12'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An object containing datalake service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_file_system_client_async.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_file_system_client_async.py index 7514826b8655..334b517cf579 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_file_system_client_async.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_file_system_client_async.py @@ -161,7 +161,11 @@ async def acquire_lease( :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A DataLakeLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.filedatalake.aio.DataLakeLeaseClient @@ -204,7 +208,11 @@ async def create_file_system(self, metadata=None, # type: Optional[Dict[str, st :paramtype encryption_scope_options: dict or ~azure.storage.filedatalake.EncryptionScopeOptions :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -230,7 +238,11 @@ async def exists(self, **kwargs): Returns True if a file system exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return await self._container_client.exists(**kwargs) @@ -249,7 +261,11 @@ async def _rename_file_system(self, new_name, **kwargs): matches the active lease ID of the source filesystem. :paramtype lease: ~azure.storage.filedatalake.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.filedatalake.FileSystemClient """ await self._container_client._rename_container(new_name, **kwargs) # pylint: disable=protected-access @@ -290,7 +306,11 @@ async def delete_file_system(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -315,7 +335,11 @@ async def get_file_system_properties(self, **kwargs): file system's lease is active and matches this ID. :paramtype lease: ~azure.storage.filedatalake.aio.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Properties for the specified file system within a file system object. :rtype: ~azure.storage.filedatalake.FileSystemProperties @@ -368,7 +392,11 @@ async def set_file_system_metadata( # type: ignore :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: file system-updated property dict (Etag and last modified). .. admonition:: Example: @@ -416,7 +444,11 @@ async def set_file_system_access_policy( Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: filesystem-updated property dict (Etag and last modified). :rtype: dict[str, str or ~datetime.datetime] """ @@ -434,7 +466,11 @@ async def get_file_system_access_policy(self, **kwargs): file system's lease is active and matches this ID. :paramtype lease: ~azure.storage.filedatalake.aio.DataLakeLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Access policy information in a dict. :rtype: dict[str, Any] """ @@ -471,7 +507,11 @@ def get_paths(self, path=None, # type: Optional[str] unique friendly names. :type upn: bool :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of PathProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.filedatalake.PathProperties] @@ -565,7 +605,11 @@ async def create_directory(self, directory, # type: Union[DirectoryProperties, :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient .. admonition:: Example: @@ -614,7 +658,11 @@ async def delete_directory(self, directory, # type: Union[DirectoryProperties, :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeDirectoryClient .. admonition:: Example: @@ -708,7 +756,11 @@ async def create_file(self, file, # type: Union[FileProperties, str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeFileClient .. admonition:: Example: @@ -757,7 +809,11 @@ async def delete_file(self, file, # type: Union[FileProperties, str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: DataLakeFileClient .. literalinclude:: ../samples/datalake_samples_file_system_async.py @@ -787,7 +843,11 @@ async def _undelete_path(self, deleted_path_name, deletion_id, **kwargs): :param str deletion_id: Specifies the version of the deleted container to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.file.datalake.aio.DataLakeDirectoryClient or azure.storage.file.datalake.aio.DataLakeFileClient """ @@ -906,7 +966,11 @@ def list_deleted_paths(self, **kwargs): An optional value that specifies the maximum number of items to return per page. If omitted or greater than 5,000, the response will include up to 5,000 items per page. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) response of DeletedPathProperties. :rtype: ~azure.core.paging.AsyncItemPaged[~azure.storage.filedatalake.DeletedPathProperties] diff --git a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_path_client_async.py b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_path_client_async.py index fed98e547bce..53645dbe7e29 100644 --- a/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_path_client_async.py +++ b/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/aio/_path_client_async.py @@ -178,7 +178,11 @@ async def _create(self, resource_type, content_settings=None, metadata=None, **k Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] """ @@ -225,7 +229,11 @@ async def _delete(self, **kwargs): :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ options = self._delete_path_options(**kwargs) @@ -288,7 +296,11 @@ async def set_access_control(self, owner=None, # type: Optional[str] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword: response dict (Etag and last modified). """ options = self._set_access_control_options(owner=owner, group=group, permissions=permissions, acl=acl, **kwargs) @@ -335,7 +347,11 @@ async def get_access_control(self, upn=None, # type: Optional[bool] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword: response dict. """ options = self._get_access_control_options(upn=upn, **kwargs) @@ -379,7 +395,11 @@ async def set_access_control_recursive(self, Continuation token will only be returned when continue_on_failure is True in case of user errors. If not set the default value is False for this. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A summary of the recursive operations, including the count of successes and failures, as well as a continuation token in case the operation was terminated prematurely. :rtype: :~azure.storage.filedatalake.AccessControlChangeResult` @@ -429,7 +449,11 @@ async def update_access_control_recursive(self, acl, **kwargs): Continuation token will only be returned when continue_on_failure is True in case of user errors. If not set the default value is False for this. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A summary of the recursive operations, including the count of successes and failures, as well as a continuation token in case the operation was terminated prematurely. :rtype: :~azure.storage.filedatalake.AccessControlChangeResult` @@ -479,7 +503,11 @@ async def remove_access_control_recursive(self, Continuation token will only be returned when continue_on_failure is True in case of user errors. If not set the default value is False for this. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A summary of the recursive operations, including the count of successes and failures, as well as a continuation token in case the operation was terminated prematurely. :rtype: :~azure.storage.filedatalake.AccessControlChangeResult` @@ -609,7 +637,11 @@ async def _rename_path(self, rename_source, **kwargs): :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. """ options = self._rename_path_options( rename_source, @@ -650,7 +682,11 @@ async def _get_path_properties(self, **kwargs): Use of customer-provided keys must be done over HTTPS. Required if the file/directory was created with a customer-provided key. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: DirectoryProperties or FileProperties """ path_properties = await self._blob_client.get_blob_properties(**kwargs) @@ -662,7 +698,11 @@ async def _exists(self, **kwargs): Returns True if a path exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: boolean """ return await self._blob_client.exists(**kwargs) @@ -704,7 +744,11 @@ async def set_metadata(self, metadata, # type: Dict[str, str] Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: file system-updated property dict (Etag and last modified). """ return await self._blob_client.set_blob_metadata(metadata=metadata, **kwargs) @@ -740,7 +784,11 @@ async def set_http_headers(self, content_settings=None, # type: Optional[Conten :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: file/directory-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -781,7 +829,11 @@ async def acquire_lease(self, lease_duration=-1, # type: Optional[int] :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A DataLakeLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.filedatalake.aio.DataLakeLeaseClient diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py index 63b22aeda3fb..f2c74a7492ea 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py @@ -308,7 +308,11 @@ def create_directory(self, **kwargs): :keyword dict(str,str) metadata: Name-value pairs associated with the directory as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Directory-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -356,7 +360,11 @@ def delete_directory(self, **kwargs): later deleted during garbage collection. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -386,7 +394,11 @@ def rename_directory( :param str new_name: The new directory name. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool overwrite: A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the @@ -494,7 +506,11 @@ def list_directories_and_files(self, name_starts_with=None, **kwargs): This keyword argument was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of dict-like DirectoryProperties and FileProperties :rtype: ~azure.core.paging.ItemPaged[DirectoryProperties and FileProperties] @@ -527,7 +543,11 @@ def list_handles(self, recursive=False, **kwargs): Boolean that specifies if operation should apply to the directory specified by the client, its files, its subdirectories and their files. Default value is False. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of Handle :rtype: ~azure.core.paging.ItemPaged[~azure.storage.fileshare.Handle] """ @@ -552,7 +572,11 @@ def close_handle(self, handle, **kwargs): A specific handle to close. :type handle: str or ~azure.storage.fileshare.Handle :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. @@ -591,7 +615,11 @@ def close_all_handles(self, recursive=False, **kwargs): Boolean that specifies if operation should apply to the directory specified by the client, its files, its subdirectories and their files. Default value is False. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. :rtype: dict[str, int] @@ -635,7 +663,11 @@ def get_directory_properties(self, **kwargs): list of files. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: DirectoryProperties :rtype: ~azure.storage.fileshare.DirectoryProperties """ @@ -662,7 +694,11 @@ def set_directory_metadata(self, metadata, **kwargs): Name-value pairs associated with the directory as metadata. :type metadata: dict(str, str) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Directory-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -685,7 +721,11 @@ def exists(self, **kwargs): Returns True if a directory exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: True if the directory exists, False otherwise. :rtype: bool """ @@ -739,7 +779,11 @@ def set_http_headers(self, file_attributes="none", # type: Union[str, NTFSAttri :paramtype file_change_time: str or ~datetime.datetime :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -773,7 +817,11 @@ def create_subdirectory( :keyword dict(str,str) metadata: Name-value pairs associated with the subdirectory as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: ShareDirectoryClient :rtype: ~azure.storage.fileshare.ShareDirectoryClient @@ -803,7 +851,11 @@ def delete_subdirectory( :param str directory_name: The name of the subdirectory. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -855,7 +907,11 @@ def upload_file( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[int]], None] :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str encoding: Defaults to UTF-8. :returns: ShareFileClient @@ -889,7 +945,11 @@ def delete_file( :param str file_name: The name of the file to delete. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py index 0132d18d4780..4cf2ba6c2044 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py @@ -297,7 +297,11 @@ def acquire_lease(self, lease_id=None, **kwargs): returns 400 (Invalid request) if the proposed lease ID is not in the correct format. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A ShareLeaseClient object. :rtype: ~azure.storage.fileshare.ShareLeaseClient @@ -375,7 +379,11 @@ def create_file( # type: ignore :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -499,7 +507,11 @@ def upload_file( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[int]], None] :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str encoding: Defaults to UTF-8. :returns: File-updated property dict (Etag and last modified). @@ -648,7 +660,11 @@ def start_copy_from_url(self, source_url, **kwargs): :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: dict(str, Any) .. admonition:: Example: @@ -697,7 +713,11 @@ def abort_copy(self, copy_id, **kwargs): :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ access_conditions = get_access_conditions(kwargs.pop('lease', None)) @@ -757,7 +777,11 @@ def download_file( so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], None] :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A streaming object (StorageStreamDownloader) :rtype: ~azure.storage.fileshare.StorageStreamDownloader @@ -805,7 +829,11 @@ def delete_file(self, **kwargs): :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -836,7 +864,11 @@ def rename_file( :param str new_name: The new file name. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool overwrite: A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the @@ -956,7 +988,11 @@ def get_file_properties(self, **kwargs): :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: FileProperties :rtype: ~azure.storage.fileshare.FileProperties """ @@ -1029,7 +1065,11 @@ def set_http_headers(self, content_settings, # type: ContentSettings :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -1084,7 +1124,11 @@ def set_file_metadata(self, metadata=None, **kwargs): :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -1145,7 +1189,11 @@ def upload_range( # type: ignore :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str encoding: Defaults to UTF-8. :returns: File-updated property dict (Etag and last modified). @@ -1277,7 +1325,11 @@ def upload_range_from_url(self, source_url, :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -1348,7 +1400,11 @@ def get_ranges( # type: ignore :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A list of valid ranges. :rtype: List[dict[str, int]] @@ -1389,7 +1445,11 @@ def get_ranges_diff( # type: ignore or the lease ID as a string. :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists of file ranges as dictionaries with 'start' and 'end' keys. The first element are filled file ranges, the 2nd element is cleared file ranges. @@ -1430,7 +1490,11 @@ def clear_range( # type: ignore :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: Dict[str, Any] """ @@ -1471,7 +1535,11 @@ def resize_file(self, size, **kwargs): :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: Dict[str, Any] """ @@ -1497,7 +1565,11 @@ def list_handles(self, **kwargs): """Lists handles for file. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of Handle :rtype: ~azure.core.paging.ItemPaged[~azure.storage.fileshare.Handle] """ @@ -1521,7 +1593,11 @@ def close_handle(self, handle, **kwargs): A specific handle to close. :type handle: str or ~azure.storage.fileshare.Handle :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. @@ -1556,7 +1632,11 @@ def close_all_handles(self, **kwargs): This operation will block until the service has closed all open handles. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. :rtype: dict[str, int] diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_lease.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_lease.py index 7fe9b0397e0b..883fff2d7f78 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_lease.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_lease.py @@ -86,7 +86,11 @@ def acquire(self, **kwargs): using renew or change. Default is -1 (infinite share lease). :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ try: @@ -119,7 +123,11 @@ def renew(self, **kwargs): .. versionadded:: 12.6.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ if isinstance(self._client, FileOperations): @@ -145,7 +153,11 @@ def release(self, **kwargs): the lease for the share or file as soon as the release is complete. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ try: @@ -172,7 +184,11 @@ def change(self, proposed_lease_id, **kwargs): Proposed lease ID, in a GUID string format. The File or Share service will raise an error (Invalid request) if the proposed lease ID is not in the correct format. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ try: @@ -215,7 +231,11 @@ def break_lease(self, **kwargs): .. versionadded:: 12.6.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py index b91957730dae..afe26c8817a0 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py @@ -293,7 +293,11 @@ def acquire_lease(self, **kwargs): returns 400 (Invalid request) if the proposed lease ID is not in the correct format. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A ShareLeaseClient object. :rtype: ~azure.storage.fileshare.ShareLeaseClient @@ -330,7 +334,11 @@ def create_share(self, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword protocols: Protocols to enable on the share. Only one protocol can be enabled on the share. :paramtype protocols: str or ~azure.storage.fileshare.ShareProtocols @@ -396,7 +404,11 @@ def create_snapshot( # type: ignore :keyword dict(str,str) metadata: Name-value pairs associated with the share as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Share-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] @@ -441,7 +453,11 @@ def delete_share( This keyword argument was introduced in API version '2020-08-04'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -475,7 +491,11 @@ def get_share_properties(self, **kwargs): list of files or directories. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -519,7 +539,11 @@ def set_share_quota(self, quota, **kwargs): Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -567,7 +591,11 @@ def set_share_properties(self, **kwargs): Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword root_squash: Root squash to set on the share. Only valid for NFS shares. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'. @@ -619,7 +647,11 @@ def set_share_metadata(self, metadata, **kwargs): Name-value pairs associated with the share as metadata. :type metadata: dict(str, str) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -660,7 +692,11 @@ def get_share_access_policy(self, **kwargs): indicate whether files in a share may be accessed publicly. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -699,7 +735,11 @@ def set_share_access_policy(self, signed_identifiers, **kwargs): will clear the access policies set on the service. :type signed_identifiers: dict(str, :class:`~azure.storage.fileshare.AccessPolicy`) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -742,7 +782,11 @@ def get_share_stats(self, **kwargs): or recently re-sized files. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -797,7 +841,11 @@ def list_directories_and_files( This keyword argument was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of dict-like DirectoryProperties and FileProperties .. admonition:: Example: @@ -840,7 +888,11 @@ def create_permission_for_share(self, file_permission, # type: str :param str file_permission: File permission, a Portable SDDL :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A file permission key :rtype: str """ @@ -864,7 +916,11 @@ def get_permission_for_share( # type: ignore :param str permission_key: Key of the file permission to retrieve :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A file permission (a portable SDDL) :rtype: str """ @@ -890,7 +946,11 @@ def create_directory(self, directory_name, **kwargs): Name-value pairs associated with the directory as metadata. :type metadata: dict(str, str) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: ShareDirectoryClient :rtype: ~azure.storage.fileshare.ShareDirectoryClient """ @@ -908,7 +968,11 @@ def delete_directory(self, directory_name, **kwargs): :param str directory_name: The name of the directory. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ directory = self.get_directory_client(directory_name) diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py index 3ffa5522e243..df106274614c 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py @@ -156,7 +156,11 @@ def get_service_properties(self, **kwargs): Azure Storage Analytics. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A dictionary containing file service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] @@ -207,7 +211,11 @@ def set_service_properties( Sets protocol settings :type protocol: ~azure.storage.fileshare.ShareProtocolSettings :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -254,7 +262,11 @@ def list_shares( Specifies that deleted shares be returned in the response. This is only for share soft delete enabled account. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) of ShareProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.fileshare.ShareProperties] @@ -304,7 +316,11 @@ def create_share( :keyword int quota: Quota in bytes. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.fileshare.ShareClient .. admonition:: Example: @@ -341,7 +357,11 @@ def delete_share( :param bool delete_snapshots: Indicates if snapshots are to be deleted. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -375,7 +395,11 @@ def undelete_share(self, deleted_share_name, deleted_share_version, **kwargs): :param str deleted_share_version: Specifies the version of the deleted share to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.fileshare.ShareClient """ share = self.get_share_client(deleted_share_name) diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_directory_client_async.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_directory_client_async.py index c0b2ae4212a3..e2b025e91704 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_directory_client_async.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_directory_client_async.py @@ -187,7 +187,11 @@ async def create_directory(self, **kwargs): :keyword dict(str,str) metadata: Name-value pairs associated with the directory as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Directory-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -235,7 +239,11 @@ async def delete_directory(self, **kwargs): later deleted during garbage collection. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -265,7 +273,11 @@ async def rename_directory( :param str new_name: The new directory name. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool overwrite: A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the @@ -373,7 +385,11 @@ def list_directories_and_files(self, name_starts_with=None, **kwargs): This keyword argument was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of dict-like DirectoryProperties and FileProperties :rtype: ~azure.core.async_paging.AsyncItemPaged[DirectoryProperties and FileProperties] @@ -406,7 +422,11 @@ def list_handles(self, recursive=False, **kwargs): Boolean that specifies if operation should apply to the directory specified by the client, its files, its subdirectories and their files. Default value is False. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of Handle :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.fileshare.Handle] """ @@ -429,7 +449,11 @@ async def exists(self, **kwargs): Returns True if a directory exists and returns False otherwise. :kwarg int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: True if the directory exists, False otherwise. :rtype: bool """ @@ -451,7 +475,11 @@ async def close_handle(self, handle, **kwargs): A specific handle to close. :type handle: str or ~azure.storage.fileshare.Handle :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. :rtype: dict[str, int] @@ -489,7 +517,11 @@ async def close_all_handles(self, recursive=False, **kwargs): Boolean that specifies if operation should apply to the directory specified by the client, its files, its subdirectories and their files. Default value is False. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. :rtype: dict[str, int] @@ -533,7 +565,11 @@ async def get_directory_properties(self, **kwargs): list of files. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: DirectoryProperties :rtype: ~azure.storage.fileshare.DirectoryProperties """ @@ -560,7 +596,11 @@ async def set_directory_metadata(self, metadata, **kwargs): Name-value pairs associated with the directory as metadata. :type metadata: dict(str, str) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Directory-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -617,7 +657,11 @@ async def set_http_headers(self, file_attributes="none", # type: Union[str, NTF :paramtype file_change_time: str or ~datetime.datetime :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -652,7 +696,11 @@ async def create_subdirectory( :keyword dict(str,str) metadata: Name-value pairs associated with the subdirectory as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: ShareDirectoryClient :rtype: ~azure.storage.fileshare.aio.ShareDirectoryClient @@ -682,7 +730,11 @@ async def delete_subdirectory( :param str directory_name: The name of the subdirectory. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -734,7 +786,11 @@ async def upload_file( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[int]], Awaitable[None]] :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str encoding: Defaults to UTF-8. :returns: ShareFileClient @@ -768,7 +824,11 @@ async def delete_file( :param str file_name: The name of the file to delete. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_file_client_async.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_file_client_async.py index a0f746b7a6fd..5bf49eb39fea 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_file_client_async.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_file_client_async.py @@ -164,7 +164,11 @@ async def acquire_lease(self, lease_id=None, **kwargs): returns 400 (Invalid request) if the proposed lease ID is not in the correct format. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A ShareLeaseClient object. :rtype: ~azure.storage.fileshare.aio.ShareLeaseClient @@ -243,7 +247,11 @@ async def create_file( # type: ignore :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -370,7 +378,11 @@ async def upload_file( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[int]], Awaitable[None]] :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -520,7 +532,11 @@ async def start_copy_from_url(self, source_url, **kwargs): :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: dict(str, Any) .. admonition:: Example: @@ -571,7 +587,11 @@ async def abort_copy(self, copy_id, **kwargs): :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ access_conditions = get_access_conditions(kwargs.pop('lease', None)) @@ -632,7 +652,11 @@ async def download_file( so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, int], Awaitable[None]] :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A streaming object (StorageStreamDownloader) :rtype: ~azure.storage.fileshare.aio.StorageStreamDownloader @@ -683,7 +707,11 @@ async def delete_file(self, **kwargs): :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -714,7 +742,11 @@ async def rename_file( :param str new_name: The new file name. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword bool overwrite: A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the @@ -834,7 +866,11 @@ async def get_file_properties(self, **kwargs): :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: FileProperties :rtype: ~azure.storage.fileshare.FileProperties """ @@ -908,7 +944,11 @@ async def set_http_headers(self, content_settings, # type: ContentSettings :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -964,7 +1004,11 @@ async def set_file_metadata(self, metadata=None, **kwargs): # type: ignore :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -1023,7 +1067,11 @@ async def upload_range( # type: ignore :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str encoding: Defaults to UTF-8. :returns: File-updated property dict (Etag and last modified). @@ -1116,7 +1164,11 @@ async def upload_range_from_url(self, source_url, :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -1155,7 +1207,11 @@ async def get_ranges( # type: ignore :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A list of valid ranges. :rtype: List[dict[str, int]] @@ -1197,7 +1253,11 @@ async def get_ranges_diff( # type: ignore or the lease ID as a string. :paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A tuple of two lists of file ranges as dictionaries with 'start' and 'end' keys. The first element are filled file ranges, the 2nd element is cleared file ranges. @@ -1239,7 +1299,11 @@ async def clear_range( # type: ignore :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: Dict[str, Any] """ @@ -1281,7 +1345,11 @@ async def resize_file(self, size, **kwargs): :paramtype lease: ~azure.storage.fileshare.aio.ShareLeaseClient or str :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: File-updated property dict (Etag and last modified). :rtype: Dict[str, Any] """ @@ -1308,7 +1376,11 @@ def list_handles(self, **kwargs): """Lists handles for file. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of Handle :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.fileshare.Handle] """ @@ -1332,7 +1404,11 @@ async def close_handle(self, handle, **kwargs): A specific handle to close. :type handle: str or ~azure.storage.fileshare.Handle :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. @@ -1367,7 +1443,11 @@ async def close_all_handles(self, **kwargs): This operation will block until the service has closed all open handles. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: The number of handles closed (this may be 0 if the specified handle was not found) and the number of handles failed to close in a dict. diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_lease_async.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_lease_async.py index 0d99845ce901..4e8bc167bc22 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_lease_async.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_lease_async.py @@ -77,7 +77,11 @@ async def acquire(self, **kwargs): using renew or change. Default is -1 (infinite share lease). :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ try: @@ -110,7 +114,11 @@ async def renew(self, **kwargs): .. versionadded:: 12.6.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ if isinstance(self._client, FileOperations): @@ -136,7 +144,11 @@ async def release(self, **kwargs): the lease for the share or file as soon as the release is complete. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ try: @@ -163,7 +175,11 @@ async def change(self, proposed_lease_id, **kwargs): Proposed lease ID, in a GUID string format. The File or Share service raises an error (Invalid request) if the proposed lease ID is not in the correct format. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None """ try: @@ -206,7 +222,11 @@ async def break_lease(self, **kwargs): .. versionadded:: 12.5.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_client_async.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_client_async.py index c16a9fbe2fd0..0f256901f794 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_client_async.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_client_async.py @@ -153,7 +153,11 @@ async def acquire_lease(self, **kwargs): returns 400 (Invalid request) if the proposed lease ID is not in the correct format. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A ShareLeaseClient object. :rtype: ~azure.storage.fileshare.ShareLeaseClient @@ -190,7 +194,11 @@ async def create_share(self, **kwargs): .. versionadded:: 12.4.0 :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword protocols: Protocols to enable on the share. Only one protocol can be enabled on the share. :paramtype protocols: str or ~azure.storage.fileshare.ShareProtocols @@ -256,7 +264,11 @@ async def create_snapshot( # type: ignore :keyword dict(str,str) metadata: Name-value pairs associated with the share as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: Share-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] @@ -294,7 +306,11 @@ async def delete_share( :param bool delete_snapshots: Indicates if snapshots are to be deleted. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -334,7 +350,11 @@ async def get_share_properties(self, **kwargs): list of files or directories. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -378,7 +398,11 @@ async def set_share_quota(self, quota, **kwargs): Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -425,7 +449,11 @@ async def set_share_properties(self, **kwargs): Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword root_squash: Root squash to set on the share. Only valid for NFS shares. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash' @@ -477,7 +505,11 @@ async def set_share_metadata(self, metadata, **kwargs): Name-value pairs associated with the share as metadata. :type metadata: dict(str, str) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -518,7 +550,11 @@ async def get_share_access_policy(self, **kwargs): indicate whether files in a share may be accessed publicly. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -557,7 +593,11 @@ async def set_share_access_policy(self, signed_identifiers, **kwargs): will clear the access policies set on the service. :type signed_identifiers: dict(str, :class:`~azure.storage.fileshare.AccessPolicy`) :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -601,7 +641,11 @@ async def get_share_stats(self, **kwargs): or recently re-sized files. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword lease: Required if the share has an active lease. Value can be a ShareLeaseClient object or the lease ID as a string. @@ -656,7 +700,11 @@ def list_directories_and_files( # type: ignore This keyword argument was introduced in API version '2020-10-02'. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An auto-paging iterable of dict-like DirectoryProperties and FileProperties .. admonition:: Example: @@ -687,7 +735,11 @@ async def create_permission_for_share(self, file_permission, # type: str :param str file_permission: File permission, a Portable SDDL :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A file permission key :rtype: str """ @@ -711,7 +763,11 @@ async def get_permission_for_share( # type: ignore :param str permission_key: Key of the file permission to retrieve :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A file permission (a portable SDDL) :rtype: str """ @@ -736,7 +792,11 @@ async def create_directory(self, directory_name, **kwargs): :keyword dict(str,str) metadata: Name-value pairs associated with the directory as metadata. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: ShareDirectoryClient :rtype: ~azure.storage.fileshare.aio.ShareDirectoryClient """ @@ -754,7 +814,11 @@ async def delete_directory(self, directory_name, **kwargs): :param str directory_name: The name of the directory. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None """ directory = self.get_directory_client(directory_name) diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_service_client_async.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_service_client_async.py index fc271545e847..aaf488720285 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_service_client_async.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_service_client_async.py @@ -102,7 +102,11 @@ async def get_service_properties(self, **kwargs): Azure Storage Analytics. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: A dictionary containing file service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] @@ -153,7 +157,11 @@ async def set_service_properties( Sets protocol settings :type protocol: ~azure.storage.fileshare.ShareProtocolSettings :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -199,7 +207,11 @@ def list_shares( Specifies that deleted shares be returned in the response. This is only for share soft delete enabled account. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :returns: An iterable (auto-paging) of ShareProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.fileshare.ShareProperties] @@ -249,7 +261,11 @@ async def create_share( :keyword int quota: Quota in bytes. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.fileshare.aio.ShareClient .. admonition:: Example: @@ -286,7 +302,11 @@ async def delete_share( :param bool delete_snapshots: Indicates if snapshots are to be deleted. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -320,7 +340,11 @@ async def undelete_share(self, deleted_share_name, deleted_share_version, **kwar :param str deleted_share_version: Specifies the version of the deleted share to restore. :keyword int timeout: - The timeout parameter is expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: ~azure.storage.fileshare.aio.ShareClient """ share = self.get_share_client(deleted_share_name) diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py index 715f58af69a0..fa3c046150dd 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py @@ -215,7 +215,11 @@ def create_queue(self, **kwargs): metadata. Note that metadata names preserve the case with which they were created, but are case-insensitive when set or read. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None or the result of cls(response) :rtype: None :raises: StorageErrorException @@ -257,7 +261,11 @@ def delete_queue(self, **kwargs): an :class:`HttpResponseError` will be thrown. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -322,7 +330,11 @@ def set_queue_metadata(self, queue as metadata. :type metadata: dict(str, str) :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -352,7 +364,11 @@ def get_queue_access_policy(self, **kwargs): queue that may be used with Shared Access Signatures. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A dictionary of access policies associated with the queue. :rtype: dict(str, ~azure.storage.queue.AccessPolicy) """ @@ -392,7 +408,11 @@ def set_queue_access_policy(self, will clear the access policies set on the service. :type signed_identifiers: dict(str, ~azure.storage.queue.AccessPolicy) :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -459,7 +479,11 @@ def send_message( seconds. The time-to-live may be any positive number or -1 for infinity. If this parameter is omitted, the default time-to-live is 7 days. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A :class:`~azure.storage.queue.QueueMessage` object. This object is also populated with the content although it is not @@ -537,7 +561,11 @@ def receive_message(self, **kwargs): set to a value later than the expiry time. visibility_timeout should be set to a value smaller than the time-to-live value. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Returns a message from the Queue. :rtype: ~azure.storage.queue.QueueMessage @@ -611,7 +639,11 @@ def receive_messages(self, **kwargs): set to a value later than the expiry time. visibility_timeout should be set to a value smaller than the time-to-live value. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword int max_messages: An integer that specifies the maximum number of messages to retrieve from the queue. :return: @@ -690,7 +722,11 @@ def update_message(self, message can be updated until it has been deleted or has expired. The message object or message id identifying the message to update. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A :class:`~azure.storage.queue.QueueMessage` object. For convenience, this object is also populated with the content, although it is not returned by the service. @@ -791,7 +827,11 @@ def peek_messages(self, messages to peek from the queue, up to a maximum of 32. By default, a single message is peeked from the queue with this operation. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A list of :class:`~azure.storage.queue.QueueMessage` objects. Note that next_visible_on and pop_receipt will not be populated as peek does @@ -833,7 +873,11 @@ def clear_messages(self, **kwargs): """Deletes all messages from the specified queue. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -876,7 +920,11 @@ def delete_message(self, A valid pop receipt value returned from an earlier call to the :func:`~receive_messages` or :func:`~update_message`. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py index 90a50b5f74b5..6b5422756a52 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py @@ -293,7 +293,11 @@ def list_queues( The maximum number of queue names to retrieve per API call. If the request does not specify the server will return up to 5,000 items. :keyword int timeout: - The server timeout, expressed in seconds. This function may make multiple + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This function may make multiple calls to the service in which case the timeout value specified will be applied to each individual call. :returns: An iterable (auto-paging) of QueueProperties. diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py index 60bff6a2891b..d70caf0452b9 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py @@ -113,7 +113,11 @@ async def create_queue(self, **kwargs): metadata. Note that metadata names preserve the case with which they were created, but are case-insensitive when set or read. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: None or the result of cls(response) :rtype: None :raises: StorageErrorException @@ -152,7 +156,11 @@ async def delete_queue(self, **kwargs): an :class:`HttpResponseError` will be thrown. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :rtype: None .. admonition:: Example: @@ -213,7 +221,11 @@ async def set_queue_metadata(self, metadata=None, **kwargs): queue as metadata. :type metadata: dict(str, str) :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -241,7 +253,11 @@ async def get_queue_access_policy(self, **kwargs): queue that may be used with Shared Access Signatures. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A dictionary of access policies associated with the queue. :rtype: dict(str, ~azure.storage.queue.AccessPolicy) """ @@ -277,7 +293,11 @@ async def set_queue_access_policy(self, signed_identifiers, **kwargs): will clear the access policies set on the service. :type signed_identifiers: dict(str, ~azure.storage.queue.AccessPolicy) :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -342,7 +362,11 @@ async def send_message( # type: ignore seconds. The time-to-live may be any positive number or -1 for infinity. If this parameter is omitted, the default time-to-live is 7 days. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A :class:`~azure.storage.queue.QueueMessage` object. This object is also populated with the content although it is not @@ -421,7 +445,11 @@ async def receive_message(self, **kwargs): set to a value later than the expiry time. visibility_timeout should be set to a value smaller than the time-to-live value. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: Returns a message from the Queue. :rtype: ~azure.storage.queue.QueueMessage @@ -486,7 +514,11 @@ def receive_messages(self, **kwargs): set to a value later than the expiry time. visibility_timeout should be set to a value smaller than the time-to-live value. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :keyword int max_messages: An integer that specifies the maximum number of messages to retrieve from the queue. :return: @@ -567,7 +599,11 @@ async def update_message( message can be updated until it has been deleted or has expired. The message object or message id identifying the message to update. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A :class:`~azure.storage.queue.QueueMessage` object. For convenience, this object is also populated with the content, although it is not returned by the service. @@ -668,7 +704,11 @@ async def peek_messages(self, max_messages=None, **kwargs): messages to peek from the queue, up to a maximum of 32. By default, a single message is peeked from the queue with this operation. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. :return: A list of :class:`~azure.storage.queue.QueueMessage` objects. Note that next_visible_on and pop_receipt will not be populated as peek does @@ -709,7 +749,11 @@ async def clear_messages(self, **kwargs): """Deletes all messages from the specified queue. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: @@ -748,7 +792,11 @@ async def delete_message(self, message, pop_receipt=None, **kwargs): A valid pop receipt value returned from an earlier call to the :func:`~receive_messages` or :func:`~update_message`. :keyword int timeout: - The server timeout, expressed in seconds. + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. .. admonition:: Example: diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py index 423d8ac1c515..191a15f40969 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py @@ -240,7 +240,11 @@ def list_queues( The maximum number of queue names to retrieve per API call. If the request does not specify the server will return up to 5,000 items. :keyword int timeout: - The server timeout, expressed in seconds. This function may make multiple + Sets the server-side timeout for the operation in seconds. For more details see + https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations. + This value is not tracked or validated on the client. To configure client-side network timesouts + see `here `_. This function may make multiple calls to the service in which case the timeout value specified will be applied to each individual call. :returns: An iterable (auto-paging) of QueueProperties.