Skip to content

Commit 82a5f73

Browse files
Update docs for download_blob and delete_blobs (Azure#22859)
1 parent c506edc commit 82a5f73

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,6 +1042,13 @@ def download_blob(self, blob, offset=None, length=None, **kwargs):
10421042
:param int length:
10431043
Number of bytes to read from the stream. This is optional, but
10441044
should be supplied for optimal performance.
1045+
:keyword str version_id:
1046+
The version id parameter is an opaque DateTime
1047+
value that, when present, specifies the version of the blob to download.
1048+
1049+
.. versionadded:: 12.4.0
1050+
This keyword argument was introduced in API version '2019-12-12'.
1051+
10451052
:keyword bool validate_content:
10461053
If true, calculates an MD5 hash for each chunk of the blob. The storage
10471054
service checks the hash of the content that has arrived with the hash
@@ -1232,6 +1239,8 @@ def delete_blobs(self, *blobs, **kwargs):
12321239
Soft deleted blobs or snapshots are accessible through :func:`list_blobs()` specifying `include=["deleted"]`
12331240
Soft-deleted blobs or snapshots can be restored using :func:`~BlobClient.undelete()`
12341241
1242+
The maximum number of blobs that can be deleted in a single request is 256.
1243+
12351244
:param blobs:
12361245
The blobs to delete. This can be a single blob, or multiple values can
12371246
be supplied, where each value is either the name of the blob (str) or BlobProperties.
@@ -1406,6 +1415,8 @@ def set_standard_blob_tier_blobs(
14061415
A block blob's tier determines Hot/Cool/Archive storage type.
14071416
This operation does not update the blob's ETag.
14081417
1418+
The maximum number of blobs that can be updated in a single request is 256.
1419+
14091420
:param standard_blob_tier:
14101421
Indicates the tier to be set on all blobs. Options include 'Hot', 'Cool',
14111422
'Archive'. The hot tier is optimized for storing data that is accessed
@@ -1474,6 +1485,8 @@ def set_premium_page_blob_tier_blobs(
14741485
# type: (...) -> Iterator[HttpResponse]
14751486
"""Sets the page blob tiers on all blobs. This API is only supported for page blobs on premium accounts.
14761487
1488+
The maximum number of blobs that can be updated in a single request is 256.
1489+
14771490
:param premium_page_blob_tier:
14781491
A page blob tier value to set the blob to. The tier correlates to the size of the
14791492
blob and number of allowed IOPS. This is only applicable to page blobs on

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -902,6 +902,13 @@ async def download_blob(self, blob, offset=None, length=None, **kwargs):
902902
:param int length:
903903
Number of bytes to read from the stream. This is optional, but
904904
should be supplied for optimal performance.
905+
:keyword str version_id:
906+
The version id parameter is an opaque DateTime
907+
value that, when present, specifies the version of the blob to download.
908+
909+
.. versionadded:: 12.4.0
910+
This keyword argument was introduced in API version '2019-12-12'.
911+
905912
:keyword bool validate_content:
906913
If true, calculates an MD5 hash for each chunk of the blob. The storage
907914
service checks the hash of the content that has arrived with the hash
@@ -979,6 +986,8 @@ async def delete_blobs( # pylint: disable=arguments-differ
979986
Soft deleted blobs or snapshots are accessible through :func:`list_blobs()` specifying `include=["deleted"]`
980987
Soft-deleted blobs or snapshots can be restored using :func:`~BlobClient.undelete()`
981988
989+
The maximum number of blobs that can be deleted in a single request is 256.
990+
982991
:param blobs:
983992
The blobs to delete. This can be a single blob, or multiple values can
984993
be supplied, where each value is either the name of the blob (str) or BlobProperties.
@@ -1065,6 +1074,8 @@ async def set_standard_blob_tier_blobs(
10651074
A block blob's tier determines Hot/Cool/Archive storage type.
10661075
This operation does not update the blob's ETag.
10671076
1077+
The maximum number of blobs that can be updated in a single request is 256.
1078+
10681079
:param standard_blob_tier:
10691080
Indicates the tier to be set on all blobs. Options include 'Hot', 'Cool',
10701081
'Archive'. The hot tier is optimized for storing data that is accessed
@@ -1128,6 +1139,8 @@ async def set_premium_page_blob_tier_blobs(
11281139
) -> AsyncIterator[AsyncHttpResponse]:
11291140
"""Sets the page blob tiers on the blobs. This API is only supported for page blobs on premium accounts.
11301141
1142+
The maximum number of blobs that can be updated in a single request is 256.
1143+
11311144
:param premium_page_blob_tier:
11321145
A page blob tier value to set on all blobs to. The tier correlates to the size of the
11331146
blob and number of allowed IOPS. This is only applicable to page blobs on

0 commit comments

Comments
 (0)