TextBase64EncodePolicy Class

  • Reference

Base 64 message encoding policy for text messages.

Encodes text (unicode) messages to base 64. If the input content is not text, a TypeError will be raised. Input text must support UTF-8.

Inheritance
azure.storage.queue._message_encoding.MessageEncodePolicy
TextBase64EncodePolicy

Constructor

TextBase64EncodePolicy()

Methods

configure
encode

configure 

configure(require_encryption: bool, key_encryption_key: KeyEncryptionKey | None, resolver: Callable[[str], KeyEncryptionKey] | None, encryption_version: str = '1.0') -> None

Parameters

Name Description
require_encryption
Required
key_encryption_key
Required
resolver
Required
encryption_version
Default value: 1.0

encode 

encode(content: str) -> str

Parameters

Name Description
content
Required

Attributes

encryption_version

Indicates the version of encryption being used.

encryption_version: str

key_encryption_key

The user-provided key-encryption-key.

key_encryption_key: KeyEncryptionKey | None

require_encryption

Indicates whether encryption is required or not.

require_encryption: bool

resolver

The user-provided key resolver.

resolver: Callable[[str], KeyEncryptionKey] | None