atoti.config.azure module

class atoti.config.azure.AzureClientSideEncryptionConfig(key_pair)

The client side encryption configuration to use when loading data from Azure.

key_pair: atoti.config.azure.AzureKeyPair

class atoti.config.azure.AzureConfig(client_side_encryption=None)

The Azure configuration.

Note

This requires the atoti-azure plugin.

client_side_encryption: Optional[atoti.config.azure.AzureClientSideEncryptionConfig] = None

class atoti.config.azure.AzureKeyPair(public_key, private_key, key_id)

The key pair to use for client side encryption.

Warning

Each encrypted blob must have the metadata attribute unencrypted_content_length with the unencrypted file size. If this is not set, an Issue while downloading error will occur.

Example

>>> config = {
...     "azure": {
...         "client_side_encryption": {
...             "key_pair": {
...                 "key_id": "some key ID",
...                 "public_key": "some public key",
...                 "private_key": "some private key",
...             }
...         }
...     }
... }

key_id: str

The ID of the key used to encrypt the blob.

private_key: str

The private key.

public_key: str

The public key.