Skip to main content

ABFS

Any Azure Blob Storage specific configuration.

Attributes​

AttributeTypeDescription
account_namea storage account name string = nullThe name of the Azure Storage account used for authentication and to identify the storage resource.
account_keyan account access key string = nullThe access key for the Azure Storage account used to authorize requests via shared key authentication.
tenant_ida UUID string = nullThe Azure Active Directory tenant ID used for service principal authentication.
client_ida UUID string = nullThe application ID of the service principal used to authenticate with Azure Active Directory.
client_secreta client secret string = nullThe password or secret associated with the service principal client ID for secure authentication.

Constructor​

Signature​

def ABFS(
account_name: typing.Optional[str] = None,
account_key: typing.Optional[str] = None,
tenant_id: typing.Optional[str] = None,
client_id: typing.Optional[str] = None,
client_secret: typing.Optional[str] = None
) -> null

Parameters​

NameTypeDescription
account_nametyping.Optional[str] = NoneThe name of the Azure Storage account.
account_keytyping.Optional[str] = NoneThe access key for the Azure Storage account.
tenant_idtyping.Optional[str] = NoneThe Azure Active Directory tenant ID for service principal authentication.
client_idtyping.Optional[str] = NoneThe client ID for service principal authentication.
client_secrettyping.Optional[str] = NoneThe client secret for service principal authentication.

Methods​


auto()​

@classmethod
def auto(cls) -> ABFS: ...

Creates an ABFS instance by automatically retrieving credentials from environment variables. This method searches for standard Azure environment variables like AZURE_STORAGE_ACCOUNT_NAME and AZURE_STORAGE_ACCOUNT_KEY to configure the storage connection.

Returns​

TypeDescription
[ABFS](abfs.md?sid=flyte_storage__config_abfs)A new ABFS instance populated with credentials found in the environment.

get_fsspec_kwargs()​

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

Constructs a dictionary of configuration parameters compatible with fsspec-based Azure Blob Storage filesystems. It merges instance-level credentials with provided overrides into a nested configuration structure required by the underlying driver.

Parameters​

NameTypeDescription
anonymousbool = FalseWhether to connect without authentication; if True, credentials will be ignored.
kwargsAnyAdditional keyword arguments to be merged into the final fsspec configuration dictionary.

Returns​

TypeDescription
Dict[str, Any]A dictionary containing connection arguments and a nested 'config' mapping for Azure authentication.