utils Package

This utils module provides functionality that is intended to be used by developers building on top of azure-core.

Functions

case_insensitive_dict

Return a case-insensitive mutable mapping from an inputted mapping structure.

case_insensitive_dict(*args: Any, **kwargs: Any) -> MutableMapping

Returns

A case-insensitive mutable mapping object.

Return type

parse_connection_string

Parses the connection string into a dict of its component parts, with the option of preserving case of keys, and validates that each key in the connection string has a provided value. If case of keys is not preserved (ie. case_sensitive_keys=False), then a dict with LOWERCASE KEYS will be returned.

parse_connection_string(conn_str: str, case_sensitive_keys: bool = False) -> Mapping[str, str]

Parameters

conn_str
str
Required

String with connection details provided by Azure services.

case_sensitive_keys
bool
default value: False

Indicates whether the casing of the keys will be preserved. When False(the default), all keys will be lower-cased. If set to True, the original casing of the keys will be preserved.

Return type

<xref:Mapping>

Exceptions

<xref:for other bad formatting of connection strings - including duplicateargs>, <xref:bad syntax>, <xref:etc.>