msticpy.common.provider_settings module

Helper functions for configuration settings.

class msticpy.common.provider_settings.ProviderArgs(dict=None, /, **kwargs)

Bases: UserDict

ProviderArgs dictionary.

clear() None.  Remove all items from D.
copy()
classmethod fromkeys(iterable, value=None)
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
class msticpy.common.provider_settings.ProviderSettings(name: str, description: str, provider: Optional[str] = None, args: ProviderArgs = NOTHING, primary: bool = False)

Bases: object

Provider settings.

Method generated by attrs for class ProviderSettings.

args: ProviderArgs
description: str
name: str
primary: bool
provider: Optional[str]
msticpy.common.provider_settings.clear_keyring()

Delete local keyring secrets cache.

msticpy.common.provider_settings.get_provider_settings(config_section='TIProviders') Dict[str, ProviderSettings]

Read Provider settings from package config.

Parameters

config_section (str, optional) – [description], by default “TIProviders”

Returns

Provider settings indexed by provider name.

Return type

Dict[str, ProviderSettings]

msticpy.common.provider_settings.refresh_keyring()

Refresh local keyring secrets cache from Key Vault.

msticpy.common.provider_settings.reload_settings()

Reload settings from config files.