@@ -137,7 +137,7 @@ def _format_url(self, hostname):
137
137
138
138
:param str hostname:
139
139
The hostname of the current location mode.
140
- :returns : A formatted endpoint URL including current location mode hostname.
140
+ :return : A formatted endpoint URL including current location mode hostname.
141
141
:rtype: str
142
142
"""
143
143
return f"{ self .scheme } ://{ hostname } /{ self ._query_str } "
@@ -169,7 +169,7 @@ def from_connection_string(
169
169
:keyword str audience: The audience to use when requesting tokens for Azure Active Directory
170
170
authentication. Only has an effect when credential is of type TokenCredential. The value could be
171
171
https://storage.azure.com/ (default) or https://<account>.blob.core.windows.net.
172
- :returns : A Blob service client.
172
+ :return : A Blob service client.
173
173
:rtype: ~azure.storage.blob.BlobServiceClient
174
174
175
175
.. admonition:: Example:
@@ -206,7 +206,7 @@ def get_user_delegation_key(
206
206
This value is not tracked or validated on the client. To configure client-side network timesouts
207
207
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
208
208
#other-client--per-operation-configuration>`__.
209
- :returns : The user delegation key.
209
+ :return : The user delegation key.
210
210
:rtype: ~azure.storage.blob.UserDelegationKey
211
211
"""
212
212
key_info = KeyInfo (start = _to_utc_datetime (key_start_time ), expiry = _to_utc_datetime (key_expiry_time ))
@@ -227,7 +227,7 @@ def get_account_information(self, **kwargs: Any) -> Dict[str, str]:
227
227
The information can also be retrieved if the user has a SAS to a container or blob.
228
228
The keys in the returned dictionary include 'sku_name' and 'account_kind'.
229
229
230
- :returns : A dict of account information (SKU and account type).
230
+ :return : A dict of account information (SKU and account type).
231
231
:rtype: dict(str, str)
232
232
233
233
.. admonition:: Example:
@@ -270,7 +270,7 @@ def get_service_stats(self, **kwargs: Any) -> Dict[str, Any]:
270
270
This value is not tracked or validated on the client. To configure client-side network timesouts
271
271
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
272
272
#other-client--per-operation-configuration>`__.
273
- :returns : The blob service stats.
273
+ :return : The blob service stats.
274
274
:rtype: Dict[str, Any]
275
275
276
276
.. admonition:: Example:
@@ -301,7 +301,7 @@ def get_service_properties(self, **kwargs: Any) -> Dict[str, Any]:
301
301
This value is not tracked or validated on the client. To configure client-side network timesouts
302
302
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
303
303
#other-client--per-operation-configuration>`__.
304
- :returns : An object containing blob service properties such as
304
+ :return : An object containing blob service properties such as
305
305
analytics logging, hour/minute metrics, cors rules, etc.
306
306
:rtype: Dict[str, Any]
307
307
@@ -371,6 +371,7 @@ def set_service_properties(
371
371
This value is not tracked or validated on the client. To configure client-side network timesouts
372
372
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
373
373
#other-client--per-operation-configuration>`__.
374
+ :return: None
374
375
:rtype: None
375
376
376
377
.. admonition:: Example:
@@ -435,7 +436,7 @@ def list_containers(
435
436
This value is not tracked or validated on the client. To configure client-side network timesouts
436
437
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
437
438
#other-client--per-operation-configuration>`__.
438
- :returns : An iterable (auto-paging) of ContainerProperties.
439
+ :return : An iterable (auto-paging) of ContainerProperties.
439
440
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.ContainerProperties]
440
441
441
442
.. admonition:: Example:
@@ -489,7 +490,7 @@ def find_blobs_by_tags(self, filter_expression: str, **kwargs: Any) -> ItemPaged
489
490
This value is not tracked or validated on the client. To configure client-side network timesouts
490
491
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
491
492
#other-client--per-operation-configuration>`__.
492
- :returns : An iterable (auto-paging) response of BlobProperties.
493
+ :return : An iterable (auto-paging) response of BlobProperties.
493
494
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.FilteredBlob]
494
495
"""
495
496
@@ -538,7 +539,7 @@ def create_container(
538
539
This value is not tracked or validated on the client. To configure client-side network timesouts
539
540
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
540
541
#other-client--per-operation-configuration>`__.
541
- :returns : A container client to interact with the newly created container.
542
+ :return : A container client to interact with the newly created container.
542
543
:rtype: ~azure.storage.blob.ContainerClient
543
544
544
545
.. admonition:: Example:
@@ -600,6 +601,8 @@ def delete_container(
600
601
This value is not tracked or validated on the client. To configure client-side network timesouts
601
602
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
602
603
#other-client--per-operation-configuration>`__.
604
+ :return: None
605
+ :rtype: None
603
606
604
607
.. admonition:: Example:
605
608
@@ -638,7 +641,7 @@ def _rename_container(self, name: str, new_name: str, **kwargs: Any) -> Containe
638
641
This value is not tracked or validated on the client. To configure client-side network timesouts
639
642
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
640
643
#other-client--per-operation-configuration>`__.
641
- :returns : A container client for the renamed container.
644
+ :return : A container client for the renamed container.
642
645
:rtype: ~azure.storage.blob.ContainerClient
643
646
"""
644
647
renamed_container = self .get_container_client (new_name )
@@ -677,7 +680,7 @@ def undelete_container(
677
680
This value is not tracked or validated on the client. To configure client-side network timesouts
678
681
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
679
682
#other-client--per-operation-configuration>`__.
680
- :returns : The undeleted ContainerClient.
683
+ :return : The undeleted ContainerClient.
681
684
:rtype: ~azure.storage.blob.ContainerClient
682
685
"""
683
686
new_name = kwargs .pop ('new_name' , None )
@@ -701,7 +704,7 @@ def get_container_client(self, container: Union[ContainerProperties, str]) -> Co
701
704
The container. This can either be the name of the container,
702
705
or an instance of ContainerProperties.
703
706
:type container: str or ~azure.storage.blob.ContainerProperties
704
- :returns : A ContainerClient.
707
+ :return : A ContainerClient.
705
708
:rtype: ~azure.storage.blob.ContainerClient
706
709
707
710
.. admonition:: Example:
@@ -750,7 +753,7 @@ def get_blob_client(
750
753
:type snapshot: str or dict(str, Any)
751
754
:keyword str version_id: The version id parameter is an opaque DateTime value that, when present,
752
755
specifies the version of the blob to operate on.
753
- :returns : A BlobClient.
756
+ :return : A BlobClient.
754
757
:rtype: ~azure.storage.blob.BlobClient
755
758
756
759
.. admonition:: Example:
0 commit comments