Skip to main content

ABFS

Any Azure Blob Storage specific configuration.

Attributes

AttributeTypeDescription
account_nametyping.Optional[str] = NoneThe Azure Storage account name used for authentication and accessing blob storage.
account_keytyping.Optional[str] = NoneThe Azure Storage account key used for shared key authentication.
tenant_idtyping.Optional[str] = NoneThe Azure Active Directory tenant ID for OAuth authentication.
client_idtyping.Optional[str] = NoneThe Azure Active Directory client ID for OAuth authentication.
client_secrettyping.Optional[str] = NoneThe Azure Active Directory client secret for OAuth authentication.

Methods


auto()

@classmethod
def auto() - > [ABFS](abfs.md?sid=flyte_storage__config_abfs)

Creates an ABFS instance by automatically loading configuration from environment variables. This method checks for specific environment variables like AZURE_STORAGE_ACCOUNT_NAME, AZURE_STORAGE_ACCOUNT_KEY, AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET to populate the ABFS object's attributes.

Returns

TypeDescription
[ABFS](abfs.md?sid=flyte_storage__config_abfs)An ABFS object configured with values found in environment variables.

get_fsspec_kwargs()

@classmethod
def get_fsspec_kwargs(
anonymous: bool = False,
kwargs: Any
) - > typing.Dict[str, typing.Any]

Generates a dictionary of keyword arguments suitable for fsspec to connect to Azure Blob Storage. This method combines the instance's configuration with any provided keyword arguments, prioritizing the latter, to construct the necessary authentication and connection parameters.

Parameters

NameTypeDescription
anonymousbool = FalseA boolean indicating whether to connect anonymously to Azure Blob Storage. If true, authentication details will be omitted.
kwargsAnyAdditional keyword arguments to be passed to fsspec, which can override or supplement the instance's configuration.

Returns

TypeDescription
typing.Dict[str, typing.Any]A dictionary of keyword arguments for fsspec to use when connecting to Azure Blob Storage.