From 14138558cd3c5786b7fdcdad6c7ddcb510922fac Mon Sep 17 00:00:00 2001 From: Michael Scovetta Date: Sat, 2 Nov 2019 15:41:42 -0700 Subject: [PATCH] Move `cpk` docs to right place in the docstring. The `cpk` docs were in the wrong place in most of the docstrings. This change just moves to them to the right spot (the last element). --- .../azure/storage/blob/blockblobservice.py | 62 +++++++++---------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/azure-storage-blob/azure/storage/blob/blockblobservice.py b/azure-storage-blob/azure/storage/blob/blockblobservice.py index 57a27029..c0b5bacf 100644 --- a/azure-storage-blob/azure/storage/blob/blockblobservice.py +++ b/azure-storage-blob/azure/storage/blob/blockblobservice.py @@ -174,13 +174,13 @@ def put_block(self, container_name, blob_name, block, block_id, blob. :param str lease_id: Required if the blob has an active lease. + :param int timeout: + The timeout parameter is expressed in seconds. :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. - :param int timeout: - The timeout parameter is expressed in seconds. + a secure connection must be established to transfer the key. ''' _validate_encryption_unsupported(self.require_encryption, self.key_encryption_key) @@ -254,16 +254,16 @@ def put_block_list( the value specified. Specify the wildcard character (*) to perform the operation only if the resource does not exist, and fail the operation if it does exist. - :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: - Encrypts the data on the service-side with the given key. - Use of customer-provided keys must be done over HTTPS. - As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. :param int timeout: The timeout parameter is expressed in seconds. :param StandardBlobTier standard_blob_tier: A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts. + :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: + Encrypts the data on the service-side with the given key. + Use of customer-provided keys must be done over HTTPS. + As the encryption key itself is provided in the request, + a secure connection must be established to transfer the key. :return: ETag and last modified properties for the updated Block Blob :rtype: :class:`~azure.storage.blob.models.ResourceProperties` ''' @@ -359,13 +359,13 @@ def put_block_from_url(self, container_name, blob_name, copy_source_url, block_i If given, the service will calculate the MD5 hash of the block content and compare against this value. :param str lease_id: Required if the blob has an active lease. + :param int timeout: + The timeout parameter is expressed in seconds. :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. - :param int timeout: - The timeout parameter is expressed in seconds. + a secure connection must be established to transfer the key. """ _validate_encryption_unsupported(self.require_encryption, self.key_encryption_key) _validate_not_none('container_name', container_name) @@ -460,11 +460,6 @@ def create_blob_from_path(self, container_name, blob_name, file_path, content_se the value specified. Specify the wildcard character (*) to perform the operation only if the resource does not exist, and fail the operation if it does exist. - :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: - Encrypts the data on the service-side with the given key. - Use of customer-provided keys must be done over HTTPS. - As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. :param int timeout: The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to @@ -472,6 +467,11 @@ def create_blob_from_path(self, container_name, blob_name, file_path, content_se :param StandardBlobTier standard_blob_tier: A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts. + :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: + Encrypts the data on the service-side with the given key. + Use of customer-provided keys must be done over HTTPS. + As the encryption key itself is provided in the request, + a secure connection must be established to transfer the key. :return: ETag and last modified properties for the Block Blob :rtype: :class:`~azure.storage.blob.models.ResourceProperties` ''' @@ -554,11 +554,6 @@ def create_blob_from_stream(self, container_name, blob_name, stream, count=None, the value specified. Specify the wildcard character (*) to perform the operation only if the resource does not exist, and fail the operation if it does exist. - :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: - Encrypts the data on the service-side with the given key. - Use of customer-provided keys must be done over HTTPS. - As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. :param int timeout: The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to @@ -583,6 +578,11 @@ def create_blob_from_stream(self, container_name, blob_name, stream, count=None, :param StandardBlobTier standard_blob_tier: A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts. + :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: + Encrypts the data on the service-side with the given key. + Use of customer-provided keys must be done over HTTPS. + As the encryption key itself is provided in the request, + a secure connection must be established to transfer the key. :return: ETag and last modified properties for the Block Blob :rtype: :class:`~azure.storage.blob.models.ResourceProperties` ''' @@ -763,11 +763,6 @@ def create_blob_from_bytes(self, container_name, blob_name, blob, index=0, count the value specified. Specify the wildcard character (*) to perform the operation only if the resource does not exist, and fail the operation if it does exist. - :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: - Encrypts the data on the service-side with the given key. - Use of customer-provided keys must be done over HTTPS. - As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. :param int timeout: The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to @@ -775,6 +770,11 @@ def create_blob_from_bytes(self, container_name, blob_name, blob, index=0, count :param StandardBlobTier standard_blob_tier: A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts. + :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: + Encrypts the data on the service-side with the given key. + Use of customer-provided keys must be done over HTTPS. + As the encryption key itself is provided in the request, + a secure connection must be established to transfer the key. :return: ETag and last modified properties for the Block Blob :rtype: :class:`~azure.storage.blob.models.ResourceProperties` ''' @@ -861,11 +861,6 @@ def create_blob_from_text(self, container_name, blob_name, text, encoding='utf-8 the value specified. Specify the wildcard character (*) to perform the operation only if the resource does not exist, and fail the operation if it does exist. - :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: - Encrypts the data on the service-side with the given key. - Use of customer-provided keys must be done over HTTPS. - As the encryption key itself is provided in the request, - a secure connection must be established to transfer the key. :param int timeout: The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to @@ -873,6 +868,11 @@ def create_blob_from_text(self, container_name, blob_name, text, encoding='utf-8 :param StandardBlobTier standard_blob_tier: A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts. + :param ~azure.storage.blob.models.CustomerProvidedEncryptionKey cpk: + Encrypts the data on the service-side with the given key. + Use of customer-provided keys must be done over HTTPS. + As the encryption key itself is provided in the request, + a secure connection must be established to transfer the key. :return: ETag and last modified properties for the Block Blob :rtype: :class:`~azure.storage.blob.models.ResourceProperties` '''