azure/multiapi/storagev2/blob/v2021_08_06/_blob_client.py [735:2349]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - options = self._upload_blob_options( data, blob_type=blob_type, length=length, metadata=metadata, **kwargs) if blob_type == BlobType.BlockBlob: return upload_block_blob(**options) if blob_type == BlobType.PageBlob: return upload_page_blob(**options) return upload_append_blob(**options) def _download_blob_options(self, offset=None, length=None, encoding=None, **kwargs): # type: (Optional[int], Optional[int], Optional[str], **Any) -> Dict[str, Any] if self.require_encryption and not self.key_encryption_key: raise ValueError("Encryption required but no key was provided.") if length is not None and offset is None: raise ValueError("Offset value must not be None if length is set.") if length is not None: length = offset + length - 1 # Service actually uses an end-range inclusive index validate_content = kwargs.pop('validate_content', False) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) options = { 'clients': self._client, 'config': self._config, 'start_range': offset, 'end_range': length, 'version_id': kwargs.pop('version_id', None), 'validate_content': validate_content, 'encryption_options': { 'required': self.require_encryption, 'key': self.key_encryption_key, 'resolver': self.key_resolver_function}, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_info': cpk_info, 'download_cls': kwargs.pop('cls', None) or deserialize_blob_stream, 'max_concurrency':kwargs.pop('max_concurrency', 1), 'encoding': encoding, 'timeout': kwargs.pop('timeout', None), 'name': self.blob_name, 'container': self.container_name} options.update(kwargs) return options @overload def download_blob( self, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]: ... @overload def download_blob( self, offset: int = None, length: int = None, *, encoding: None = None, **kwargs) -> StorageStreamDownloader[bytes]: ... @distributed_trace def download_blob( self, offset: int = None, length: int = None, *, encoding: Optional[str] = None, **kwargs) -> StorageStreamDownloader: """Downloads a blob to the StorageStreamDownloader. The readall() method must be used to read all the content or readinto() must be used to download the blob into a stream. Using chunks() returns an iterator which allows the user to iterate over the content in chunks. :param int offset: Start of byte range to use for downloading a section of the blob. Must be set if length is provided. :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 that was sent. This is primarily valuable for detecting bitflips on the wire if using http instead of https, as https (the default), will already validate. Note that this MD5 hash is not stored with the blob. Also note that if enabled, the memory-efficient upload algorithm will not be used because computing the MD5 hash requires buffering entire blocks, and doing so defeats the purpose of the memory-efficient algorithm. :keyword lease: Required if the blob has an active lease. If specified, download_blob only succeeds if the blob's lease is active and matches this ID. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :keyword int max_concurrency: The number of parallel connections with which to download. :keyword str encoding: Encoding to decode the downloaded bytes. Default is None, i.e. no decoding. :keyword progress_hook: A callback to track the progress of a long running download. The signature is function(current: int, total: int) where current is the number of bytes transfered so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], None] :keyword 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 each call individually. :returns: A streaming object (StorageStreamDownloader) :rtype: ~azure.storage.blob.StorageStreamDownloader .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_hello_world.py :start-after: [START download_a_blob] :end-before: [END download_a_blob] :language: python :dedent: 12 :caption: Download a blob. """ options = self._download_blob_options( offset=offset, length=length, encoding=encoding, **kwargs) return StorageStreamDownloader(**options) def _quick_query_options(self, query_expression, **kwargs): # type: (str, **Any) -> Dict[str, Any] delimiter = '\n' input_format = kwargs.pop('blob_format', None) if input_format == QuickQueryDialect.DelimitedJson: input_format = DelimitedJsonDialect() if input_format == QuickQueryDialect.DelimitedText: input_format = DelimitedTextDialect() input_parquet_format = input_format == "ParquetDialect" if input_format and not input_parquet_format: try: delimiter = input_format.lineterminator except AttributeError: try: delimiter = input_format.delimiter except AttributeError: raise ValueError("The Type of blob_format can only be DelimitedTextDialect or " "DelimitedJsonDialect or ParquetDialect") output_format = kwargs.pop('output_format', None) if output_format == QuickQueryDialect.DelimitedJson: output_format = DelimitedJsonDialect() if output_format == QuickQueryDialect.DelimitedText: output_format = DelimitedTextDialect() if output_format: if output_format == "ParquetDialect": raise ValueError("ParquetDialect is invalid as an output format.") try: delimiter = output_format.lineterminator except AttributeError: try: delimiter = output_format.delimiter except AttributeError: pass else: output_format = input_format if not input_parquet_format else None query_request = QueryRequest( expression=query_expression, input_serialization=serialize_query_format(input_format), output_serialization=serialize_query_format(output_format) ) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo( encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm ) options = { 'query_request': query_request, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_info': cpk_info, 'snapshot': self.snapshot, 'timeout': kwargs.pop('timeout', None), 'cls': return_headers_and_deserialized, } options.update(kwargs) return options, delimiter @distributed_trace def query_blob(self, query_expression, **kwargs): # type: (str, **Any) -> BlobQueryReader """Enables users to select/project on blob/or blob snapshot data by providing simple query expressions. This operations returns a BlobQueryReader, users need to use readall() or readinto() to get query data. :param str query_expression: Required. a query statement. :keyword Callable[~azure.storage.blob.BlobQueryError] on_error: A function to be called on any processing errors returned by the service. :keyword blob_format: Optional. Defines the serialization of the data currently stored in the blob. The default is to treat the blob data as CSV data formatted in the default dialect. This can be overridden with a custom DelimitedTextDialect, or DelimitedJsonDialect or "ParquetDialect" (passed as a string or enum). These dialects can be passed through their respective classes, the QuickQueryDialect enum or as a string :paramtype blob_format: ~azure.storage.blob.DelimitedTextDialect or ~azure.storage.blob.DelimitedJsonDialect or ~azure.storage.blob.QuickQueryDialect or str :keyword output_format: Optional. Defines the output serialization for the data stream. By default the data will be returned as it is represented in the blob (Parquet formats default to DelimitedTextDialect). By providing an output format, the blob data will be reformatted according to that profile. This value can be a DelimitedTextDialect or a DelimitedJsonDialect or ArrowDialect. These dialects can be passed through their respective classes, the QuickQueryDialect enum or as a string :paramtype output_format: ~azure.storage.blob.DelimitedTextDialect or ~azure.storage.blob.DelimitedJsonDialect or list[~azure.storage.blob.ArrowDialect] or ~azure.storage.blob.QuickQueryDialect or str :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :keyword int timeout: The timeout parameter is expressed in seconds. :returns: A streaming object (BlobQueryReader) :rtype: ~azure.storage.blob.BlobQueryReader .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_query.py :start-after: [START query] :end-before: [END query] :language: python :dedent: 4 :caption: select/project on blob/or blob snapshot data by providing simple query expressions. """ errors = kwargs.pop("on_error", None) error_cls = kwargs.pop("error_cls", BlobQueryError) encoding = kwargs.pop("encoding", None) options, delimiter = self._quick_query_options(query_expression, **kwargs) try: headers, raw_response_body = self._client.blob.query(**options) except HttpResponseError as error: process_storage_error(error) return BlobQueryReader( name=self.blob_name, container=self.container_name, errors=errors, record_delimiter=delimiter, encoding=encoding, headers=headers, response=raw_response_body, error_cls=error_cls) @staticmethod def _generic_delete_blob_options(delete_snapshots=None, **kwargs): # type: (str, **Any) -> Dict[str, Any] access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) if delete_snapshots: delete_snapshots = DeleteSnapshotsOptionType(delete_snapshots) options = { 'timeout': kwargs.pop('timeout', None), 'snapshot': kwargs.pop('snapshot', None), # this is added for delete_blobs 'delete_snapshots': delete_snapshots or None, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions} options.update(kwargs) return options def _delete_blob_options(self, delete_snapshots=None, **kwargs): # type: (str, **Any) -> Dict[str, Any] if self.snapshot and delete_snapshots: raise ValueError("The delete_snapshots option cannot be used with a specific snapshot.") options = self._generic_delete_blob_options(delete_snapshots, **kwargs) options['snapshot'] = self.snapshot options['version_id'] = kwargs.pop('version_id', None) options['blob_delete_type'] = kwargs.pop('blob_delete_type', None) return options @distributed_trace def delete_blob(self, delete_snapshots=None, **kwargs): # type: (str, **Any) -> None """Marks the specified blob for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the delete_blob() operation. If a delete retention policy is enabled for the service, then this operation soft deletes the blob and retains the blob for a specified number of days. After the specified number of days, the blob's data is removed from the service during garbage collection. Soft deleted blob is accessible through :func:`~ContainerClient.list_blobs()` specifying `include=['deleted']` option. Soft-deleted blob can be restored using :func:`undelete` operation. :param str delete_snapshots: Required if the blob has associated snapshots. Values include: - "only": Deletes only the blobs snapshots. - "include": Deletes the blob along with all snapshots. :keyword str version_id: The version id parameter is an opaque DateTime 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: Required if the blob has an active lease. If specified, delete_blob only succeeds if the blob's lease is active and matches this ID. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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: The timeout parameter is expressed in seconds. :rtype: None .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_hello_world.py :start-after: [START delete_blob] :end-before: [END delete_blob] :language: python :dedent: 12 :caption: Delete a blob. """ options = self._delete_blob_options(delete_snapshots=delete_snapshots, **kwargs) try: self._client.blob.delete(**options) except HttpResponseError as error: process_storage_error(error) @distributed_trace def undelete_blob(self, **kwargs): # type: (**Any) -> None """Restores soft-deleted blobs or snapshots. Operation will only be successful if used within the specified number of days set in the delete retention policy. :keyword int timeout: The timeout parameter is expressed in seconds. :rtype: None .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START undelete_blob] :end-before: [END undelete_blob] :language: python :dedent: 8 :caption: Undeleting a blob. """ try: self._client.blob.undelete(timeout=kwargs.pop('timeout', None), **kwargs) except HttpResponseError as error: process_storage_error(error) @distributed_trace() def exists(self, **kwargs): # type: (**Any) -> bool """ Returns True if a blob exists with the defined parameters, and returns False otherwise. :kwarg str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to check if it exists. :kwarg int timeout: The timeout parameter is expressed in seconds. :returns: boolean """ try: self._client.blob.get_properties( snapshot=self.snapshot, **kwargs) return True # Encrypted with CPK except ResourceExistsError: return True except HttpResponseError as error: try: process_storage_error(error) except ResourceNotFoundError: return False @distributed_trace def get_blob_properties(self, **kwargs): # type: (**Any) -> BlobProperties """Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword str version_id: The version id parameter is an opaque DateTime 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: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :keyword int timeout: The timeout parameter is expressed in seconds. :returns: BlobProperties :rtype: ~azure.storage.blob.BlobProperties .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START get_blob_properties] :end-before: [END get_blob_properties] :language: python :dedent: 8 :caption: Getting the properties for a blob. """ # TODO: extract this out as _get_blob_properties_options access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) try: cls_method = kwargs.pop('cls', None) if cls_method: kwargs['cls'] = partial(deserialize_pipeline_response_into_cls, cls_method) blob_props = self._client.blob.get_properties( timeout=kwargs.pop('timeout', None), version_id=kwargs.pop('version_id', None), snapshot=self.snapshot, lease_access_conditions=access_conditions, modified_access_conditions=mod_conditions, cls=kwargs.pop('cls', None) or deserialize_blob_properties, cpk_info=cpk_info, **kwargs) except HttpResponseError as error: process_storage_error(error) blob_props.name = self.blob_name if isinstance(blob_props, BlobProperties): blob_props.container = self.container_name blob_props.snapshot = self.snapshot return blob_props # type: ignore def _set_http_headers_options(self, content_settings=None, **kwargs): # type: (Optional[ContentSettings], **Any) -> Dict[str, Any] access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) blob_headers = None if content_settings: blob_headers = BlobHTTPHeaders( blob_cache_control=content_settings.cache_control, blob_content_type=content_settings.content_type, blob_content_md5=content_settings.content_md5, blob_content_encoding=content_settings.content_encoding, blob_content_language=content_settings.content_language, blob_content_disposition=content_settings.content_disposition ) options = { 'timeout': kwargs.pop('timeout', None), 'blob_http_headers': blob_headers, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cls': return_response_headers} options.update(kwargs) return options @distributed_trace def set_http_headers(self, content_settings=None, **kwargs): # type: (Optional[ContentSettings], **Any) -> None """Sets system properties on the blob. If one property is set for the content_settings, all properties will be overridden. :param ~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. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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: The timeout parameter is expressed in seconds. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ options = self._set_http_headers_options(content_settings=content_settings, **kwargs) try: return self._client.blob.set_http_headers(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _set_blob_metadata_options(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Any] headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) options = { 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'cls': return_response_headers, 'headers': headers} options.update(kwargs) return options @distributed_trace def set_blob_metadata(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Union[str, datetime]] """Sets user-defined metadata for the blob as one or more name-value pairs. :param metadata: Dict containing name and value pairs. Each call to this operation replaces all existing metadata attached to the blob. To remove all metadata from the blob, call this operation with no metadata headers. :type metadata: dict(str, str) :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.0 :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Blob-updated property dict (Etag and last modified) """ options = self._set_blob_metadata_options(metadata=metadata, **kwargs) try: return self._client.blob.set_metadata(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) @distributed_trace def set_immutability_policy(self, immutability_policy, **kwargs): # type: (ImmutabilityPolicy, **Any) -> Dict[str, str] """The Set Immutability Policy operation sets the immutability policy on the blob. .. versionadded:: 12.10.0 This operation was introduced in API version '2020-10-02'. :param ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode return self._client.blob.set_immutability_policy(cls=return_response_headers, **kwargs) @distributed_trace def delete_immutability_policy(self, **kwargs): # type: (**Any) -> None """The Delete Immutability Policy operation deletes the immutability policy on the blob. .. versionadded:: 12.10.0 This operation was introduced in API version '2020-10-02'. :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ self._client.blob.delete_immutability_policy(**kwargs) @distributed_trace def set_legal_hold(self, legal_hold, **kwargs): # type: (bool, **Any) -> Dict[str, Union[str, datetime, bool]] """The Set Legal Hold operation sets a legal hold on the blob. .. versionadded:: 12.10.0 This operation was introduced in API version '2020-10-02'. :param bool legal_hold: Specified if a legal hold should be set on the blob. :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] """ return self._client.blob.set_legal_hold(legal_hold, cls=return_response_headers, **kwargs) def _create_page_blob_options( # type: ignore self, size, # type: int content_settings=None, # type: Optional[ContentSettings] metadata=None, # type: Optional[Dict[str, str]] premium_page_blob_tier=None, # type: Optional[Union[str, PremiumPageBlobTier]] **kwargs ): # type: (...) -> Dict[str, Any] if self.require_encryption or (self.key_encryption_key is not None): raise ValueError(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION) headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) blob_headers = None if content_settings: blob_headers = BlobHTTPHeaders( blob_cache_control=content_settings.cache_control, blob_content_type=content_settings.content_type, blob_content_md5=content_settings.content_md5, blob_content_encoding=content_settings.content_encoding, blob_content_language=content_settings.content_language, blob_content_disposition=content_settings.content_disposition ) sequence_number = kwargs.pop('sequence_number', None) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) immutability_policy = kwargs.pop('immutability_policy', None) if immutability_policy: kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode tier = None if premium_page_blob_tier: try: tier = premium_page_blob_tier.value # type: ignore except AttributeError: tier = premium_page_blob_tier # type: ignore blob_tags_string = serialize_blob_tags_header(kwargs.pop('tags', None)) options = { 'content_length': 0, 'blob_content_length': size, 'blob_sequence_number': sequence_number, 'blob_http_headers': blob_headers, 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'blob_tags_string': blob_tags_string, 'cls': return_response_headers, "tier": tier, 'headers': headers} options.update(kwargs) return options @distributed_trace def create_page_blob( # type: ignore self, size, # type: int content_settings=None, # type: Optional[ContentSettings] metadata=None, # type: Optional[Dict[str, str]] premium_page_blob_tier=None, # type: Optional[Union[str, PremiumPageBlobTier]] **kwargs ): # type: (...) -> Dict[str, Union[str, datetime]] """Creates a new Page Blob of the specified size. :param int size: This specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. :param ~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. :param metadata: Name-value pairs associated with the blob as metadata. :type metadata: dict(str, str) :param ~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 premium storage accounts. :keyword tags: Name-value pairs associated with the blob as tag. Tags are case-sensitive. 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 (_) .. versionadded:: 12.4.0 :paramtype tags: dict(str, str) :keyword int sequence_number: Only for Page blobs. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1.The default value is 0. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword bool legal_hold: Specified if a legal hold should be set on the blob. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.0 :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ options = self._create_page_blob_options( size, content_settings=content_settings, metadata=metadata, premium_page_blob_tier=premium_page_blob_tier, **kwargs) try: return self._client.page_blob.create(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _create_append_blob_options(self, content_settings=None, metadata=None, **kwargs): # type: (Optional[ContentSettings], Optional[Dict[str, str]], **Any) -> Dict[str, Any] if self.require_encryption or (self.key_encryption_key is not None): raise ValueError(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION) headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) blob_headers = None if content_settings: blob_headers = BlobHTTPHeaders( blob_cache_control=content_settings.cache_control, blob_content_type=content_settings.content_type, blob_content_md5=content_settings.content_md5, blob_content_encoding=content_settings.content_encoding, blob_content_language=content_settings.content_language, blob_content_disposition=content_settings.content_disposition ) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) immutability_policy = kwargs.pop('immutability_policy', None) if immutability_policy: kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode blob_tags_string = serialize_blob_tags_header(kwargs.pop('tags', None)) options = { 'content_length': 0, 'blob_http_headers': blob_headers, 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'blob_tags_string': blob_tags_string, 'cls': return_response_headers, 'headers': headers} options.update(kwargs) return options @distributed_trace def create_append_blob(self, content_settings=None, metadata=None, **kwargs): # type: (Optional[ContentSettings], Optional[Dict[str, str]], **Any) -> Dict[str, Union[str, datetime]] """Creates a new Append Blob. :param ~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. :param metadata: Name-value pairs associated with the blob as metadata. :type metadata: dict(str, str) :keyword tags: Name-value pairs associated with the blob as tag. Tags are case-sensitive. 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 (_) .. versionadded:: 12.4.0 :paramtype tags: dict(str, str) :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword bool legal_hold: Specified if a legal hold should be set on the blob. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.0 :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ options = self._create_append_blob_options( content_settings=content_settings, metadata=metadata, **kwargs) try: return self._client.append_blob.create(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _create_snapshot_options(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Any] headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) options = { 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'cls': return_response_headers, 'headers': headers} options.update(kwargs) return options @distributed_trace def create_snapshot(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Union[str, datetime]] """Creates a snapshot of the blob. A snapshot is a read-only version of a blob that's taken at a point in time. It can be read, copied, or deleted, but not modified. Snapshots provide a way to back up a blob as it appears at a moment in time. A snapshot of a blob has the same name as the base blob from which the snapshot is taken, with a DateTime value appended to indicate the time at which the snapshot was taken. :param metadata: Name-value pairs associated with the blob as metadata. :type metadata: dict(str, str) :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword str if_tags_match_condition: Specify a SQL where clause on blob tags to operate only on destination blob with a matching value. .. versionadded:: 12.4.0 :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.0 :keyword int timeout: The timeout parameter is expressed in seconds. :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START create_blob_snapshot] :end-before: [END create_blob_snapshot] :language: python :dedent: 8 :caption: Create a snapshot of the blob. """ options = self._create_snapshot_options(metadata=metadata, **kwargs) try: return self._client.blob.create_snapshot(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _start_copy_from_url_options(self, source_url, metadata=None, incremental_copy=False, **kwargs): # type: (str, Optional[Dict[str, str]], bool, **Any) -> Dict[str, Any] headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) if 'source_lease' in kwargs: source_lease = kwargs.pop('source_lease') try: headers['x-ms-source-lease-id'] = source_lease.id except AttributeError: headers['x-ms-source-lease-id'] = source_lease tier = kwargs.pop('premium_page_blob_tier', None) or kwargs.pop('standard_blob_tier', None) tags = kwargs.pop('tags', None) # Options only available for sync copy requires_sync = kwargs.pop('requires_sync', None) encryption_scope_str = kwargs.pop('encryption_scope', None) source_authorization = kwargs.pop('source_authorization', None) # If tags is a str, interpret that as copy_source_tags copy_source_tags = isinstance(tags, str) if incremental_copy: if source_authorization: raise ValueError("Source authorization tokens are not applicable for incremental copying.") if copy_source_tags: raise ValueError("Copying source tags is not applicable for incremental copying.") # TODO: refactor start_copy_from_url api in _blob_client.py. Call _generated/_blob_operations.py copy_from_url # when requires_sync=True is set. # Currently both sync copy and async copy are calling _generated/_blob_operations.py start_copy_from_url. # As sync copy diverges more from async copy, more problem will surface. if requires_sync is True: headers['x-ms-requires-sync'] = str(requires_sync) if encryption_scope_str: headers['x-ms-encryption-scope'] = encryption_scope_str if source_authorization: headers['x-ms-copy-source-authorization'] = source_authorization if copy_source_tags: headers['x-ms-copy-source-tag-option'] = tags else: if encryption_scope_str: raise ValueError( "Encryption_scope is only supported for sync copy, please specify requires_sync=True") if source_authorization: raise ValueError( "Source authorization tokens are only supported for sync copy, please specify requires_sync=True") if copy_source_tags: raise ValueError( "Copying source tags is only supported for sync copy, please specify requires_sync=True") timeout = kwargs.pop('timeout', None) dest_mod_conditions = get_modify_conditions(kwargs) blob_tags_string = serialize_blob_tags_header(tags) if not copy_source_tags else None immutability_policy = kwargs.pop('immutability_policy', None) if immutability_policy: kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode options = { 'copy_source': source_url, 'seal_blob': kwargs.pop('seal_destination_blob', None), 'timeout': timeout, 'modified_access_conditions': dest_mod_conditions, 'blob_tags_string': blob_tags_string, 'headers': headers, 'cls': return_response_headers, } if not incremental_copy: source_mod_conditions = get_source_conditions(kwargs) dest_access_conditions = get_access_conditions(kwargs.pop('destination_lease', None)) options['source_modified_access_conditions'] = source_mod_conditions options['lease_access_conditions'] = dest_access_conditions options['tier'] = tier.value if tier else None options.update(kwargs) return options @distributed_trace def start_copy_from_url(self, source_url, metadata=None, incremental_copy=False, **kwargs): # type: (str, Optional[Dict[str, str]], bool, **Any) -> Dict[str, Union[str, datetime]] """Copies a blob from the given URL. This operation returns a dictionary containing `copy_status` and `copy_id`, which can be used to check the status of or abort the copy operation. `copy_status` will be 'success' if the copy completed synchronously or 'pending' if the copy has been started asynchronously. For asynchronous copies, the status can be checked by polling the :func:`get_blob_properties` method and checking the copy status. Set `requires_sync` to True to force the copy to be synchronous. The Blob service copies blobs on a best-effort basis. The source blob for a copy operation may be a block blob, an append blob, or a page blob. If the destination blob already exists, it must be of the same blob type as the source blob. Any existing destination blob will be overwritten. The destination blob cannot be modified while a copy operation is in progress. When copying from a page blob, the Blob service creates a destination page blob of the source blob's length, initially containing all zeroes. Then the source page ranges are enumerated, and non-empty ranges are copied. For a block blob or an append blob, the Blob service creates a committed blob of zero length before returning from this operation. When copying from a block blob, all committed blocks and their block IDs are copied. Uncommitted blocks are not copied. At the end of the copy operation, the destination blob will have the same committed block count as the source. When copying from an append blob, all committed blocks are copied. At the end of the copy operation, the destination blob will have the same committed block count as the source. :param str source_url: A URL of up to 2 KB in length that specifies a file or blob. The value should be URL-encoded as it would appear in a request URI. If the source is in another account, the source must either be public or must be authenticated via a shared access signature. If the source is public, no authentication is required. Examples: https://myaccount.blob.core.windows.net/mycontainer/myblob https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken :param metadata: Name-value pairs associated with the blob as metadata. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. :type metadata: dict(str, str) :param bool incremental_copy: Copies the snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. Defaults to False. :keyword tags: Name-value pairs associated with the blob as tag. Tags are case-sensitive. 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 (_). 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`. .. versionadded:: 12.4.0 :paramtype tags: dict(str, str) or Literal["COPY"] :keyword ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword bool legal_hold: Specified if a legal hold should be set on the blob. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword ~datetime.datetime source_if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the source blob has been modified since the specified date/time. :keyword ~datetime.datetime source_if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the source blob has not been modified since the specified date/time. :keyword str source_etag: The source ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the destination blob has been modified since the specified date/time. If the destination blob has not been modified, the Blob service returns status code 412 (Precondition Failed). :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the destination blob has not been modified since the specified date/time. If the destination blob has been modified, the Blob service returns status code 412 (Precondition Failed). :keyword str etag: The destination ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The destination match condition to use upon the etag. :keyword destination_lease: The lease ID specified for this header must match the lease ID of the destination blob. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). :paramtype destination_lease: ~azure.storage.blob.BlobLeaseClient or str :keyword source_lease: Specify this to perform the Copy Blob operation only if the lease ID given matches the active lease ID of the source blob. :paramtype source_lease: ~azure.storage.blob.BlobLeaseClient or str :keyword int timeout: The timeout parameter is expressed in seconds. :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 premium storage accounts. :keyword ~azure.storage.blob.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. :keyword ~azure.storage.blob.RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob :keyword bool seal_destination_blob: Seal the destination append blob. This operation is only for append blob. .. versionadded:: 12.4.0 :keyword bool requires_sync: Enforces that the service will not return a response until the copy is complete. :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. This option is only available when `incremental_copy` is set to False and `requires_sync` is set to True. .. versionadded:: 12.9.0 :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the sync copied blob. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.10.0 :returns: A dictionary of copy properties (etag, last_modified, copy_id, copy_status). :rtype: dict[str, Union[str, ~datetime.datetime]] .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START copy_blob_from_url] :end-before: [END copy_blob_from_url] :language: python :dedent: 12 :caption: Copy a blob from a URL. """ options = self._start_copy_from_url_options( source_url=self._encode_source_url(source_url), metadata=metadata, incremental_copy=incremental_copy, **kwargs) try: if incremental_copy: return self._client.page_blob.copy_incremental(**options) return self._client.blob.start_copy_from_url(**options) except HttpResponseError as error: process_storage_error(error) def _abort_copy_options(self, copy_id, **kwargs): # type: (Union[str, Dict[str, Any], BlobProperties], **Any) -> Dict[str, Any] access_conditions = get_access_conditions(kwargs.pop('lease', None)) try: copy_id = copy_id.copy.id except AttributeError: try: copy_id = copy_id['copy_id'] except TypeError: pass options = { 'copy_id': copy_id, 'lease_access_conditions': access_conditions, 'timeout': kwargs.pop('timeout', None)} options.update(kwargs) return options @distributed_trace def abort_copy(self, copy_id, **kwargs): # type: (Union[str, Dict[str, Any], BlobProperties], **Any) -> None """Abort an ongoing copy operation. This will leave a destination blob with zero length and full metadata. This will raise an error if the copy operation has already ended. :param copy_id: The copy operation to abort. This can be either an ID string, or an instance of BlobProperties. :type copy_id: str or ~azure.storage.blob.BlobProperties :rtype: None .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START abort_copy_blob_from_url] :end-before: [END abort_copy_blob_from_url] :language: python :dedent: 12 :caption: Abort copying a blob from URL. """ options = self._abort_copy_options(copy_id, **kwargs) try: self._client.blob.abort_copy_from_url(**options) except HttpResponseError as error: process_storage_error(error) @distributed_trace def acquire_lease(self, lease_duration=-1, lease_id=None, **kwargs): # type: (int, Optional[str], **Any) -> BlobLeaseClient """Requests a new lease. If the blob does not have an active lease, the Blob Service creates a lease on the blob and returns a new lease. :param int lease_duration: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. Default is -1 (infinite lease). :param str lease_id: Proposed lease ID, in a GUID string format. The Blob Service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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: The timeout parameter is expressed in seconds. :returns: A BlobLeaseClient object. :rtype: ~azure.storage.blob.BlobLeaseClient .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START acquire_lease_on_blob] :end-before: [END acquire_lease_on_blob] :language: python :dedent: 8 :caption: Acquiring a lease on a blob. """ lease = BlobLeaseClient(self, lease_id=lease_id) # type: ignore lease.acquire(lease_duration=lease_duration, **kwargs) return lease @distributed_trace def set_standard_blob_tier(self, standard_blob_tier, **kwargs): # type: (Union[str, StandardBlobTier], Any) -> None """This operation sets the tier on a block blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. :param standard_blob_tier: Indicates the tier to be set on the blob. Options include 'Hot', 'Cool', 'Archive'. The hot tier is optimized for storing data that is accessed frequently. The cool storage tier is optimized for storing data that is infrequently accessed and stored for at least a month. The archive tier is optimized for storing data that is rarely accessed and stored for at least six months with flexible latency requirements. :type standard_blob_tier: str or ~azure.storage.blob.StandardBlobTier :keyword ~azure.storage.blob.RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob :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 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: The timeout parameter is expressed in seconds. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :rtype: None """ access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) if standard_blob_tier is None: raise ValueError("A StandardBlobTier must be specified") if self.snapshot and kwargs.get('version_id'): raise ValueError("Snapshot and version_id cannot be set at the same time") try: self._client.blob.set_tier( tier=standard_blob_tier, snapshot=self.snapshot, timeout=kwargs.pop('timeout', None), modified_access_conditions=mod_conditions, lease_access_conditions=access_conditions, **kwargs) except HttpResponseError as error: process_storage_error(error) def _stage_block_options( self, block_id, # type: str data, # type: Union[Iterable[AnyStr], IO[AnyStr]] length=None, # type: Optional[int] **kwargs ): # type: (...) -> Dict[str, Any] if self.require_encryption or (self.key_encryption_key is not None): raise ValueError(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION) block_id = encode_base64(str(block_id)) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - azure/multiapi/storagev2/blob/v2022_11_02/_blob_client.py [739:2426]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - options = self._upload_blob_options( data, blob_type=blob_type, length=length, metadata=metadata, **kwargs) if blob_type == BlobType.BlockBlob: return upload_block_blob(**options) if blob_type == BlobType.PageBlob: return upload_page_blob(**options) return upload_append_blob(**options) def _download_blob_options(self, offset=None, length=None, encoding=None, **kwargs): # type: (Optional[int], Optional[int], Optional[str], **Any) -> Dict[str, Any] if self.require_encryption and not self.key_encryption_key: raise ValueError("Encryption required but no key was provided.") if length is not None and offset is None: raise ValueError("Offset value must not be None if length is set.") if length is not None: length = offset + length - 1 # Service actually uses an end-range inclusive index validate_content = kwargs.pop('validate_content', False) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) options = { 'clients': self._client, 'config': self._config, 'start_range': offset, 'end_range': length, 'version_id': kwargs.pop('version_id', None), 'validate_content': validate_content, 'encryption_options': { 'required': self.require_encryption, 'key': self.key_encryption_key, 'resolver': self.key_resolver_function}, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_info': cpk_info, 'download_cls': kwargs.pop('cls', None) or deserialize_blob_stream, 'max_concurrency':kwargs.pop('max_concurrency', 1), 'encoding': encoding, 'timeout': kwargs.pop('timeout', None), 'name': self.blob_name, 'container': self.container_name} options.update(kwargs) return options @overload def download_blob( self, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]: ... @overload def download_blob( self, offset: int = None, length: int = None, *, encoding: None = None, **kwargs) -> StorageStreamDownloader[bytes]: ... @distributed_trace def download_blob( self, offset: int = None, length: int = None, *, encoding: Optional[str] = None, **kwargs) -> StorageStreamDownloader: """Downloads a blob to the StorageStreamDownloader. The readall() method must be used to read all the content or readinto() must be used to download the blob into a stream. Using chunks() returns an iterator which allows the user to iterate over the content in chunks. :param int offset: Start of byte range to use for downloading a section of the blob. Must be set if length is provided. :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 that was sent. This is primarily valuable for detecting bitflips on the wire if using http instead of https, as https (the default), will already validate. Note that this MD5 hash is not stored with the blob. Also note that if enabled, the memory-efficient upload algorithm will not be used because computing the MD5 hash requires buffering entire blocks, and doing so defeats the purpose of the memory-efficient algorithm. :keyword lease: Required if the blob has an active lease. If specified, download_blob only succeeds if the blob's lease is active and matches this ID. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :keyword int max_concurrency: The number of parallel connections with which to download. :keyword str encoding: Encoding to decode the downloaded bytes. Default is None, i.e. no decoding. :keyword progress_hook: A callback to track the progress of a long running download. The signature is function(current: int, total: int) where current is the number of bytes transfered so far, and total is the total size of the download. :paramtype progress_hook: Callable[[int, int], None] :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 `_. 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. :returns: A streaming object (StorageStreamDownloader) :rtype: ~azure.storage.blob.StorageStreamDownloader .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_hello_world.py :start-after: [START download_a_blob] :end-before: [END download_a_blob] :language: python :dedent: 12 :caption: Download a blob. """ options = self._download_blob_options( offset=offset, length=length, encoding=encoding, **kwargs) return StorageStreamDownloader(**options) def _quick_query_options(self, query_expression, **kwargs): # type: (str, **Any) -> Dict[str, Any] delimiter = '\n' input_format = kwargs.pop('blob_format', None) if input_format == QuickQueryDialect.DelimitedJson: input_format = DelimitedJsonDialect() if input_format == QuickQueryDialect.DelimitedText: input_format = DelimitedTextDialect() input_parquet_format = input_format == "ParquetDialect" if input_format and not input_parquet_format: try: delimiter = input_format.lineterminator except AttributeError: try: delimiter = input_format.delimiter except AttributeError: raise ValueError("The Type of blob_format can only be DelimitedTextDialect or " "DelimitedJsonDialect or ParquetDialect") output_format = kwargs.pop('output_format', None) if output_format == QuickQueryDialect.DelimitedJson: output_format = DelimitedJsonDialect() if output_format == QuickQueryDialect.DelimitedText: output_format = DelimitedTextDialect() if output_format: if output_format == "ParquetDialect": raise ValueError("ParquetDialect is invalid as an output format.") try: delimiter = output_format.lineterminator except AttributeError: try: delimiter = output_format.delimiter except AttributeError: pass else: output_format = input_format if not input_parquet_format else None query_request = QueryRequest( expression=query_expression, input_serialization=serialize_query_format(input_format), output_serialization=serialize_query_format(output_format) ) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo( encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm ) options = { 'query_request': query_request, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_info': cpk_info, 'snapshot': self.snapshot, 'timeout': kwargs.pop('timeout', None), 'cls': return_headers_and_deserialized, } options.update(kwargs) return options, delimiter @distributed_trace def query_blob(self, query_expression, **kwargs): # type: (str, **Any) -> BlobQueryReader """Enables users to select/project on blob/or blob snapshot data by providing simple query expressions. This operations returns a BlobQueryReader, users need to use readall() or readinto() to get query data. :param str query_expression: Required. a query statement. :keyword Callable[~azure.storage.blob.BlobQueryError] on_error: A function to be called on any processing errors returned by the service. :keyword blob_format: Optional. Defines the serialization of the data currently stored in the blob. The default is to treat the blob data as CSV data formatted in the default dialect. This can be overridden with a custom DelimitedTextDialect, or DelimitedJsonDialect or "ParquetDialect" (passed as a string or enum). These dialects can be passed through their respective classes, the QuickQueryDialect enum or as a string :paramtype blob_format: ~azure.storage.blob.DelimitedTextDialect or ~azure.storage.blob.DelimitedJsonDialect or ~azure.storage.blob.QuickQueryDialect or str :keyword output_format: Optional. Defines the output serialization for the data stream. By default the data will be returned as it is represented in the blob (Parquet formats default to DelimitedTextDialect). By providing an output format, the blob data will be reformatted according to that profile. This value can be a DelimitedTextDialect or a DelimitedJsonDialect or ArrowDialect. These dialects can be passed through their respective classes, the QuickQueryDialect enum or as a string :paramtype output_format: ~azure.storage.blob.DelimitedTextDialect or ~azure.storage.blob.DelimitedJsonDialect or list[~azure.storage.blob.ArrowDialect] or ~azure.storage.blob.QuickQueryDialect or str :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :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 `_. :returns: A streaming object (BlobQueryReader) :rtype: ~azure.storage.blob.BlobQueryReader .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_query.py :start-after: [START query] :end-before: [END query] :language: python :dedent: 4 :caption: select/project on blob/or blob snapshot data by providing simple query expressions. """ errors = kwargs.pop("on_error", None) error_cls = kwargs.pop("error_cls", BlobQueryError) encoding = kwargs.pop("encoding", None) options, delimiter = self._quick_query_options(query_expression, **kwargs) try: headers, raw_response_body = self._client.blob.query(**options) except HttpResponseError as error: process_storage_error(error) return BlobQueryReader( name=self.blob_name, container=self.container_name, errors=errors, record_delimiter=delimiter, encoding=encoding, headers=headers, response=raw_response_body, error_cls=error_cls) @staticmethod def _generic_delete_blob_options(delete_snapshots=None, **kwargs): # type: (str, **Any) -> Dict[str, Any] access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) if delete_snapshots: delete_snapshots = DeleteSnapshotsOptionType(delete_snapshots) options = { 'timeout': kwargs.pop('timeout', None), 'snapshot': kwargs.pop('snapshot', None), # this is added for delete_blobs 'delete_snapshots': delete_snapshots or None, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions} options.update(kwargs) return options def _delete_blob_options(self, delete_snapshots=None, **kwargs): # type: (str, **Any) -> Dict[str, Any] if self.snapshot and delete_snapshots: raise ValueError("The delete_snapshots option cannot be used with a specific snapshot.") options = self._generic_delete_blob_options(delete_snapshots, **kwargs) options['snapshot'] = self.snapshot options['version_id'] = kwargs.pop('version_id', None) options['blob_delete_type'] = kwargs.pop('blob_delete_type', None) return options @distributed_trace def delete_blob(self, delete_snapshots=None, **kwargs): # type: (str, **Any) -> None """Marks the specified blob for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the delete_blob() operation. If a delete retention policy is enabled for the service, then this operation soft deletes the blob and retains the blob for a specified number of days. After the specified number of days, the blob's data is removed from the service during garbage collection. Soft deleted blob is accessible through :func:`~ContainerClient.list_blobs()` specifying `include=['deleted']` option. Soft-deleted blob can be restored using :func:`undelete` operation. :param str delete_snapshots: Required if the blob has associated snapshots. Values include: - "only": Deletes only the blobs snapshots. - "include": Deletes the blob along with all snapshots. :keyword str version_id: The version id parameter is an opaque DateTime 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: Required if the blob has an active lease. If specified, delete_blob only succeeds if the blob's lease is active and matches this ID. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 `_. :rtype: None .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_hello_world.py :start-after: [START delete_blob] :end-before: [END delete_blob] :language: python :dedent: 12 :caption: Delete a blob. """ options = self._delete_blob_options(delete_snapshots=delete_snapshots, **kwargs) try: self._client.blob.delete(**options) except HttpResponseError as error: process_storage_error(error) @distributed_trace def undelete_blob(self, **kwargs): # type: (**Any) -> None """Restores soft-deleted blobs or snapshots. Operation will only be successful if used within the specified number of days set in the delete retention policy. If blob versioning is enabled, the base blob cannot be restored using this method. Instead use :func:`start_copy_from_url` with the URL of the blob version you wish to promote to the current version. :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 `_. :rtype: None .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START undelete_blob] :end-before: [END undelete_blob] :language: python :dedent: 8 :caption: Undeleting a blob. """ try: self._client.blob.undelete(timeout=kwargs.pop('timeout', None), **kwargs) except HttpResponseError as error: process_storage_error(error) @distributed_trace() def exists(self, **kwargs): # type: (**Any) -> bool """ Returns True if a blob exists with the defined parameters, and returns False otherwise. :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to check if it exists. :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 `_. :returns: boolean """ try: self._client.blob.get_properties( snapshot=self.snapshot, **kwargs) return True # Encrypted with CPK except ResourceExistsError: return True except HttpResponseError as error: try: process_storage_error(error) except ResourceNotFoundError: return False @distributed_trace def get_blob_properties(self, **kwargs): # type: (**Any) -> BlobProperties """Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword str version_id: The version id parameter is an opaque DateTime 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: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :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 `_. :returns: BlobProperties :rtype: ~azure.storage.blob.BlobProperties .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START get_blob_properties] :end-before: [END get_blob_properties] :language: python :dedent: 8 :caption: Getting the properties for a blob. """ # TODO: extract this out as _get_blob_properties_options access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) try: cls_method = kwargs.pop('cls', None) if cls_method: kwargs['cls'] = partial(deserialize_pipeline_response_into_cls, cls_method) blob_props = self._client.blob.get_properties( timeout=kwargs.pop('timeout', None), version_id=kwargs.pop('version_id', None), snapshot=self.snapshot, lease_access_conditions=access_conditions, modified_access_conditions=mod_conditions, cls=kwargs.pop('cls', None) or deserialize_blob_properties, cpk_info=cpk_info, **kwargs) except HttpResponseError as error: process_storage_error(error) blob_props.name = self.blob_name if isinstance(blob_props, BlobProperties): blob_props.container = self.container_name blob_props.snapshot = self.snapshot return blob_props # type: ignore def _set_http_headers_options(self, content_settings=None, **kwargs): # type: (Optional[ContentSettings], **Any) -> Dict[str, Any] access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) blob_headers = None if content_settings: blob_headers = BlobHTTPHeaders( blob_cache_control=content_settings.cache_control, blob_content_type=content_settings.content_type, blob_content_md5=content_settings.content_md5, blob_content_encoding=content_settings.content_encoding, blob_content_language=content_settings.content_language, blob_content_disposition=content_settings.content_disposition ) options = { 'timeout': kwargs.pop('timeout', None), 'blob_http_headers': blob_headers, 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cls': return_response_headers} options.update(kwargs) return options @distributed_trace def set_http_headers(self, content_settings=None, **kwargs): # type: (Optional[ContentSettings], **Any) -> None """Sets system properties on the blob. If one property is set for the content_settings, all properties will be overridden. :param ~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. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 `_. :returns: Blob-updated property dict (Etag and last modified) :rtype: Dict[str, Any] """ options = self._set_http_headers_options(content_settings=content_settings, **kwargs) try: return self._client.blob.set_http_headers(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _set_blob_metadata_options(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Any] headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) options = { 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'cls': return_response_headers, 'headers': headers} options.update(kwargs) return options @distributed_trace def set_blob_metadata(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Union[str, datetime]] """Sets user-defined metadata for the blob as one or more name-value pairs. :param metadata: Dict containing name and value pairs. Each call to this operation replaces all existing metadata attached to the blob. To remove all metadata from the blob, call this operation with no metadata headers. :type metadata: dict(str, str) :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.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 `_. :returns: Blob-updated property dict (Etag and last modified) """ options = self._set_blob_metadata_options(metadata=metadata, **kwargs) try: return self._client.blob.set_metadata(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) @distributed_trace def set_immutability_policy(self, immutability_policy, **kwargs): # type: (ImmutabilityPolicy, **Any) -> Dict[str, str] """The Set Immutability Policy operation sets the immutability policy on the blob. .. versionadded:: 12.10.0 This operation was introduced in API version '2020-10-02'. :param ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :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 `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode return self._client.blob.set_immutability_policy(cls=return_response_headers, **kwargs) @distributed_trace def delete_immutability_policy(self, **kwargs): # type: (**Any) -> None """The Delete Immutability Policy operation deletes the immutability policy on the blob. .. versionadded:: 12.10.0 This operation was introduced in API version '2020-10-02'. :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 `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, str] """ self._client.blob.delete_immutability_policy(**kwargs) @distributed_trace def set_legal_hold(self, legal_hold, **kwargs): # type: (bool, **Any) -> Dict[str, Union[str, datetime, bool]] """The Set Legal Hold operation sets a legal hold on the blob. .. versionadded:: 12.10.0 This operation was introduced in API version '2020-10-02'. :param bool legal_hold: Specified if a legal hold should be set on the blob. :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 `_. :returns: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] """ return self._client.blob.set_legal_hold(legal_hold, cls=return_response_headers, **kwargs) def _create_page_blob_options( # type: ignore self, size, # type: int content_settings=None, # type: Optional[ContentSettings] metadata=None, # type: Optional[Dict[str, str]] premium_page_blob_tier=None, # type: Optional[Union[str, PremiumPageBlobTier]] **kwargs ): # type: (...) -> Dict[str, Any] if self.require_encryption or (self.key_encryption_key is not None): raise ValueError(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION) headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) blob_headers = None if content_settings: blob_headers = BlobHTTPHeaders( blob_cache_control=content_settings.cache_control, blob_content_type=content_settings.content_type, blob_content_md5=content_settings.content_md5, blob_content_encoding=content_settings.content_encoding, blob_content_language=content_settings.content_language, blob_content_disposition=content_settings.content_disposition ) sequence_number = kwargs.pop('sequence_number', None) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) immutability_policy = kwargs.pop('immutability_policy', None) if immutability_policy: kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode tier = None if premium_page_blob_tier: try: tier = premium_page_blob_tier.value # type: ignore except AttributeError: tier = premium_page_blob_tier # type: ignore blob_tags_string = serialize_blob_tags_header(kwargs.pop('tags', None)) options = { 'content_length': 0, 'blob_content_length': size, 'blob_sequence_number': sequence_number, 'blob_http_headers': blob_headers, 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'blob_tags_string': blob_tags_string, 'cls': return_response_headers, "tier": tier, 'headers': headers} options.update(kwargs) return options @distributed_trace def create_page_blob( # type: ignore self, size, # type: int content_settings=None, # type: Optional[ContentSettings] metadata=None, # type: Optional[Dict[str, str]] premium_page_blob_tier=None, # type: Optional[Union[str, PremiumPageBlobTier]] **kwargs ): # type: (...) -> Dict[str, Union[str, datetime]] """Creates a new Page Blob of the specified size. :param int size: This specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. :param ~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. :param metadata: Name-value pairs associated with the blob as metadata. :type metadata: dict(str, str) :param ~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 premium storage accounts. :keyword tags: Name-value pairs associated with the blob as tag. Tags are case-sensitive. 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 (_) .. versionadded:: 12.4.0 :paramtype tags: dict(str, str) :keyword int sequence_number: Only for Page blobs. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1.The default value is 0. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword bool legal_hold: Specified if a legal hold should be set on the blob. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.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 `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ options = self._create_page_blob_options( size, content_settings=content_settings, metadata=metadata, premium_page_blob_tier=premium_page_blob_tier, **kwargs) try: return self._client.page_blob.create(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _create_append_blob_options(self, content_settings=None, metadata=None, **kwargs): # type: (Optional[ContentSettings], Optional[Dict[str, str]], **Any) -> Dict[str, Any] if self.require_encryption or (self.key_encryption_key is not None): raise ValueError(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION) headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) blob_headers = None if content_settings: blob_headers = BlobHTTPHeaders( blob_cache_control=content_settings.cache_control, blob_content_type=content_settings.content_type, blob_content_md5=content_settings.content_md5, blob_content_encoding=content_settings.content_encoding, blob_content_language=content_settings.content_language, blob_content_disposition=content_settings.content_disposition ) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) immutability_policy = kwargs.pop('immutability_policy', None) if immutability_policy: kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode blob_tags_string = serialize_blob_tags_header(kwargs.pop('tags', None)) options = { 'content_length': 0, 'blob_http_headers': blob_headers, 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'blob_tags_string': blob_tags_string, 'cls': return_response_headers, 'headers': headers} options.update(kwargs) return options @distributed_trace def create_append_blob(self, content_settings=None, metadata=None, **kwargs): # type: (Optional[ContentSettings], Optional[Dict[str, str]], **Any) -> Dict[str, Union[str, datetime]] """Creates a new Append Blob. :param ~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. :param metadata: Name-value pairs associated with the blob as metadata. :type metadata: dict(str, str) :keyword tags: Name-value pairs associated with the blob as tag. Tags are case-sensitive. 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 (_) .. versionadded:: 12.4.0 :paramtype tags: dict(str, str) :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword bool legal_hold: Specified if a legal hold should be set on the blob. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.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 `_. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] """ options = self._create_append_blob_options( content_settings=content_settings, metadata=metadata, **kwargs) try: return self._client.append_blob.create(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _create_snapshot_options(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Any] headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) cpk_scope_info = get_cpk_scope_info(kwargs) cpk = kwargs.pop('cpk', None) cpk_info = None if cpk: if self.scheme.lower() != 'https': raise ValueError("Customer provided encryption key must be used over HTTPS.") cpk_info = CpkInfo(encryption_key=cpk.key_value, encryption_key_sha256=cpk.key_hash, encryption_algorithm=cpk.algorithm) options = { 'timeout': kwargs.pop('timeout', None), 'lease_access_conditions': access_conditions, 'modified_access_conditions': mod_conditions, 'cpk_scope_info': cpk_scope_info, 'cpk_info': cpk_info, 'cls': return_response_headers, 'headers': headers} options.update(kwargs) return options @distributed_trace def create_snapshot(self, metadata=None, **kwargs): # type: (Optional[Dict[str, str]], **Any) -> Dict[str, Union[str, datetime]] """Creates a snapshot of the blob. A snapshot is a read-only version of a blob that's taken at a point in time. It can be read, copied, or deleted, but not modified. Snapshots provide a way to back up a blob as it appears at a moment in time. A snapshot of a blob has the same name as the base blob from which the snapshot is taken, with a DateTime value appended to indicate the time at which the snapshot was taken. :param metadata: Name-value pairs associated with the blob as metadata. :type metadata: dict(str, str) :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :keyword str if_tags_match_condition: Specify a SQL where clause on blob tags to operate only on destination blob with a matching value. .. versionadded:: 12.4.0 :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword ~azure.storage.blob.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. :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.2.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 `_. :returns: Blob-updated property dict (Snapshot ID, Etag, and last modified). :rtype: dict[str, Any] .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START create_blob_snapshot] :end-before: [END create_blob_snapshot] :language: python :dedent: 8 :caption: Create a snapshot of the blob. """ options = self._create_snapshot_options(metadata=metadata, **kwargs) try: return self._client.blob.create_snapshot(**options) # type: ignore except HttpResponseError as error: process_storage_error(error) def _start_copy_from_url_options(self, source_url, metadata=None, incremental_copy=False, **kwargs): # type: (str, Optional[Dict[str, str]], bool, **Any) -> Dict[str, Any] headers = kwargs.pop('headers', {}) headers.update(add_metadata_headers(metadata)) if 'source_lease' in kwargs: source_lease = kwargs.pop('source_lease') try: headers['x-ms-source-lease-id'] = source_lease.id except AttributeError: headers['x-ms-source-lease-id'] = source_lease tier = kwargs.pop('premium_page_blob_tier', None) or kwargs.pop('standard_blob_tier', None) tags = kwargs.pop('tags', None) # Options only available for sync copy requires_sync = kwargs.pop('requires_sync', None) encryption_scope_str = kwargs.pop('encryption_scope', None) source_authorization = kwargs.pop('source_authorization', None) # If tags is a str, interpret that as copy_source_tags copy_source_tags = isinstance(tags, str) if incremental_copy: if source_authorization: raise ValueError("Source authorization tokens are not applicable for incremental copying.") if copy_source_tags: raise ValueError("Copying source tags is not applicable for incremental copying.") # TODO: refactor start_copy_from_url api in _blob_client.py. Call _generated/_blob_operations.py copy_from_url # when requires_sync=True is set. # Currently both sync copy and async copy are calling _generated/_blob_operations.py start_copy_from_url. # As sync copy diverges more from async copy, more problem will surface. if requires_sync is True: headers['x-ms-requires-sync'] = str(requires_sync) if encryption_scope_str: headers['x-ms-encryption-scope'] = encryption_scope_str if source_authorization: headers['x-ms-copy-source-authorization'] = source_authorization if copy_source_tags: headers['x-ms-copy-source-tag-option'] = tags else: if encryption_scope_str: raise ValueError( "Encryption_scope is only supported for sync copy, please specify requires_sync=True") if source_authorization: raise ValueError( "Source authorization tokens are only supported for sync copy, please specify requires_sync=True") if copy_source_tags: raise ValueError( "Copying source tags is only supported for sync copy, please specify requires_sync=True") timeout = kwargs.pop('timeout', None) dest_mod_conditions = get_modify_conditions(kwargs) blob_tags_string = serialize_blob_tags_header(tags) if not copy_source_tags else None immutability_policy = kwargs.pop('immutability_policy', None) if immutability_policy: kwargs['immutability_policy_expiry'] = immutability_policy.expiry_time kwargs['immutability_policy_mode'] = immutability_policy.policy_mode options = { 'copy_source': source_url, 'seal_blob': kwargs.pop('seal_destination_blob', None), 'timeout': timeout, 'modified_access_conditions': dest_mod_conditions, 'blob_tags_string': blob_tags_string, 'headers': headers, 'cls': return_response_headers, } if not incremental_copy: source_mod_conditions = get_source_conditions(kwargs) dest_access_conditions = get_access_conditions(kwargs.pop('destination_lease', None)) options['source_modified_access_conditions'] = source_mod_conditions options['lease_access_conditions'] = dest_access_conditions options['tier'] = tier.value if tier else None options.update(kwargs) return options @distributed_trace def start_copy_from_url(self, source_url, metadata=None, incremental_copy=False, **kwargs): # type: (str, Optional[Dict[str, str]], bool, **Any) -> Dict[str, Union[str, datetime]] """Copies a blob from the given URL. This operation returns a dictionary containing `copy_status` and `copy_id`, which can be used to check the status of or abort the copy operation. `copy_status` will be 'success' if the copy completed synchronously or 'pending' if the copy has been started asynchronously. For asynchronous copies, the status can be checked by polling the :func:`get_blob_properties` method and checking the copy status. Set `requires_sync` to True to force the copy to be synchronous. The Blob service copies blobs on a best-effort basis. The source blob for a copy operation may be a block blob, an append blob, or a page blob. If the destination blob already exists, it must be of the same blob type as the source blob. Any existing destination blob will be overwritten. The destination blob cannot be modified while a copy operation is in progress. When copying from a page blob, the Blob service creates a destination page blob of the source blob's length, initially containing all zeroes. Then the source page ranges are enumerated, and non-empty ranges are copied. For a block blob or an append blob, the Blob service creates a committed blob of zero length before returning from this operation. When copying from a block blob, all committed blocks and their block IDs are copied. Uncommitted blocks are not copied. At the end of the copy operation, the destination blob will have the same committed block count as the source. When copying from an append blob, all committed blocks are copied. At the end of the copy operation, the destination blob will have the same committed block count as the source. :param str source_url: A URL of up to 2 KB in length that specifies a file or blob. The value should be URL-encoded as it would appear in a request URI. If the source is in another account, the source must either be public or must be authenticated via a shared access signature. If the source is public, no authentication is required. Examples: https://myaccount.blob.core.windows.net/mycontainer/myblob https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken :param metadata: Name-value pairs associated with the blob as metadata. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. :type metadata: dict(str, str) :param bool incremental_copy: Copies the snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. Defaults to False. :keyword tags: Name-value pairs associated with the blob as tag. Tags are case-sensitive. 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 (_). 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`. .. versionadded:: 12.4.0 :paramtype tags: dict(str, str) or Literal["COPY"] :keyword ~azure.storage.blob.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword bool legal_hold: Specified if a legal hold should be set on the blob. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword ~datetime.datetime source_if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the source blob has been modified since the specified date/time. :keyword ~datetime.datetime source_if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the source blob has not been modified since the specified date/time. :keyword str source_etag: The source ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions source_match_condition: The source match condition to use upon the etag. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the destination blob has been modified since the specified date/time. If the destination blob has not been modified, the Blob service returns status code 412 (Precondition Failed). :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this conditional header to copy the blob only if the destination blob has not been modified since the specified date/time. If the destination blob has been modified, the Blob service returns status code 412 (Precondition Failed). :keyword str etag: The destination ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The destination match condition to use upon the etag. :keyword destination_lease: The lease ID specified for this header must match the lease ID of the destination blob. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). :paramtype destination_lease: ~azure.storage.blob.BlobLeaseClient or str :keyword source_lease: Specify this to perform the Copy Blob operation only if the lease ID given matches the active lease ID of the source blob. :paramtype source_lease: ~azure.storage.blob.BlobLeaseClient or str :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 `_. :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 premium storage accounts. :keyword ~azure.storage.blob.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. :keyword ~azure.storage.blob.RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob :keyword bool seal_destination_blob: Seal the destination append blob. This operation is only for append blob. .. versionadded:: 12.4.0 :keyword bool requires_sync: Enforces that the service will not return a response until the copy is complete. :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. This option is only available when `incremental_copy` is set to False and `requires_sync` is set to True. .. versionadded:: 12.9.0 :keyword str encryption_scope: A predefined encryption scope used to encrypt the data on the sync copied blob. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. .. versionadded:: 12.10.0 :returns: A dictionary of copy properties (etag, last_modified, copy_id, copy_status). :rtype: dict[str, Union[str, ~datetime.datetime]] .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START copy_blob_from_url] :end-before: [END copy_blob_from_url] :language: python :dedent: 12 :caption: Copy a blob from a URL. """ options = self._start_copy_from_url_options( source_url=self._encode_source_url(source_url), metadata=metadata, incremental_copy=incremental_copy, **kwargs) try: if incremental_copy: return self._client.page_blob.copy_incremental(**options) return self._client.blob.start_copy_from_url(**options) except HttpResponseError as error: process_storage_error(error) def _abort_copy_options(self, copy_id, **kwargs): # type: (Union[str, Dict[str, Any], BlobProperties], **Any) -> Dict[str, Any] access_conditions = get_access_conditions(kwargs.pop('lease', None)) try: copy_id = copy_id.copy.id except AttributeError: try: copy_id = copy_id['copy_id'] except TypeError: pass options = { 'copy_id': copy_id, 'lease_access_conditions': access_conditions, 'timeout': kwargs.pop('timeout', None)} options.update(kwargs) return options @distributed_trace def abort_copy(self, copy_id, **kwargs): # type: (Union[str, Dict[str, Any], BlobProperties], **Any) -> None """Abort an ongoing copy operation. This will leave a destination blob with zero length and full metadata. This will raise an error if the copy operation has already ended. :param copy_id: The copy operation to abort. This can be either an ID string, or an instance of BlobProperties. :type copy_id: str or ~azure.storage.blob.BlobProperties :rtype: None .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START abort_copy_blob_from_url] :end-before: [END abort_copy_blob_from_url] :language: python :dedent: 12 :caption: Abort copying a blob from URL. """ options = self._abort_copy_options(copy_id, **kwargs) try: self._client.blob.abort_copy_from_url(**options) except HttpResponseError as error: process_storage_error(error) @distributed_trace def acquire_lease(self, lease_duration=-1, lease_id=None, **kwargs): # type: (int, Optional[str], **Any) -> BlobLeaseClient """Requests a new lease. If the blob does not have an active lease, the Blob Service creates a lease on the blob and returns a new lease. :param int lease_duration: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. Default is -1 (infinite lease). :param str lease_id: Proposed lease ID, in a GUID string format. The Blob Service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. :keyword ~datetime.datetime if_modified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time. :keyword ~datetime.datetime if_unmodified_since: A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. :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 `_. :returns: A BlobLeaseClient object. :rtype: ~azure.storage.blob.BlobLeaseClient .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_common.py :start-after: [START acquire_lease_on_blob] :end-before: [END acquire_lease_on_blob] :language: python :dedent: 8 :caption: Acquiring a lease on a blob. """ lease = BlobLeaseClient(self, lease_id=lease_id) # type: ignore lease.acquire(lease_duration=lease_duration, **kwargs) return lease @distributed_trace def set_standard_blob_tier(self, standard_blob_tier, **kwargs): # type: (Union[str, StandardBlobTier], Any) -> None """This operation sets the tier on a block blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. :param standard_blob_tier: Indicates the tier to be set on the blob. Options include 'Hot', 'Cool', 'Archive'. The hot tier is optimized for storing data that is accessed frequently. The cool storage tier is optimized for storing data that is infrequently accessed and stored for at least a month. The archive tier is optimized for storing data that is rarely accessed and stored for at least six months with flexible latency requirements. :type standard_blob_tier: str or ~azure.storage.blob.StandardBlobTier :keyword ~azure.storage.blob.RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob :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 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 `_. :keyword lease: Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :rtype: None """ access_conditions = get_access_conditions(kwargs.pop('lease', None)) mod_conditions = get_modify_conditions(kwargs) if standard_blob_tier is None: raise ValueError("A StandardBlobTier must be specified") if self.snapshot and kwargs.get('version_id'): raise ValueError("Snapshot and version_id cannot be set at the same time") try: self._client.blob.set_tier( tier=standard_blob_tier, snapshot=self.snapshot, timeout=kwargs.pop('timeout', None), modified_access_conditions=mod_conditions, lease_access_conditions=access_conditions, **kwargs) except HttpResponseError as error: process_storage_error(error) def _stage_block_options( self, block_id, # type: str data, # type: Union[Iterable[AnyStr], IO[AnyStr]] length=None, # type: Optional[int] **kwargs ): # type: (...) -> Dict[str, Any] if self.require_encryption or (self.key_encryption_key is not None): raise ValueError(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION) block_id = encode_base64(str(block_id)) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -