DataImport Class

Note

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

Data asset with a creating data import job.

Inheritance
azure.ai.ml.entities._assets._artifacts.data.Data
DataImport

Constructor

DataImport(*, name: str, path: str, source: Database | FileSystem, version: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the asset.

path
Required
str

The path to the asset being created by data import job.

source
Required

The source of the asset data being copied from.

version
Required
str

Version of the resource.

description
Required
str

Description of the resource.

tags
Required

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

properties
Required

The asset property dictionary.

kwargs
Required

A dictionary of additional configuration parameters.

Methods

dump

Dump the asset content into a file in YAML format.

dump

Dump the asset 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 local path or file stream to write the YAML content to. If dest is a file path, a new file will be created. If dest is an open file, the file will be written to directly.

Exceptions

Type Description

Raised if dest is a file path and the file already exists.

Raised if dest is an open file and 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

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description

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

path

version

The asset version.

Returns

Type Description
str

The asset version.