Datastore Class

Datastore of an Azure ML workspace, abstract class.

Inheritance

azure.ai.ml.entities._resource.Resource

Datastore

azure.ai.ml.entities._mixins.RestTranslatableMixin

Datastore

ABC

Datastore

Constructor

Datastore(credentials: ServicePrincipalConfiguration | CertificateConfiguration | NoneCredentialConfiguration | AccountKeyConfiguration | SasTokenConfiguration | None, name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs: Any)

Parameters

Name	Description
name	str Name of the datastore. Default value: None
description	str Description of the resource. Default value: None
credentials Required	Credentials to use for Azure ML workspace to connect to the storage.
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
kwargs Required	dict A dictionary of additional configuration parameters.

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