Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Storage] Update documentation for batch APIs to include batch size limit #22857

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1232,6 +1232,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 +1408,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 +1478,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 @@ -979,6 +979,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 +1067,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 +1132,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