diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py index 82efc1d5313f..b6c4e97c6677 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py @@ -91,7 +91,7 @@ class BlobClient(StorageAccountHostsMixin, StorageEncryptionMixin): # pylint: d For more optional configuration, please click `here `_. + #optional-configuration>`__. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the blob, @@ -541,7 +541,7 @@ def upload_blob_from_url(self, source_url, **kwargs): The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) :paramtype tags: dict(str, str) :keyword bytearray source_content_md5: Specify the md5 that is used to verify the integrity of the source bytes. @@ -589,7 +589,7 @@ def upload_blob_from_url(self, source_url, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword ~azure.storage.blob.ContentSettings content_settings: ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control. @@ -645,7 +645,7 @@ def upload_blob( The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -751,7 +751,7 @@ def upload_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. :returns: Blob-updated property dict (Etag and last modified) :rtype: dict[str, Any] @@ -870,6 +870,7 @@ def download_blob( 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: @@ -928,7 +929,7 @@ def download_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. @@ -1084,7 +1085,7 @@ def query_blob(self, query_expression, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A streaming object (BlobQueryReader) :rtype: ~azure.storage.blob.BlobQueryReader @@ -1167,6 +1168,7 @@ def delete_blob(self, delete_snapshots=None, **kwargs): value that, when present, specifies the version of the blob to delete. .. versionadded:: 12.4.0 + This keyword argument was introduced in API version '2019-12-12'. :keyword lease: @@ -1202,7 +1204,7 @@ def delete_blob(self, delete_snapshots=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -1237,7 +1239,7 @@ def undelete_blob(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -1269,7 +1271,7 @@ def exists(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: boolean :rtype: bool """ @@ -1304,6 +1306,7 @@ def get_blob_properties(self, **kwargs): value that, when present, specifies the version of the blob to get properties. .. versionadded:: 12.4.0 + This keyword argument was introduced in API version '2019-12-12'. :keyword ~datetime.datetime if_modified_since: @@ -1339,7 +1342,7 @@ def get_blob_properties(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: BlobProperties :rtype: ~azure.storage.blob.BlobProperties @@ -1449,7 +1452,7 @@ def set_http_headers(self, content_settings=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -1540,7 +1543,7 @@ def set_blob_metadata(self, metadata=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Union[str, datetime]] """ @@ -1569,7 +1572,7 @@ def set_immutability_policy(self, immutability_policy, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -1591,7 +1594,7 @@ def delete_immutability_policy(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -1613,7 +1616,7 @@ def set_legal_hold(self, legal_hold, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] """ @@ -1715,7 +1718,7 @@ def create_page_blob( # type: ignore The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -1775,7 +1778,7 @@ def create_page_blob( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1857,7 +1860,7 @@ def create_append_blob(self, content_settings=None, metadata=None, **kwargs): The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -1913,7 +1916,7 @@ def create_append_blob(self, content_settings=None, metadata=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -2012,7 +2015,7 @@ def create_snapshot(self, metadata=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] @@ -2171,7 +2174,7 @@ def start_copy_from_url(self, source_url, metadata=None, incremental_copy=False, The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_). + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_). The (case-sensitive) literal "COPY" can instead be passed to copy tags from the source blob. This option is only available when `incremental_copy=False` and `requires_sync=True`. @@ -2243,7 +2246,7 @@ def start_copy_from_url(self, source_url, metadata=None, incremental_copy=False, https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword ~azure.storage.blob.PremiumPageBlobTier 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 @@ -2390,7 +2393,7 @@ def acquire_lease(self, lease_duration=-1, lease_id=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A BlobLeaseClient object. :rtype: ~azure.storage.blob.BlobLeaseClient @@ -2430,18 +2433,20 @@ def set_standard_blob_tier(self, standard_blob_tier, **kwargs): 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 str if_tags_match_condition: Specify a SQL where clause on blob tags to operate only on blob with a matching value. eg. ``\"\\\"tagname\\\"='my tag'\"`` .. versionadded:: 12.4.0 + :keyword int timeout: Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -2561,7 +2566,7 @@ def stage_block( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob property dict. :rtype: dict[str, Any] """ @@ -2665,7 +2670,7 @@ def stage_block_from_url( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -2718,7 +2723,7 @@ def get_block_list(self, block_list_type="committed", **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A tuple of two lists - committed and uncommitted blocks :rtype: tuple(list(~azure.storage.blob.BlobBlock), list(~azure.storage.blob.BlobBlock)) """ @@ -2830,7 +2835,7 @@ def commit_block_list( # type: ignore The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -2901,7 +2906,7 @@ def commit_block_list( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2936,7 +2941,7 @@ def set_premium_page_blob_tier(self, premium_page_blob_tier, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -2988,7 +2993,7 @@ def set_blob_tags(self, tags=None, **kwargs): The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) :type tags: dict(str, str) :keyword str version_id: The version id parameter is an opaque DateTime @@ -3012,7 +3017,7 @@ def set_blob_tags(self, tags=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -3060,7 +3065,7 @@ def get_blob_tags(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -3165,7 +3170,7 @@ def get_page_ranges( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -3257,7 +3262,7 @@ def list_page_ranges( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) of PageRange. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange] """ @@ -3340,7 +3345,7 @@ def get_page_range_diff_for_managed_disk( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -3417,7 +3422,7 @@ def set_sequence_number(self, sequence_number_action, sequence_number=None, **kw https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3499,7 +3504,7 @@ def resize_blob(self, size, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3644,7 +3649,7 @@ def upload_page( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -3820,7 +3825,7 @@ def upload_pages_from_url(self, source_url, # type: str https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -3938,7 +3943,7 @@ def clear_page(self, offset, length, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -4082,7 +4087,7 @@ def append_block( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ @@ -4250,7 +4255,7 @@ def append_block_from_url(self, copy_source_url, # type: str https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -4330,7 +4335,7 @@ def seal_append_blob(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py index 7c97aa2fb417..7978b9e8ef5b 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py @@ -64,7 +64,7 @@ class BlobServiceClient(StorageAccountHostsMixin, StorageEncryptionMixin): For more optional configuration, please click `here `_. + #optional-configuration>`__. :param str account_url: The URL to the blob storage account. Any other entities included @@ -216,7 +216,7 @@ def get_user_delegation_key(self, key_start_time, # type: datetime https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: The user delegation key. :rtype: ~azure.storage.blob.UserDelegationKey """ @@ -282,7 +282,7 @@ def get_service_stats(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: The blob service stats. :rtype: Dict[str, Any] @@ -314,7 +314,7 @@ def get_service_properties(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An object containing blob service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] @@ -385,7 +385,7 @@ def set_service_properties( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -450,7 +450,7 @@ def list_containers( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) of ContainerProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.ContainerProperties] @@ -505,7 +505,7 @@ def find_blobs_by_tags(self, filter_expression, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.FilteredBlob] """ @@ -555,7 +555,7 @@ def create_container( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A container client to interact with the newly created container. :rtype: ~azure.storage.blob.ContainerClient @@ -617,7 +617,7 @@ def delete_container( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. .. admonition:: Example: @@ -656,7 +656,7 @@ def _rename_container(self, name, new_name, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A container client for the renamed container. :rtype: ~azure.storage.blob.ContainerClient """ @@ -692,7 +692,7 @@ def undelete_container(self, deleted_container_name, deleted_container_version, https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: The undeleted ContainerClient. :rtype: ~azure.storage.blob.ContainerClient """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py index 39e731c019e6..fb74060ae603 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py @@ -84,7 +84,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py For more optional configuration, please click `here `_. + #optional-configuration>`__. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the container, @@ -306,7 +306,7 @@ def create_container(self, metadata=None, public_access=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -352,7 +352,7 @@ def _rename_container(self, new_name, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: The renamed container client. :rtype: ~azure.storage.blob.ContainerClient """ @@ -408,7 +408,7 @@ def delete_container( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -474,7 +474,7 @@ def acquire_lease( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A BlobLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.blob.BlobLeaseClient @@ -524,7 +524,7 @@ def get_container_properties(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: Properties for the specified container within a container object. :rtype: ~azure.storage.blob.ContainerProperties @@ -562,7 +562,7 @@ def exists(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: boolean :rtype: bool """ @@ -614,7 +614,7 @@ def set_container_metadata( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Container-updated property dict (Etag and last modified). :rtype: dict[str, str or datetime] @@ -693,7 +693,7 @@ def get_container_access_policy(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Access policy information in a dict. :rtype: dict[str, Any] @@ -760,7 +760,7 @@ def set_container_access_policy( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Container-updated property dict (Etag and last modified). :rtype: dict[str, str or ~datetime.datetime] @@ -823,7 +823,7 @@ def list_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] @@ -872,7 +872,7 @@ def list_blob_names(self, **kwargs: Any) -> ItemPaged[str]: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of blob names as strings. :rtype: ~azure.core.paging.ItemPaged[str] """ @@ -929,7 +929,7 @@ def walk_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] """ @@ -975,7 +975,7 @@ def find_blobs_by_tags( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of FilteredBlob. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] """ @@ -1062,7 +1062,7 @@ def upload_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. :keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier: A page blob tier value to set the blob to. The tier correlates to the size of the @@ -1163,6 +1163,7 @@ def delete_blob( value that, when present, specifies the version of the blob to delete. .. versionadded:: 12.4.0 + This keyword argument was introduced in API version '2019-12-12'. :keyword lease: @@ -1197,7 +1198,7 @@ def delete_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None """ if isinstance(blob, BlobProperties): @@ -1261,6 +1262,7 @@ def download_blob( 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: @@ -1319,7 +1321,7 @@ def download_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. @@ -1538,7 +1540,7 @@ def delete_blobs( # pylint: disable=delete-operation-wrong-return-type https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: An iterator of responses, one for each blob in order :rtype: Iterator[~azure.core.pipeline.transport.HttpResponse] @@ -1708,7 +1710,7 @@ def set_standard_blob_tier_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. @@ -1761,7 +1763,7 @@ def set_premium_page_blob_tier_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py index 68320f99fd2a..f25c0f20a134 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_lease.py @@ -108,7 +108,7 @@ def acquire(self, lease_duration=-1, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None """ mod_conditions = get_modify_conditions(kwargs) @@ -165,7 +165,7 @@ def renew(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -219,7 +219,7 @@ def release(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -272,7 +272,7 @@ def change(self, proposed_lease_id, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -335,7 +335,7 @@ def break_lease(self, lease_break_period=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_models.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_models.py index d59fcc878d94..d8cf64236bdd 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_models.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_models.py @@ -1064,7 +1064,7 @@ def _from_generated(cls, generated): class DelimitedJsonDialect(DictMixin): """Defines the input or output JSON serialization for a blob data query. - :keyword str delimiter: The line separator character, default value is '\n' + :keyword str delimiter: The line separator character, default value is '\\\\n'. """ def __init__(self, **kwargs): diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py index 71807b6d989c..fddd163de417 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py @@ -186,7 +186,7 @@ async def upload_blob_from_url(self, source_url, **kwargs): The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) :paramtype tags: dict(str, str) :keyword bytearray source_content_md5: Specify the md5 that is used to verify the integrity of the source bytes. @@ -234,7 +234,7 @@ async def upload_blob_from_url(self, source_url, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword ~azure.storage.blob.ContentSettings content_settings: ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control. @@ -289,7 +289,7 @@ async def upload_blob( The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -395,7 +395,7 @@ async def upload_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. @@ -463,6 +463,7 @@ async def download_blob( 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: @@ -521,7 +522,7 @@ async def download_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. @@ -571,6 +572,7 @@ async def delete_blob(self, delete_snapshots=None, **kwargs): value that, when present, specifies the version of the blob to delete. .. versionadded:: 12.4.0 + This keyword argument was introduced in API version '2019-12-12'. :keyword lease: @@ -606,7 +608,7 @@ async def delete_blob(self, delete_snapshots=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -641,7 +643,7 @@ async def undelete_blob(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -673,7 +675,7 @@ async def exists(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: boolean :rtype: bool """ @@ -708,6 +710,7 @@ async def get_blob_properties(self, **kwargs): value that, when present, specifies the version of the blob to get properties. .. versionadded:: 12.4.0 + This keyword argument was introduced in API version '2019-12-12'. :keyword ~datetime.datetime if_modified_since: @@ -743,7 +746,7 @@ async def get_blob_properties(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: BlobProperties :rtype: ~azure.storage.blob.BlobProperties @@ -829,7 +832,7 @@ async def set_http_headers(self, content_settings=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -894,7 +897,7 @@ async def set_blob_metadata(self, metadata=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Union[str, datetime]] """ @@ -923,7 +926,7 @@ async def set_immutability_policy(self, immutability_policy, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -945,7 +948,7 @@ async def delete_immutability_policy(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -967,7 +970,7 @@ async def set_legal_hold(self, legal_hold, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] """ @@ -1003,7 +1006,7 @@ async def create_page_blob( # type: ignore The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -1063,7 +1066,7 @@ async def create_page_blob( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1096,7 +1099,7 @@ async def create_append_blob(self, content_settings=None, metadata=None, **kwarg The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -1152,7 +1155,7 @@ async def create_append_blob(self, content_settings=None, metadata=None, **kwarg https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ @@ -1226,7 +1229,7 @@ async def create_snapshot(self, metadata=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] @@ -1308,7 +1311,7 @@ async def start_copy_from_url(self, source_url, metadata=None, incremental_copy= The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_). + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_). The (case-sensitive) literal "COPY" can instead be passed to copy tags from the source blob. This option is only available when `incremental_copy=False` and `requires_sync=True`. @@ -1386,7 +1389,7 @@ async def start_copy_from_url(self, source_url, metadata=None, incremental_copy= https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword ~azure.storage.blob.PremiumPageBlobTier 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 @@ -1516,7 +1519,7 @@ async def acquire_lease(self, lease_duration=-1, lease_id=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A BlobLeaseClient object. :rtype: ~azure.storage.blob.aio.BlobLeaseClient @@ -1562,7 +1565,7 @@ async def set_standard_blob_tier(self, standard_blob_tier, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -1634,7 +1637,7 @@ async def stage_block( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob property dict. :rtype: Dict[str, Any] """ @@ -1694,7 +1697,7 @@ async def stage_block_from_url( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -1738,7 +1741,7 @@ async def get_block_list(self, block_list_type="committed", **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A tuple of two lists - committed and uncommitted blocks :rtype: tuple(list(~azure.storage.blob.BlobBlock), list(~azure.storage.blob.BlobBlock)) """ @@ -1780,7 +1783,7 @@ async def commit_block_list( # type: ignore The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) .. versionadded:: 12.4.0 @@ -1852,7 +1855,7 @@ async def commit_block_list( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -1887,7 +1890,7 @@ async def set_premium_page_blob_tier(self, premium_page_blob_tier, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. @@ -1923,7 +1926,7 @@ async def set_blob_tags(self, tags=None, **kwargs): The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), - space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) + space (' '), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_) :type tags: dict(str, str) :keyword str version_id: The version id parameter is an opaque DateTime @@ -1947,7 +1950,7 @@ async def set_blob_tags(self, tags=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ @@ -1980,7 +1983,7 @@ async def get_blob_tags(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ @@ -2052,7 +2055,7 @@ async def get_page_ranges( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -2144,7 +2147,7 @@ def list_page_ranges( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) of PageRange. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange] """ @@ -2227,7 +2230,7 @@ async def get_page_range_diff_for_managed_disk( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. @@ -2292,7 +2295,7 @@ async def set_sequence_number( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2350,7 +2353,7 @@ async def resize_blob(self, size, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2445,7 +2448,7 @@ async def upload_page( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2560,7 +2563,7 @@ async def upload_pages_from_url(self, source_url, # type: str https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -2641,7 +2644,7 @@ async def clear_page(self, offset, length, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -2731,7 +2734,7 @@ async def append_block( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ @@ -2838,7 +2841,7 @@ async def append_block_from_url(self, copy_source_url, # type: str https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword str source_authorization: Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " is the prefix of the source_authorization string. @@ -2895,7 +2898,7 @@ async def seal_append_blob(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Blob-updated property dict (Etag, last modified, append offset, committed block count). :rtype: dict(str, Any) """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py index af348a7b9d10..b8e181888763 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py @@ -151,7 +151,7 @@ async def get_user_delegation_key(self, key_start_time, # type: datetime https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: The user delegation key. :rtype: ~azure.storage.blob.UserDelegationKey """ @@ -217,7 +217,7 @@ async def get_service_stats(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: The blob service stats. :rtype: Dict[str, Any] @@ -249,7 +249,7 @@ async def get_service_properties(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An object containing blob service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] @@ -320,7 +320,7 @@ async def set_service_properties( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -385,7 +385,7 @@ def list_containers( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) of ContainerProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.ContainerProperties] @@ -439,7 +439,7 @@ def find_blobs_by_tags(self, filter_expression, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.FilteredBlob] """ @@ -489,7 +489,7 @@ async def create_container( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A container client to interact with the newly created container. :rtype: ~azure.storage.blob.aio.ContainerClient @@ -551,7 +551,7 @@ async def delete_container( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -591,7 +591,7 @@ async def _rename_container(self, name, new_name, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A container client for the renamed container. :rtype: ~azure.storage.blob.ContainerClient """ @@ -627,7 +627,7 @@ async def undelete_container(self, deleted_container_name, deleted_container_ver https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: The recovered soft-deleted ContainerClient. :rtype: ~azure.storage.blob.aio.ContainerClient """ diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py index eb5c0a2c4e92..1955ed8e21fc 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py @@ -161,7 +161,7 @@ async def create_container(self, metadata=None, public_access=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A dictionary of response headers. :rtype: Dict[str, Union[str, datetime]] @@ -207,7 +207,7 @@ async def _rename_container(self, new_name, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: The renamed container. :rtype: ~azure.storage.blob.ContainerClient """ @@ -263,7 +263,7 @@ async def delete_container( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None .. admonition:: Example: @@ -329,7 +329,7 @@ async def acquire_lease( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: A BlobLeaseClient object, that can be run in a context manager. :rtype: ~azure.storage.blob.aio.BlobLeaseClient @@ -379,7 +379,7 @@ async def get_container_properties(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: Properties for the specified container within a container object. :rtype: ~azure.storage.blob.ContainerProperties @@ -417,7 +417,7 @@ async def exists(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: boolean :rtype: bool """ @@ -460,7 +460,7 @@ async def set_container_metadata( # type: ignore https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Container-updated property dict (Etag and last modified). :rtype: Dict[str, Union[str, datetime]] @@ -540,7 +540,7 @@ async def get_container_access_policy(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Access policy information in a dict. :rtype: dict[str, Any] @@ -607,7 +607,7 @@ async def set_container_access_policy( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: Container-updated property dict (Etag and last modified). :rtype: dict[str, str or ~datetime.datetime] @@ -671,7 +671,7 @@ def list_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties] @@ -723,7 +723,7 @@ def list_blob_names(self, **kwargs: Any) -> AsyncItemPaged[str]: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of blob names as strings. :rtype: ~azure.core.async_paging.AsyncItemPaged[str] """ @@ -780,7 +780,7 @@ def walk_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of BlobProperties. :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties] """ @@ -826,7 +826,7 @@ def find_blobs_by_tags( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :returns: An iterable (auto-paging) response of FilteredBlob. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties] """ @@ -913,7 +913,7 @@ async def upload_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. @@ -1015,6 +1015,7 @@ async def delete_blob( value that, when present, specifies the version of the blob to delete. .. versionadded:: 12.4.0 + This keyword argument was introduced in API version '2019-12-12'. :keyword lease: @@ -1049,7 +1050,7 @@ async def delete_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None """ if isinstance(blob, BlobProperties): @@ -1113,6 +1114,7 @@ async def download_blob( 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: @@ -1171,7 +1173,7 @@ async def download_blob( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. This method may make multiple calls to the service and + #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually. @@ -1269,7 +1271,7 @@ async def delete_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: An async iterator of responses, one for each blob in order :rtype: asynciterator[~azure.core.pipeline.transport.AsyncHttpResponse] @@ -1321,6 +1323,7 @@ async def set_standard_blob_tier_blobs( .. note:: When the blob type is dict, here's a list of keys, value rules. + blob name: key: 'name', value type: str standard blob tier: @@ -1348,7 +1351,7 @@ async def set_standard_blob_tier_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. For optimal performance, @@ -1401,7 +1404,7 @@ async def set_premium_page_blob_tier_blobs( https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :keyword bool raise_on_any_failure: This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure. For optimal performance, diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py index 53d1a846a3df..2b6cc1a445d6 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/aio/_lease_async.py @@ -101,7 +101,7 @@ async def acquire(self, lease_duration=-1, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :rtype: None """ mod_conditions = get_modify_conditions(kwargs) @@ -158,7 +158,7 @@ async def renew(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -212,7 +212,7 @@ async def release(self, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -265,7 +265,7 @@ async def change(self, proposed_lease_id, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: None """ mod_conditions = get_modify_conditions(kwargs) @@ -328,7 +328,7 @@ async def break_lease(self, lease_break_period=None, **kwargs): https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see `here `_. + #other-client--per-operation-configuration>`__. :return: Approximate time remaining in the lease period, in seconds. :rtype: int """ diff --git a/sdk/storage/azure-storage-blob/pyproject.toml b/sdk/storage/azure-storage-blob/pyproject.toml index ff779a518143..c75e8bac159a 100644 --- a/sdk/storage/azure-storage-blob/pyproject.toml +++ b/sdk/storage/azure-storage-blob/pyproject.toml @@ -3,3 +3,4 @@ mypy = false pyright = false type_check_samples = false verifytypes = false +strict_sphinx = true