Share via

AzureFileDatastore Class

  • Reference

Azure file share that is linked to an Azure ML workspace.

Inheritance
azure.ai.ml.entities._datastore.datastore.Datastore
AzureFileDatastore

Constructor

AzureFileDatastore(*, name: str, account_name: str, file_share_name: str, description: str | None = None, tags: Dict | None = None, endpoint: str = 'core.windows.net', protocol: str = 'https', properties: Dict | None = None, credentials: AccountKeyConfiguration | SasTokenConfiguration | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the datastore.
account_name
Required
str

Name of the Azure storage account.
file_share_name
Required
str

Name of the file share.
description
Required
str

Description of the resource.
tags
Required
dict[str, str]

Tag dictionary. Tags can be added, removed, and updated.
endpoint
Required
str

Endpoint to use to connect with the Azure storage account
protocol
Required
str

Protocol to use to connect with the Azure storage account
properties
Required
dict[str, str]

The asset property dictionary.
credentials
Required
Union[AccountKeyConfiguration, SasTokenConfiguration]

Credentials to use for Azure ML workspace to connect to the storage. Defaults to None.
kwargs
Required
dict

A dictionary of additional configuration parameters.

Keyword-Only Parameters

Name Description
name
Required
account_name
Required
file_share_name
Required
description
Required
tags
Required
endpoint
Default value: core.windows.net
protocol
Default value: https
properties
Required
credentials
Required

Methods

dump

Dump the datastore content into a file in yaml format.

dump

Dump the datastore content into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

The destination to receive this datastore's content. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

type