]hLddlZddlmZddlmZddlmZmZmZmZm Z m Z m Z m Z m Z mZmZmZddlmZddlmZmZmZddlmZddlmZdd lmZd d lmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;d d lZ>m?Z?m@Z@d d lAmBZBd dlCmDZDmEZEd dlFmGZGd dlHmIZId dlJmKZKd dlLmMZMmNZNmOZOmPZPmQZQmRZRd dlSmTZTd dlUmVZVmWZWmXZXd dlYmZZZm[Z[d dl\m]Z]m^Z^m_Z_m`Z`d dlambZbmcZcmdZderddlemfZfmgZgmhZhddlimjZjd dlLmkZkmlZlmmZmmnZnmoZoGddeWeDZpy)N)datetime)partial) AnyAnyStrcastDictIOIterableListOptionaloverloadTupleUnion TYPE_CHECKING)Self)HttpResponseErrorResourceExistsErrorResourceNotFoundError) ItemPaged)Pipeline)distributed_trace)_abort_copy_options_append_block_from_url_options_append_block_options_clear_page_options_commit_block_list_options_create_append_blob_options_create_page_blob_options_create_snapshot_options_delete_blob_options_download_blob_options _format_url_from_blob_url_get_blob_tags_options_get_block_list_result_get_page_ranges_options _parse_url_quick_query_options_resize_blob_options_seal_append_blob_options_set_blob_metadata_options_set_blob_tags_options_set_http_headers_options_set_sequence_number_options_stage_block_from_url_options_stage_block_options_start_copy_from_url_options_upload_blob_from_url_options_upload_blob_options_upload_page_options_upload_pages_from_url_options)deserialize_blob_properties&deserialize_pipeline_response_into_clsget_page_ranges_result parse_tags)StorageStreamDownloader)StorageEncryptionMixin(_ERROR_UNSUPPORTED_METHOD_FOR_ENCRYPTION)AzureBlobStorage)CpkInfo)BlobLeaseClient) BlobBlockBlobPropertiesBlobQueryErrorBlobType PageRangePageRangePaged)BlobQueryReader)parse_connection_strStorageAccountHostsMixinTransportWrapper)process_storage_errorreturn_response_headers)get_access_conditionsget_api_versionget_modify_conditionsget_version_id)upload_append_blobupload_block_blobupload_page_blob)AzureNamedKeyCredentialAzureSasCredentialTokenCredentialContainerClient)ContentSettingsImmutabilityPolicyPremiumPageBlobTierSequenceNumberActionStandardBlobTierc eZdZdZ dgdedededeeeeeeffdeeeeeefdd d fd ed dffd Z ded efdZ e dgdedeeeeeefdd d fdeeeeeeffd ed e f dZ e dgdedededeeeeeeffdeeeeeefdd d fd ed e fdZed ed eeeffdZedddedeeeefd ed eeeffdZeej&ddfdeeeeeeefdeeefdeedeeeefd ed eeeff dZe dgdeedeeded ed eef dZe dgdd deedeeddd ed eef d!Ze dgdd deedeedeedfd ed eeeeeff d"Zed#ed ed efd$Zedhd%eed ed dfd&Zed ed dfd'Z ed ed e!fd(Z"ed ed e#fd)Z$edhd*ed+d ed eeeffd,Z%e dhdeeeefd ed eeeee&fffd-Z'ed.d/d ed eeeffd0Z(ed ed dfd1Z)ed2e!d ed eeeee&e!fffd3Z*e did4ed*ed+deeeefd5eeed6fd ed eeeee&fff d7Z+e dgd*ed+deeeefd ed eeeee&fffd8Z,e dhdeeeefd ed eeeee&fffd9Z-e djdedeeeefd:e!d ed eeeee&fff d;Z.eded?eed ed e0fd@Z1edAeedBfd ed dfdCZ2e dhdDedeeeeeeefdeed ed eeeff dEZ3e didDededFeedGeedHeeee4fd ed eeeffdIZ5e dldJed ed e6e7e8e7e8ffdKZ9e dgdLe7e8d*ed+deeeefd ed eeeee&fff dMZ:ed5d6d ed dfdNZ;edhdOeeeefd ed eeeffdPZeddddTdeedeedUeeeeeeffd ed e?e@f dVZAe dgdWedeedeed ed e6e7eeefe7eeefff dXZBe dhdYeedZfd[eed ed eeeee&fffd\ZCed4ed ed eeeee&fffd]ZDed^ededed ed eeeee&fff d_ZEededededFed ed eeeff d`ZFededed ed eeeee&fffdaZGe dhdeeeeeeefdeed ed eeeee&efffdbZHe dgdcedFeedGeed ed eeeee&efff ddZIed ed eeeee&efffdeZJedmdfZKxZLS)n BlobClientaA client to interact with a specific blob, although that blob may not yet exist. For more optional configuration, please click `here `__. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the blob, use the :func:`from_blob_url` classmethod. :param container_name: The container name for the blob. :type container_name: str :param blob_name: The name of the blob with which to interact. If specified, this value will override a blob value specified in the blob URL. :type blob_name: str :param str snapshot: The optional blob snapshot on which to operate. This can be the snapshot ID string or the response returned from :func:`create_snapshot`. :param credential: The credentials with which to authenticate. This is optional if the account URL already has a SAS token. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential - except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key. :keyword str api_version: The Storage API version to use for requests. Default value is the most recent service version that is compatible with the current SDK. Setting to an older version may result in reduced feature compatibility. .. versionadded:: 12.2.0 :keyword str secondary_hostname: The hostname of the secondary endpoint. :keyword int max_block_size: The maximum chunk size for uploading a block blob in chunks. Defaults to 4*1024*1024, or 4MB. :keyword int max_single_put_size: If the blob size is less than or equal max_single_put_size, then the blob will be uploaded with only one http PUT request. If the blob size is larger than max_single_put_size, the blob will be uploaded in chunks. Defaults to 64*1024*1024, or 64MB. :keyword int min_large_block_upload_threshold: The minimum chunk size required to use the memory efficient algorithm when uploading a block blob. Defaults to 4*1024*1024+1. :keyword bool use_byte_buffer: Use a byte buffer for block blob uploads. Defaults to False. :keyword int max_page_size: The maximum chunk size for uploading a page blob. Defaults to 4*1024*1024, or 4MB. :keyword int max_single_get_size: The maximum size for a blob to be downloaded in a single call, the exceeded part will be downloaded in chunks (could be parallel). Defaults to 32*1024*1024, or 32MB. :keyword int max_chunk_get_size: The maximum chunk size used for downloading a blob. Defaults to 4*1024*1024, or 4MB. :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. :keyword str audience: The audience to use when requesting tokens for Azure Active Directory authentication. Only has an effect when credential is of type TokenCredential. The value could be https://storage.azure.com/ (default) or https://.blob.core.windows.net. .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_authentication.py :start-after: [START create_blob_client] :end-before: [END create_blob_client] :language: python :dedent: 8 :caption: Creating the BlobClient from a URL to a public blob (no auth needed). .. literalinclude:: ../samples/blob_samples_authentication.py :start-after: [START create_blob_client_sas_url] :end-before: [END create_blob_client_sas_url] :language: python :dedent: 8 :caption: Creating the BlobClient from a SAS URL to a blob. N account_urlcontainer_name blob_namesnapshot credentialrTrUrVkwargsreturnc \t|||\}}} ||_||_|t|dr|j|_n&t |t r |d|_n |xs| |_|jdd|_|r|n||_ |j|||j\|_ }tt|:|fd|d|t|j |j |j"|_t'||j$j(_|j-|y)N)r`rarbrc version_id)rcblob)servicerd)base_urlpipeline)r(rarbhasattrrc isinstancedictpoprh_raw_credential_format_query_string _query_strsuperr___init__r>url _pipeline_clientrN_configversion_configure_encryption) selfr`rarbrcrdre parsed_url sas_token path_snapshot __class__s e/var/www/core.comfia.cic-ware.com/crm/lib/python3.12/site-packages/azure/storage/blob/_blob_client.pyruzBlobClient.__init__s0:#)0!, I}-"  GHj$A$--DM $ '$Z0DM$5 DM **\48.8zY&*&?&? :`d`m`m&?&n# j$(eVPZe^de'488dnn] '6v'> $ ""6*hostnamecrt|j|j|j|j|S)N)raschemerb query_strr)r#rarrbrs)r|rs rr#zBlobClient._format_urls0..;;nnoo   rblob_urlc Bt||\}}}}||f||||d|S)a Create BlobClient from a blob url. This doesn't support customized blob url with '/' in blob name. :param str blob_url: The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current `location_mode`. :type blob_url: str :param credential: The credentials with which to authenticate. This is optional if the account URL already has a SAS token, or the connection string already has shared access key values. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential - except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key. :type credential: ~azure.core.credentials.AzureNamedKeyCredential or ~azure.core.credentials.AzureSasCredential or ~azure.core.credentials.TokenCredential or str or dict[str, str] or None :param str snapshot: The optional blob snapshot on which to operate. This can be the snapshot ID string or the response returned from :func:`create_snapshot`. If specified, this will override the snapshot in the url. :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. :keyword str audience: The audience to use when requesting tokens for Azure Active Directory authentication. Only has an effect when credential is of type TokenCredential. The value could be https://storage.azure.com/ (default) or https://.blob.core.windows.net. :returns: A Blob client. :rtype: ~azure.storage.blob.BlobClient )rrcrarbrcrd)r$) clsrrdrcrer`rarbrs r from_blob_urlzBlobClient.from_blob_urlsEPAOX`ks@t= ^Y   (6)"z =C  rconn_strc Rt||d\}}}d|vr||d<||f||||d|S)a Create BlobClient from a Connection String. :param str conn_str: A connection string to an Azure Storage account. :param container_name: The container name for the blob. :type container_name: str :param blob_name: The name of the blob with which to interact. :type blob_name: str :param str snapshot: The optional blob snapshot on which to operate. This can be the snapshot ID string or the response returned from :func:`create_snapshot`. :param credential: The credentials with which to authenticate. This is optional if the account URL already has a SAS token, or the connection string already has shared access key values. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. Credentials provided here will take precedence over those in the connection string. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key. :type credential: ~azure.core.credentials.AzureNamedKeyCredential or ~azure.core.credentials.AzureSasCredential or ~azure.core.credentials.TokenCredential or str or dict[str, str] or None :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. :keyword str audience: The audience to use when requesting tokens for Azure Active Directory authentication. Only has an effect when credential is of type TokenCredential. The value could be https://storage.azure.com/ (default) or https://.blob.core.windows.net. :returns: A Blob client. :rtype: ~azure.storage.blob.BlobClient .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_authentication.py :start-after: [START auth_from_connection_string_blob] :end-before: [END auth_from_connection_string_blob] :language: python :dedent: 8 :caption: Creating the BlobClient from a connection string. risecondary_hostnamer)rH) rrrarbrcrdrer` secondarys rfrom_connection_stringz!BlobClient.from_connection_stringsVf.B(JX^-_* Y v -+4F' (  (6)* 8>  rc ttttf|jjj ddt i|S#t$r}t|Yd}~yd}~wwxYw)akGets information related to the storage account in which the blob resides. The information can also be retrieved if the user has a SAS to a container or blob. The keys in the returned dictionary include 'sku_name' and 'account_kind'. :returns: A dict of account information (SKU and account type). :rtype: dict(str, str) rN) rrstrrxriget_account_inforLrrKr|reerrors rget_account_informationz"BlobClient.get_account_information3sY )S#X(J (9(9(J(J(qOf(qjp(qr r  ) !% ( ( )sAA A' A""A')metadata source_urlrc V|jdr(|jjdk7r tdt d||d|} t t ttf|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)ap Creates a new Block Blob where the content of the blob is read from a given URL. The content of an existing blob is overwritten with the new blob. :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. The source must either be public or must be authenticated via a shared access signature as part of the url or using the source_authorization keyword. 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 :keyword dict(str, str) metadata: Name-value pairs associated with the blob as metadata. :keyword bool overwrite: Whether the blob to be uploaded should overwrite the current data. If True, upload_blob will overwrite the existing data. If set to False, the operation will fail with ResourceExistsError. :keyword bool include_source_blob_properties: Indicates if properties from the source blob should be copied. Defaults to True. :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 (_) :paramtype tags: dict(str, str) :keyword bytearray source_content_md5: Specify the md5 that is used to verify the integrity of the source bytes. :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 header to perform the operation only if the source resource has been modified since the specified 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 header to perform the operation only if the source resource 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 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: 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 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.ContentSettings content_settings: ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control. :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. :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 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. :returns: Blob-updated property Dict (Etag and last modified) :rtype: Dict[str, Any] cpkhttps9Customer provided encryption key must be used over HTTPS.)rrNr)getrlower ValueErrorr3rrrrrx block_blobput_blob_from_urlrrK)r|rrreoptionsrs rupload_blob_from_urlzBlobClient.upload_blob_from_urlBsT ::e !2!2!4!?XY Y/! )S#X(Q (?(?(Q(Q(\T[(\] ]  ) !% ( ( )s AB B( B##B(data blob_typelengthc |jr|js td|jdr(|jj dk7r tdt d|||||j|j|j|jd|j|j|jd|}|tjk(r tdi|S|tjk(r t!di|St#di|S)a!"Creates a new blob from a data source with automatic chunking. :param data: The blob data to upload. :type data: Union[bytes, str, Iterable[AnyStr], IO[AnyStr]] :param ~azure.storage.blob.BlobType blob_type: The type of the blob. This can be either BlockBlob, PageBlob or AppendBlob. The default value is BlockBlob. :param int length: Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance. :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 bool overwrite: Whether the blob to be uploaded should overwrite the current data. If True, upload_blob will overwrite the existing data. If set to False, the operation will fail with ResourceExistsError. The exception to the above is with Append blob types: if set to False and the data already exists, an error will not be raised and the data will be appended to the existing blob. If set overwrite=True, then the existing append blob will be deleted, and a new one created. Defaults to False. :keyword ~azure.storage.blob.ContentSettings content_settings: ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control. :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, upload_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.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.ImmutabilityPolicy immutability_policy: Specifies the immutability policy of a blob, blob snapshot or blob version. Currently this parameter of upload_blob() API is for BlockBlob only. .. 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. Currently this parameter of upload_blob() API is for BlockBlob only. .. versionadded:: 12.10.0 This was introduced in API version '2020-10-02'. :keyword int maxsize_condition: Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). :keyword int max_concurrency: Maximum number of parallel connections to use when transferring the blob in chunks. This option does not affect the underlying connection pool, and may require a separate configuration of the connection pool. :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 str encoding: Defaults to UTF-8. :keyword progress_hook: A callback to track the progress of a long running upload. The signature is function(current: int, total: Optional[int]) where current is the number of bytes transferred so far, and total is the size of the blob or None if the size is unknown. :paramtype progress_hook: Callable[[int, Optional[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. :returns: Blob-updated property Dict (Etag and last modified) :rtype: Dict[str, Any] .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_hello_world.py :start-after: [START upload_a_blob] :end-before: [END upload_a_blob] :language: python :dedent: 12 :caption: Upload a blob to the container. ,Encryption required but no key was provided.rrrrequiredrzkeyresolver)rrrrencryption_optionsconfig sdk_monikerclientr)require_encryptionkey_encryption_keyrrrrr4encryption_versionkey_resolver_functionry _sdk_monikerrxrD BlockBlobrRPageBlobrSrQ)r|rrrrrers r upload_blobzBlobClient.upload_blobsd  " "4+B+BKL L ::e !2!2!4!?XY Y& 3322.. 66   <<))<< ** *$/w/ / )) )#.g. .!,G,,roffsetencodingc yNrr|rrrres r download_blobzBlobClient.download_blobb r)rc yrrrs rrzBlobClient.download_bloblrrc |jr#|js|js td| | td|j dr(|j j dk7r tdtd|j|jt|j|||||j|j|j|jd|j|j|jd |}t!di|S) a#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: Maximum number of parallel connections to use when transferring the blob in chunks. This option does not affect the underlying connection pool, and may require a separate configuration of the connection pool. :keyword Optional[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 transferred 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. rz/Offset value must not be None if length is set.rrrr) rbrarhrrrrrrrr)rrrrrrrr"rbrarPrhrryrrxr;)r|rrrrers rrzBlobClient.download_blobvsH  " "D,C,CtGaGaKL L  &.NO O ::e !2!2!4!?XY Y(nn..%doov> 3322.. 66   <<))<< !"'111rquery_expressionc |jdd}|jdt}|jdd}|jdr(|jj dk7r t dt |j|fi|\}} |jjjd i|\}} t|j|j||| |S#t$r} t| Yd} ~ @d} ~ wwxYw) aEnables 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. For more details see https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference. :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 .. note:: "ParquetDialect" is in preview, so some features may not work as intended. :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. on_errorN error_clsrrrr)name containererrorsrecord_delimiterrheadersresponserr)rprCrrrrr)rcrxriqueryrrKrGrbra) r|rrerrrr delimiterrraw_response_bodyrs r query_blobzBlobClient.query_blobs^J-JJ{N; ::j$/ ::e !2!2!4!?XY Y1$--AQ\U[\ ))@):):)@)@)K7)K &G&))&&! !! ) !% ( ( )s)C C=( C88C=delete_snapshotsc td|jt|j||d|} |jj j di|y#t$r}t|Yd}~yd}~wwxYw)a_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 Optional[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 Optional[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. )rcrhrNr) r!rcrPrhrxrideleterrK)r|rrerrs r delete_blobzBlobClient.delete_blobVssP']]%doov>-   ) $DLL   $ $ /w /  ) !% ( ( )s&A A4 A//A4c |jjjdd|jddi|y#t$r}t |Yd}~yd}~wwxYw)aRestores 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. timeoutNr)rxriundeleterprrKrs r undelete_blobzBlobClient.undelete_blobsO8 ) &DLL   & & Uvzz)T/J Uf U  ) !% ( ( )s8; A AAc t|j|} |jjjd|j |d|y#t $rYyt$r*} t|n#t$rYYd}~ywxYwYd}~yd}~wwxYw)a\ 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 :rtype: bool )rcrhTNFr) rPrhrxriget_propertiesrcrrrKr)r|rerhrs rexistszBlobClient.existss$$DOOV<   ,DLL   , , %  "    %e,(  - s;3A B B  A,+B, A<5B;A<<BB c Ft|jdd}t|}t|j|}|jdd}d}|rT|j j dk7r tdt|j|j|j} |jdd}|rtt||d<tt|j j"j$d |jdd||j&|||jddxst(|d |}|j._t3|tr"|j4|_|j&|_|S#t*$r} t-| Yd} ~ ^d} ~ wwxYw) aY 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. leaseNrrr)encryption_keyencryption_key_sha256encryption_algorithmrr)rrhrclease_access_conditionsmodified_access_conditionsrcpk_infor)rMrprOrPrhrrrr? key_valuekey_hash algorithmrr8rrBrxrirrcr7rrKrbrrnrar) r|reaccess_conditionsmod_conditionsrhrr cls_method blob_propsrs rget_blob_propertieszBlobClient.get_blob_propertiessw@2&**Wd2KL.v6#DOOV< jj% {{  "g- !\]]cmmSVS_S_47MMCH )E40J '(NPZ [u n.Ndll.?.?.N.N/ 9d3%(9+9JJud+J/J!//J..  j. 1#'#6#6J "&--J  ! ) !% ( ( )s(BF F  FF content_settingsrYc tdd|i|} ttttf|j j jdi|S#t$r}t|Yd}~yd}~wwxYw)a^ 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] rNr) r.rrrrrxriset_http_headersrrK)r|rrerrs rrzBlobClient.set_http_headersJsiZ,X=MXQWX )S#X(J (9(9(J(J(UW(UV V  ) !% ( ( )sAA A. A))A.c n|jdr(|jjdk7r tdt dd|i|} t t ttttff|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)a 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) :rtype: Dict[str, Union[str, datetime]] rrrrNr)rrrrr,rrrrrrxri set_metadatarrKr|rrerrs rset_blob_metadatazBlobClient.set_blob_metadata}sz ::e !2!2!4!?XY Y,IhI&I )S%X "6679W9J9J9W9W9bZa9bc c  ) !% ( ( )sA B B4 B//B4immutability_policyrZc t|j|}|j|d<|j|d<t t t t f|jjjdt|d|S)aThe 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 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: Key value pairs of blob tags. :rtype: Dict[str, str] immutability_policy_expiryimmutability_policy_mode)rrhr) rPrh expiry_time policy_moderrrrxriset_immutability_policyrL)r|rrerhs rrz"BlobClient.set_immutability_policys~:$DOOV< /B/N/N+,-@-L-L)*DcN$MDLL$5$5$M$M%J'J%JBH%JK Krc t|j|}|jjjdd|i|y)aThe 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 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: Key value pairs of blob tags. :rtype: Dict[str, str] rhNr)rPrhrxridelete_immutability_policy)r|rerhs rrz%BlobClient.delete_immutability_policys6($DOOV< 4 44U UfUr legal_holdc t|j|}tttt tt tff|jjj|f|td|S)a1The 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 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: Key value pairs of blob tags. :rtype: Dict[str, Union[str, datetime, bool]] )rhr) rPrhrrrrrboolrxriset_legal_holdrL)r|rrerhs rrzBlobClient.set_legal_holdsn,$DOOV< DeC4$7889;[4<<;L;L;[;[ `__. :returns: Blob-updated property dict (Etag and last modified). :rtype: dict[str, Any] Nrrr)rrrrr)rrrr=rrrrrrrrrx page_blobcreaterrK)r|rrrrrerrs rcreate_page_blobzBlobClient.create_page_blobsx  " "t'>'>'JEF F ::e !2!2!4!?XY Y+-#9     )S#X(E (>(>(E(E(P(PQ Q  ) !% ( ( )2AB33 C< C  Cc |js |jtt|j dr(|j j dk7r tdtd||d|} ttttttff|jjjdi|S#t $r}t#|Yd}~yd}~wwxYw)aCreates a new Append Blob. This operation creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. To add content to the append blob, call the :func:`append_block` or :func:`append_block_from_url` method. :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] Nrrr)rrr)rrrr=rrrrrrrrrrx append_blobrrrK)r|rrrerrs rcreate_append_blobzBlobClient.create_append_blobsb  " "t'>'>'JEF F ::e !2!2!4!?XY Y-- )S%X "6679X9Q9Q9X9X9c[b9cd d  ) !% ( ( )s0A B>> C CCc T|jdr(|jjdk7r tdt dd|i|} t t ttf|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)aCreates 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. rrrrNr)rrrrr rrrrrxricreate_snapshotrrKrs rr zBlobClient.create_snapshotsV ::e !2!2!4!?XY Y*GHGG )S#X(I (9(9(I(I(TG(TU U  ) !% ( ( )AB B' B""B'incremental_copyc td|||d|} |rNtttttt ff|j jjdi|Stttttt ff|j jjdi|S#t$r}t|Yd}~yd}~wwxYw)a*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. )rrr Nr) r2rrrrrrxrcopy_incrementalristart_copy_from_urlrrK)r|rrr rerrs rrzBlobClient.start_copy_from_url2sn/!-   )DeCM&:!:;=dT\\=S=S=d=d=ogn=oppS%X "6679^9J9J9^9^9iah9ij j  ) !% ( ( )sAB/!A B// C 8 CC copy_idc t|fi|} |jjjdi|y#t$r}t |Yd}~yd}~wwxYw)aAbort 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. Nr)rrxriabort_copy_from_urlrrK)r|rrerrs r abort_copyzBlobClient.abort_copysP2&g88 ) 1DLL   1 1 `__. :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. )rrr)r@acquire)r|rrrers r acquire_leasezBlobClient.acquire_leases,r x8 >^>v> rstandard_blob_tierr]c t|jdd}t|}t|j|}| t d|j r|jdr t d |jjjd||j |jdd|||d|y#t$r}t|Yd}~yd}~wwxYw) aThis 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 rNz$A StandardBlobTier must be specifiedrhz6Snapshot and version_id cannot be set at the same timer)tierrcrrrrhr) rMrprOrPrhrrcrrxriset_tierrrK)r|rrerrrhrs rset_standard_blob_tierz!BlobClient.set_standard_blob_tierQsT2&**Wd2KL.v6#DOOV<  %CD D ==VZZ 5UV V ) &DLL   & & ' 9d3+9(9%   ! ) !% ( ( )s3AB;; C CCblock_idc |js |jtt|j dr(|j j dk7r tdtd|||d|} ttttf|jjjdi|S#t$r}t!|Yd}~yd}~wwxYw)a Creates a new block to be committed as part of a blob. :param str block_id: A string value that identifies the block. The string should be less than or equal to 64 bytes in size. For a given blob, the block_id must be the same size for each block. :param data: The blob data. :type data: Union[bytes, str, Iterable[AnyStr], IO[AnyStr]] :param int length: Size of the block. :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. Value can be a BlobLeaseClient object or the lease ID as a string. :paramtype lease: ~azure.storage.blob.BlobLeaseClient or str :keyword str encoding: Defaults to UTF-8. :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 property dict. :rtype: dict[str, Any] Nrrr)rrrr)rrrr=rrrr1rrrrrxr stage_blockrrK)r|rrrrerrs rr!zBlobClient.stage_blocksh  " "t'>'>'JEF F ::e !2!2!4!?XY Y&   )S#X(K (?(?(K(K(Vg(VW W  ) !% ( ( )1AB22 C; C  C source_offset source_lengthsource_content_md5c \|jdr(|jjdk7r tdt d|||||d|} t t ttf|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)a% Creates a new block to be committed as part of a blob where the contents are read from a URL. :param str block_id: A string value that identifies the block. The string should be less than or equal to 64 bytes in size. For a given blob, the block_id must be the same size for each block. :param str source_url: The URL. :param int source_offset: Start of byte range to use for the block. Must be set if source length is provided. :param int source_length: The size of the block in bytes. :param bytearray source_content_md5: Specify the md5 calculated for the range of bytes that must be read from the copy source. :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 `__. :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. :returns: Blob property dict. :rtype: dict[str, Any] rrr)rrr#r$r%Nr)rrrrr0rrrrrxrstage_block_from_urlrrK) r|rrr#r$r%rerrs rr'zBlobClient.stage_block_from_urlsh ::e !2!2!4!?XY Y/!''1    )S#X(T (?(?(T(T(_W^(_` `  ) !% ( ( )s AB B+ B&&B+block_list_typec Ht|jdd}t|} |jjj d||j |jdd||d|}t|S#t$r}t|Yd}~tSd}~wwxYw)aThe Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob. :param str block_list_type: Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. Possible values include: 'committed', 'uncommitted', 'all' :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 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 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 tuple of two lists - committed and uncommitted blocks :rtype: Tuple[List[BlobBlock], List[BlobBlock]] rNr) list_typercrrrr) rMrprOrxrget_block_listrcrrKr&)r|r(rerrblocksrs rr+zBlobClient.get_block_lists<2&**Wd2KL.v6 );T\\,,;;) 9d3(9+9   F&f--! ) !% ( (%f-- )sAA99 B! BB! block_listc |js |jtt|j dr(|j j dk7r tdtd|||d|} ttttf|jjjdi|S#t$r}t!|Yd}~yd}~wwxYw)aThe Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. :param list block_list: List of Blockblobs. :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 bool validate_content: If true, calculates an MD5 hash of the page content. 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. :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 ~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.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) Nrrr)r-rrr)rrrr=rrrrrrrrrxrcommit_block_listrrK)r|r-rrrerrs rr/zBlobClient.commit_block_list>sD  " "t'>'>'JEF F ::e !2!2!4!?XY Y,!-   )S#X(Q (?(?(Q(Q(\T[(\] ]  ) !% ( ( )r"c $t|jdd}t|}| td |jj j d||jdd||d|y#t$r}t|Yd}~yd}~wwxYw)aSets the page blob tiers on the blob. This API is only supported for page blobs on premium accounts. :param premium_page_blob_tier: A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on premium storage accounts. :type premium_page_blob_tier: ~azure.storage.blob.PremiumPageBlobTier :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 rNz'A PremiumPageBlobTier must be specifiedr)rrrrr) rMrprOrrxrirrrK)r|rrerrrs rset_premium_page_blob_tierz%BlobClient.set_premium_page_blob_tiers62&**Wd2KL.v6 ! )FG G ) &DLL   & & + 9d3(9+9      ! ) !% ( ( )s;A11 B: B  Btagsc t|j|}td||d|} ttt t f|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)a The Set Tags operation enables users to set tags on a blob or specific blob version, but not snapshot. Each call to this operation replaces all existing tags attached to the blob. To remove all tags from the blob, call this operation with no tags set. .. versionadded:: 12.4.0 This operation was introduced in API version '2019-12-12'. :param 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 (_) :type tags: dict(str, str) :keyword str version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to add tags to. :keyword bool validate_content: If true, calculates an MD5 hash of the tags content. 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. :keyword str if_tags_match_condition: Specify a SQL where clause on blob tags to operate only on destination blob with a matching value. eg. ``"\"tagname\"='my tag'"`` :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 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] )rhr2Nr) rPrhr-rrrrrxriset_tagsrrK)r|r2rerhrrs r set_blob_tagszBlobClient.set_blob_tagssyT$DOOV< (TJTTVT )S#X(B (9(9(B(B(MW(MN N  ) !% ( ( )sAA'' B0 BBc @t|j|}td||jd|} |jj j di|\}}ttttft|S#t$r}t|Yd}~yd}~wwxYw)aThe Get Tags operation enables users to get tags on a blob or specific blob version, or snapshot. .. versionadded:: 12.4.0 This operation was introduced in API version '2019-12-12'. :keyword Optional[str] version_id: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to add tags to. :keyword str if_tags_match_condition: Specify a SQL where clause on blob tags to operate only on destination blob with a matching value. eg. ``"\"tagname\"='my tag'"`` :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 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] )rhrcNr) rPrhr%rcrxriget_tagsrrrr:rrK)r|rerhr_r2rs r get_blob_tagszBlobClient.get_blob_tags s4$DOOV< (aJaZ`a )0dll''00;7;GAtS#X 4(89 9  ) !% ( ( )sAA?? B BBprevious_snapshot_diffc vtjdttd|j|||d|} |r'|j j jdi|}n&|j j jdi|}t|S#t$r}t|Yd}~tSd}~wwxYw)a DEPRECATED: Returns the list of valid page ranges for a Page Blob or snapshot of a page blob. :param int offset: Start of byte range to use for getting valid page ranges. If no length is given, all bytes after the offset will be searched. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param int length: Number of bytes to use for getting valid page ranges. If length is given, offset must be provided. This range will return valid page ranges from the offset start up to the specified length. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param str previous_snapshot_diff: The snapshot diff parameter that contains an opaque DateTime value that specifies a previous blob snapshot to be compared against a more recent snapshot or the current 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 ~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 tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. :rtype: tuple(list(dict(str, str), list(dict(str, str)) z;get_page_ranges is deprecated, use list_page_ranges insteadrcrrr:Nr) warningswarnDeprecationWarningr'rcrxrget_page_ranges_diffget_page_rangesrrKr9)r|rrr:rerrangesrs rrAzBlobClient.get_page_ranges* sD  I  +]]#9     )%D//DDOwO?//??J'J&f--! ) !% ( (%f-- )sAB B8 B33B8)rrprevious_snapshotrCc ,|jdd}td|j|||d|}|r+t|jj j fi|}n*t|jj jfi|}t||tS)a6Returns the list of valid page ranges for a Page Blob or snapshot of a page blob. If `previous_snapshot` is specified, the result will be a diff of changes between the target blob and the previous snapshot. :keyword int offset: Start of byte range to use for getting valid page ranges. If no length is given, all bytes after the offset will be searched. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :keyword int length: Number of bytes to use for getting valid page ranges. If length is given, offset must be provided. This range will return valid page ranges from the offset start up to the specified length. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :keyword previous_snapshot: A snapshot value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by `previous_snapshot` is the older of the two. :paramtype previous_snapshot: str or Dict[str, Any] :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 results_per_page: The maximum number of page ranges to retrieve per API call. :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: An iterable (auto-paging) of PageRange. :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.PageRange] results_per_pageNr<)rEpage_iterator_classr) rpr'rcrrxrr@rArrF)r|rrrCrerErcommands rlist_page_rangeszBlobClient.list_page_ranges sN"::&8$?*]]#4     &&;;G &&66G &6 .0 0rprevious_snapshot_urlc td|j|||d|} |jjjdi|}t|S#t $r}t |Yd}~tSd}~wwxYw)a Returns the list of valid page ranges for a managed disk or snapshot. .. note:: This operation is only available for managed disk accounts. .. versionadded:: 12.2.0 This operation was introduced in API version '2019-07-07'. :param str previous_snapshot_url: Specifies the URL of a previous snapshot of the managed disk. The response will only contain pages that were changed between the target blob and its previous snapshot. :param int offset: Start of byte range to use for getting valid page ranges. If no length is given, all bytes after the offset will be searched. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param int length: Number of bytes to use for getting valid page ranges. If length is given, offset must be provided. This range will return valid page ranges from the offset start up to the specified length. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :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 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 tuple of two lists of page ranges as dictionaries with 'start' and 'end' keys. The first element are filled page ranges, the 2nd element is cleared page ranges. :rtype: tuple(list(dict(str, str), list(dict(str, str)) )rcrrprev_snapshot_urlNr)r'rcrxrr@rrKr9)r|rIrrrerrBrs r$get_page_range_diff_for_managed_diskz/BlobClient.get_page_range_diff_for_managed_disk sB+]]3     )@T\\++@@K7KF&f--! ) !% ( (%f-- )s&A A5 A00A5sequence_number_actionr\sequence_numberc t|fd|i|} ttttf|j j jdi|S#t$r}t|Yd}~yd}~wwxYw)a Sets the blob sequence number. :param str sequence_number_action: This property indicates how the service should modify the blob's sequence number. See :class:`~azure.storage.blob.SequenceNumberAction` for more information. :param str sequence_number: This property sets the blob's sequence number. The sequence number is a user-controlled property that you can use to track requests and manage concurrency issues. :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) rNNr) r/rrrrrxrupdate_sequence_numberrrK)r|rMrNrerrs rset_sequence_numberzBlobClient.set_sequence_number( smf//EqWfqjpq )S#X(U (>(>(U(U(`X_(`a a  ) !% ( ( )sAA A/ A**A/c T|jdr(|jjdk7r tdt dd|i|} t t ttf|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)a Resizes a page blob to the specified size. If the specified value is less than the current size of the blob, then all pages above the specified value are cleared. :param int size: Size used to resize blob. Maximum size for a page blob is up to 1 TB. The page blob size must be aligned to a 512-byte boundary. :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.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 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) rrrrNr)rrrrr*rrrrrxrresizerrK)r|rrerrs r resize_blobzBlobClient.resize_bloba sd ::e !2!2!4!?XY Y&;D;F; )S#X(E (>(>(E(E(P(PQ Q  ) !% ( ( )r pagec |js |jtt|j dr(|j j dk7r tdtd|||d|} ttttf|jjjdi|S#t$r}t!|Yd}~yd}~wwxYw)aThe Upload Pages operation writes a range of pages to a page blob. :param bytes page: Content of the page. :param int offset: Start of byte range to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param int length: Number of bytes to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :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 bool validate_content: If true, calculates an MD5 hash of the page content. 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. :keyword int if_sequence_number_lte: If the blob's sequence number is less than or equal to the specified value, the request proceeds; otherwise it fails. :keyword int if_sequence_number_lt: If the blob's sequence number is less than the specified value, the request proceeds; otherwise it fails. :keyword int if_sequence_number_eq: If the blob's sequence number is equal to the specified value, the request proceeds; otherwise it fails. :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 str encoding: Defaults to UTF-8. :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) Nrrr)rUrrr)rrrr=rrrr5rrrrrxr upload_pagesrrK)r|rUrrrerrs r upload_pagezBlobClient.upload_page sp  " "t'>'>'JEF F ::e !2!2!4!?XY Y&   )S#X(K (>(>(K(K(Vg(VW W  ) !% ( ( )r"c |js |jtt|j dr(|j j dk7r tdtd||||d|} ttttf|jjjdi|S#t$r}t!|Yd}~yd}~wwxYw)a# The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL. :param str source_url: The URL of the source data. It can point to any Azure Blob or File, that is either public or has a shared access signature attached. :param int offset: Start of byte range to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param int length: Number of bytes to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param int source_offset: This indicates the start of the range of bytes(inclusive) that has to be taken from the copy source. The service will read the same number of bytes as the destination range (length-offset). :keyword bytes source_content_md5: If given, the service will calculate the MD5 hash of the block content and compare against this value. :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 header to perform the operation only if the source resource has been modified since the specified 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 header to perform the operation only if the source resource 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 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 int if_sequence_number_lte: If the blob's sequence number is less than or equal to the specified value, the request proceeds; otherwise it fails. :keyword int if_sequence_number_lt: If the blob's sequence number is less than the specified value, the request proceeds; otherwise it fails. :keyword int if_sequence_number_eq: If the blob's sequence number is equal to the specified value, the request proceeds; otherwise it fails. :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: 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 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 `__. :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. :returns: Response after uploading pages from specified URL. :rtype: Dict[str, Any] Nrrr)rrrr#r)rrrr=rrrr6rrrrrxrupload_pages_from_urlrrK)r|rrrr#rerrs rrZz BlobClient.upload_pages_from_url sX  " "t'>'>'JEF F ::e !2!2!4!?XY Y0 !'     )S#X(T (>(>(T(T(_W^(_` `  ) !% ( ( )rc |js |jtt|j dr(|j j dk7r tdtd||d|} ttttf|jjjdi|S#t$r}t!|Yd}~yd}~wwxYw)aClears a range of pages. :param int offset: Start of byte range to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :param int length: Number of bytes to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512. :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 int if_sequence_number_lte: If the blob's sequence number is less than or equal to the specified value, the request proceeds; otherwise it fails. :keyword int if_sequence_number_lt: If the blob's sequence number is less than the specified value, the request proceeds; otherwise it fails. :keyword int if_sequence_number_eq: If the blob's sequence number is equal to the specified value, the request proceeds; otherwise it fails. :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: Blob-updated property dict (Etag and last modified). :rtype: dict(str, Any) Nrrr)rrr)rrrr=rrrrrrrrrxr clear_pagesrrK)r|rrrerrs r clear_pagezBlobClient.clear_page} s@  " "t'>'>'JEF F ::e !2!2!4!?XY Y%     )S#X(J (>(>(J(J(UW(UV V  ) !% ( ( )0AB11 C: C  Cc |js |jtt|j dr(|j j dk7r tdtd||d|} ttttf|jjjdi|S#t$r}t!|Yd}~yd}~wwxYw)aCommits a new block of data to the end of the existing append blob. :param data: Content of the block. This can be bytes, text, an iterable or a file-like object. :type data: bytes or str or Iterable :param int length: Size of the block in bytes. :keyword bool validate_content: If true, calculates an MD5 hash of the block content. 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. :keyword int maxsize_condition: Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). :keyword int appendpos_condition: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). :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 str encoding: Defaults to UTF-8. :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, last modified, append offset, committed block count). :rtype: dict(str, Any) Nrrr)rrr)rrrr=rrrrrrrrrxr append_blockrrK)r|rrrerrs rr`zBlobClient.append_block sf  " "t'>'>'JEF F ::e !2!2!4!?XY Y'     )S#X(M (@(@(M(M(XPW(XY Y  ) !% ( ( )r^copy_source_urlc |js |jtt|j dr(|j j dk7r tdtd|||d|} tttttttff|jjj di|S#t"$r}t%|Yd}~yd}~wwxYw)a Creates a new block to be committed as part of a blob, where the contents are read from a source url. :param str copy_source_url: The URL of the source data. It can point to any Azure Blob or File, that is either public or has a shared access signature attached. :param int source_offset: This indicates the start of the range of bytes (inclusive) that has to be taken from the copy source. :param int source_length: This indicates the end of the range of bytes that has to be taken from the copy source. :keyword bytearray source_content_md5: If given, the service will calculate the MD5 hash of the block content and compare against this value. :keyword int maxsize_condition: Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). :keyword int appendpos_condition: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). :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: 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 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 ~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 header to perform the operation only if the source resource has been modified since the specified 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 header to perform the operation only if the source resource 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 ~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 `__. :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. :returns: Result after appending a new block. :rtype: Dict[str, Union[str, datetime, int]] Nrrr)rar#r$r)rrrr=rrrrrrrrrintrxrappend_block_from_urlrrK)r|rar#r$rerrs rrdz BlobClient.append_block_from_url, sJ  " "t'>'>'JEF F ::e !2!2!4!?XY Y0 +''     )S%Xs(:";;<F 00FFQQS S  ) !% ( ( )s1AC C" CC"c ,|js |jttt di|} t t ttf|jjjdi|S#t$r}t|Yd}~yd}~wwxYw)aJ The Seal operation seals the Append Blob to make it read-only. .. versionadded:: 12.4.0 :keyword int appendpos_condition: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). :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 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, last modified, append offset, committed block count). :rtype: dict(str, Any) Nr)rrrr=r+rrrrrxrsealrrK)r|rerrs rseal_append_blobzBlobClient.seal_append_blob sT  " "t'>'>'JEF F+5f5 )S#X(E (@(@(E(E(P(PQ Q  ) !% ( ( )sAA55 B> BBcddlm}t|jjt s?t t |jj|jj}n |j}||jd|j|j|j|j|j||j|j|j |j"|j$|j& S)apGet a client to interact with the blob's parent container. The container need not already exist. Defaults to current blob's credentials. :returns: A ContainerClient. :rtype: ~azure.storage.blob.ContainerClient .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_containers.py :start-after: [START get_container_client_from_blob_client] :end-before: [END get_container_client_from_blob_client] :language: python :dedent: 8 :caption: Get container client from blob object. rrW) transportpoliciesz://) rard api_version_configurationrw_location_mode_hostsrrrr)_container_clientrXrnrw _transportrJr_impl_policiesrprimary_hostnamerarqrkryrmrnrrrr)r|rXrws r_get_container_clientz BlobClient._get_container_client s$ 7$..335EF *4>>+D+DE66I I{{m3t445 6tGZGZ++9I9IZ^ZfZf0C0CDKK#664KbKb#66dNhNh j jr)NNr)NNN)NF)N) committed)rfrX)M__name__ __module__ __qualname____doc__rr rrrrur# classmethodrrrrrrrD BLOCKBLOBbytesr rr rcrr r;rrGrrrrrrBrrrrrrrrr r rrr@rrr! bytearrayr'rr rAr+r/r1r5r9rArrErHrLrQrTrXrZr]r`rdrgrs __classcell__)rs@rr_r_\sYDR:>@D ++++5d38n!456 + U3S#X8QSgiz#z{| +  + +> C C @D9=+ + U3S#X8QSgiz#z{|+ 5d38n!456+  +  + + Z :>@D 8 8 8 8 5d38n!456 8 U3S#X8QSgiz#z{| 8  8  8 8 t ) )S#X ) ).2r)r)4S>*r) r) c3h r)r)h+3*<*< $-1 h-%hv&65 ABh-h'h- h-4S>* h-  h- c3h h-h-T&* $ sm       ! %   &* $   sm       ! '   &* $z2&* z2smz2 z2T " z2  z2 &s+-DU-KK L z2z2x`!3`!#`!/`!`!DO)HSMO)CO)TXO)O)b)c)d))@stB\C\N\\|0):K1L0)_b0)gkloqtltgu0)0)d37B) c3h0B)B) c5h'' (B)B)H K#7 K K c3h K KDV3V4VV,WWWc5QTV^`dQdKeFeAfWW29=-1NR h)h)"#45h)4S>*h)!)s4I/I)J K h)  h) c5h'' ( h)h)T>B-1[) (): ;[)4S>*[)[) c5h'' ( [)[)z37P) c3h0P)P) c5h'' (P)P)d.2!&@)@)4S>*@)@) @) c5h'' ( @)@)D)S$sCx..@A)) ))<:C:x}:_b:gv::x:)sDV?V9W:)cf:)ko:):)x!%?)?)E3 0"V*<=?) ?) ?) c3h ?)?)B(,'+@D ?)?)?) }?) } ?) %U5)+;%<= ?)  ?) c3h?)?)B%0).").). tIY/ 0).).V9=-1m)y/m)"#45m)4S>*m) m) c5h'' ( m)m)^&)AV&)be&)jn&)&)P.)(4S>":.)S.)UYZ]_bZbUc.).)`)c)d38n))B&* $GKS.smS. S.!)sDcN/B)C DS. S. tDcN#T$sCx.%99 : S.S.j!% $BF X0 X0 X0 $E#tCH~*=$>? X0  X0 9 X0X0t!%#J.%(J. J.}J. J. tDcN#T$sCx.%99 : J.J.X*.6)&+C1G,G&H6)!#6)6) c5h'' ( 6)6)p7)7)s7)tCsH}AU_generated.modelsr?_leaser@_modelsrArBrCrDrErF_quick_query_helperrG_shared.base_clientrHrIrJ_shared.response_handlersrKrL _serializerMrNrOrP_upload_helpersrQrRrSazure.core.credentialsrTrUrVazure.storage.blobrXrYrZr[r\r]r_rrrrs#__'(:@ /Y(&#cc0aaU  cc2V2j)+AV2jr