Class TokenCachePersistenceOptions

web/pgacloud/utils/azure_cache.py:18–59

Options for persistent token caching. Most credentials accept an instance of this class to configure persistent token caching. The default values configure a credential to use a cache shared with Microsoft developer tools and :class:`~azure.identity.SharedTokenCacheCredential`.

class TokenCachePersistenceOptions():
    """Options for persistent token caching.

    Most credentials accept an instance of this class to configure persistent
    token caching. The default values configure a credential to use a cache
    shared with Microsoft developer tools and
    :class:`~azure.identity.SharedTokenCacheCredential`.
    To isolate a credential's data from other applications,
    specify a `name` for the cache.

    By default, the cache is encrypted with the current platform's user data
    protection API, and will raise an error when this is not available.
    To configure the cache to fall back to an unencrypted file instead
    of raising an error, specify `allow_unencrypted_storage=True`.

    .. warning:: The cache contains authentication secrets. If the cache is
     not encrypted, protecting it is the application's responsibility.
     A breach of its contents will fully compromise accounts.

        .. literalinclude:: ../tests/test_persistent_cache.py
            :start-after: [START snippet]
            :end-before: [END snippet]
            :language: python
            :caption: Configuring a credential for persistent caching
            :dedent: 8

    :keyword str name: name of the cache, used to isolate its data from other
        applications. Defaults to the name of the cache shared by Microsoft
        dev tools and :class:`~azure.identity.SharedTokenCacheCredential`.
    :keyword bool allow_unencrypted_storage: whether the cache should fall
        back to storing its data in plain text when
        encryption isn't possible. False by default. Setting this to
        True does not disable encryption. The cache will
        always try to encrypt its data.
    """

    def __init__(self, **kwargs):
        # type: (**Any) -> None
        self.allow_unencrypted_storage = \
            kwargs.get("allow_unencrypted_storage", False)
        self.name = kwargs.get("name", "msal.cache")
        self.cache_location = kwargs.get("cache_location", None)


def load_persistent_cache(options):