ABFS
Any Azure Blob Storage specific configuration.
Attributes
| Attribute | Type | Description |
|---|---|---|
| account_name | a storage account name string = null | The name of the Azure Storage account used for authentication and to identify the storage resource. |
| account_key | an account access key string = null | The access key for the Azure Storage account used to authorize requests via shared key authentication. |
| tenant_id | a UUID string = null | The Azure Active Directory tenant ID used for service principal authentication. |
| client_id | a UUID string = null | The application ID of the service principal used to authenticate with Azure Active Directory. |
| client_secret | a client secret string = null | The 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
| Name | Type | Description |
|---|---|---|
| account_name | typing.Optional[str] = None | The name of the Azure Storage account. |
| account_key | typing.Optional[str] = None | The access key for the Azure Storage account. |
| tenant_id | typing.Optional[str] = None | The Azure Active Directory tenant ID for service principal authentication. |
| client_id | typing.Optional[str] = None | The client ID for service principal authentication. |
| client_secret | typing.Optional[str] = None | The 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
| Type | Description |
|---|---|
[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
| Name | Type | Description |
|---|---|---|
| anonymous | bool = False | Whether to connect without authentication; if True, credentials will be ignored. |
| kwargs | Any | Additional keyword arguments to be merged into the final fsspec configuration dictionary. |
Returns
| Type | Description |
|---|---|
Dict[str, Any] | A dictionary containing connection arguments and a nested 'config' mapping for Azure authentication. |