OneLakeDatastore Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

OneLake datastore that is linked to an Azure ML workspace.

Constructor

OneLakeDatastore(*, name: str, artifact: OneLakeArtifact, one_lake_workspace_name: str, endpoint: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, credentials: NoneCredentialConfiguration | ServicePrincipalConfiguration | None = None, **kwargs: Any)

Parameters

Name Description
kwargs
Required
dict

A dictionary of additional configuration parameters.

Keyword-Only Parameters

Name Description
name
str

Name of the datastore.
artifact
OneLakeArtifact

OneLake Artifact. Only LakeHouse artifacts are currently supported.
one_lake_workspace_name
str

OneLake workspace name/GUID. ex) 01234567-abcd-1234-5678-012345678901
endpoint
str

OneLake endpoint to use for the datastore. ex) https://onelake.dfs.fabric.microsoft.com

Default value: None
description
str

Description of the resource.

Default value: None
tags
dict[str, str]

Tag dictionary. Tags can be added, removed, and updated.

Default value: None
properties
dict[str, str]

The asset property dictionary.

Default value: None
credentials
Union[ ServicePrincipalConfiguration, NoneCredentialConfiguration]

Credentials to use to authenticate against OneLake.

Default value: None

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