Skip to content

Commit

Permalink
Update docs for download_blob and delete_blobs (Azure#22859)
Browse files Browse the repository at this point in the history
  • Loading branch information
jalauzon-msft authored Feb 1, 2022
1 parent c506edc commit 82a5f73
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1042,6 +1042,13 @@ def download_blob(self, blob, offset=None, length=None, **kwargs):
:param int length:
Number of bytes to read from the stream. This is optional, but
should be supplied for optimal performance.
:keyword str version_id:
The version id parameter is an opaque DateTime
value that, when present, specifies the version of the blob to download.
.. versionadded:: 12.4.0
This keyword argument was introduced in API version '2019-12-12'.
:keyword bool validate_content:
If true, calculates an MD5 hash for each chunk of the blob. The storage
service checks the hash of the content that has arrived with the hash
Expand Down Expand Up @@ -1232,6 +1239,8 @@ def delete_blobs(self, *blobs, **kwargs):
Soft deleted blobs or snapshots are accessible through :func:`list_blobs()` specifying `include=["deleted"]`
Soft-deleted blobs or snapshots can be restored using :func:`~BlobClient.undelete()`
The maximum number of blobs that can be deleted in a single request is 256.
:param blobs:
The blobs to delete. This can be a single blob, or multiple values can
be supplied, where each value is either the name of the blob (str) or BlobProperties.
Expand Down Expand Up @@ -1406,6 +1415,8 @@ def set_standard_blob_tier_blobs(
A block blob's tier determines Hot/Cool/Archive storage type.
This operation does not update the blob's ETag.
The maximum number of blobs that can be updated in a single request is 256.
:param standard_blob_tier:
Indicates the tier to be set on all blobs. Options include 'Hot', 'Cool',
'Archive'. The hot tier is optimized for storing data that is accessed
Expand Down Expand Up @@ -1474,6 +1485,8 @@ def set_premium_page_blob_tier_blobs(
# type: (...) -> Iterator[HttpResponse]
"""Sets the page blob tiers on all blobs. This API is only supported for page blobs on premium accounts.
The maximum number of blobs that can be updated in a single request is 256.
:param 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -902,6 +902,13 @@ async def download_blob(self, blob, offset=None, length=None, **kwargs):
:param int length:
Number of bytes to read from the stream. This is optional, but
should be supplied for optimal performance.
:keyword str version_id:
The version id parameter is an opaque DateTime
value that, when present, specifies the version of the blob to download.
.. versionadded:: 12.4.0
This keyword argument was introduced in API version '2019-12-12'.
:keyword bool validate_content:
If true, calculates an MD5 hash for each chunk of the blob. The storage
service checks the hash of the content that has arrived with the hash
Expand Down Expand Up @@ -979,6 +986,8 @@ async def delete_blobs( # pylint: disable=arguments-differ
Soft deleted blobs or snapshots are accessible through :func:`list_blobs()` specifying `include=["deleted"]`
Soft-deleted blobs or snapshots can be restored using :func:`~BlobClient.undelete()`
The maximum number of blobs that can be deleted in a single request is 256.
:param blobs:
The blobs to delete. This can be a single blob, or multiple values can
be supplied, where each value is either the name of the blob (str) or BlobProperties.
Expand Down Expand Up @@ -1065,6 +1074,8 @@ async def set_standard_blob_tier_blobs(
A block blob's tier determines Hot/Cool/Archive storage type.
This operation does not update the blob's ETag.
The maximum number of blobs that can be updated in a single request is 256.
:param standard_blob_tier:
Indicates the tier to be set on all blobs. Options include 'Hot', 'Cool',
'Archive'. The hot tier is optimized for storing data that is accessed
Expand Down Expand Up @@ -1128,6 +1139,8 @@ async def set_premium_page_blob_tier_blobs(
) -> AsyncIterator[AsyncHttpResponse]:
"""Sets the page blob tiers on the blobs. This API is only supported for page blobs on premium accounts.
The maximum number of blobs that can be updated in a single request is 256.
:param premium_page_blob_tier:
A page blob tier value to set on all blobs to. The tier correlates to the size of the
blob and number of allowed IOPS. This is only applicable to page blobs on
Expand Down

0 comments on commit 82a5f73

Please sign in to comment.