Skip to content

Commit b29880b

Browse files
[Storage] Documented results_per_page keyword for list_blobs and list_blob_names APIs (#42033)
1 parent 33ff845 commit b29880b

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -812,6 +812,9 @@ def list_blobs(
812812
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
813813
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
814814
:type include: list[str] or str
815+
:keyword int results_per_page:
816+
Controls the maximum number of Blobs that will be included in each page of results if using
817+
`ItemPaged.by_page()`.
815818
:keyword int timeout:
816819
Sets the server-side timeout for the operation in seconds. For more details see
817820
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
@@ -861,6 +864,9 @@ def list_blob_names(self, **kwargs: Any) -> ItemPaged[str]:
861864
:keyword str name_starts_with:
862865
Filters the results to return only blobs whose names
863866
begin with the specified prefix.
867+
:keyword int results_per_page:
868+
Controls the maximum number of Blobs that will be included in each page of results if using
869+
`ItemPaged.by_page()`.
864870
:keyword int timeout:
865871
Sets the server-side timeout for the operation in seconds. For more details see
866872
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.

sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -798,6 +798,9 @@ def list_blobs(
798798
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
799799
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
800800
:type include: list[str] or str
801+
:keyword int results_per_page:
802+
Controls the maximum number of Blobs that will be included in each page of results if using
803+
`AsyncItemPaged.by_page()`.
801804
:keyword int timeout:
802805
Sets the server-side timeout for the operation in seconds. For more details see
803806
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
@@ -851,6 +854,9 @@ def list_blob_names(self, **kwargs: Any) -> AsyncItemPaged[str]:
851854
:keyword str name_starts_with:
852855
Filters the results to return only blobs whose names
853856
begin with the specified prefix.
857+
:keyword int results_per_page:
858+
Controls the maximum number of Blobs that will be included in each page of results if using
859+
`AsyncItemPaged.by_page()`.
854860
:keyword int timeout:
855861
Sets the server-side timeout for the operation in seconds. For more details see
856862
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.

0 commit comments

Comments
 (0)