Deployment Class

Endpoint Deployment base class.

Endpoint Deployment base class.

Constructor of Endpoint Deployment base class.

Inheritance

azure.ai.ml.entities._resource.Resource

Deployment

azure.ai.ml.entities._mixins.RestTranslatableMixin

Deployment

Constructor

Deployment(name: str | None = None, *, endpoint_name: str | None = None, description: str | None = None, tags: Dict[str, Any] | None = None, properties: Dict[str, Any] | None = None, model: str | Model | None = None, code_configuration: CodeConfiguration | None = None, environment: str | Environment | None = None, environment_variables: Dict[str, str] | None = None, code_path: PathLike | str | None = None, scoring_script: PathLike | str | None = None, **kwargs: Any)

Parameters

Name	Description
name	Optional[str] Name of the deployment resource, defaults to None default value: None
name Required	Optional[str] Name of the deployment resource, defaults to None

Keyword-Only Parameters

Name	Description
endpoint_name	Optional[str] Name of the Endpoint resource, defaults to None
description	Optional[str] Description of the deployment resource, defaults to None
tags	Optional[Dict[str, Any]] Tag dictionary. Tags can be added, removed, and updated, defaults to None
properties	Optional[Dict[str, Any]] The asset property dictionary, defaults to None
model	Optional[Union[str, Model]] The Model entity, defaults to None
code_configuration	Optional[CodeConfiguration] Code Configuration, defaults to None
environment	Optional[Union[str, Environment]] The Environment entity, defaults to None
environment_variables	Optional[Dict[str, str]] Environment variables that will be set in deployment, defaults to None
code_path	Optional[Union[str, <xref:PathLike>]] Folder path to local code assets. Equivalent to code_configuration.code.path , defaults to None
scoring_script	Optional[Union[str, <xref:PathLike>]] Scoring script name. Equivalent to code_configuration.code.scoring_script , defaults to None
endpoint_name	Optional[str] Name of the Endpoint resource, defaults to None
description	Optional[str] Description of the deployment resource, defaults to None
tags	Optional[Dict[str, Any]] Tag dictionary. Tags can be added, removed, and updated, defaults to None
properties	Optional[Dict[str, Any]] The asset property dictionary, defaults to None
model	Optional[Union[str, Model]] The Model entity, defaults to None
code_configuration	Optional[CodeConfiguration] Code Configuration, defaults to None
environment	Optional[Union[str, Environment]] The Environment entity, defaults to None
environment_variables	Optional[Dict[str, str]] Environment variables that will be set in deployment, defaults to None
code_path	Optional[Union[str, <xref:PathLike>]] Folder path to local code assets. Equivalent to code_configuration.code.path , defaults to None
scoring_script	Optional[Union[str, <xref:PathLike>]] Scoring script name. Equivalent to code_configuration.code.scoring_script , defaults to None

Methods

dump	Dump the deployment content into a file in yaml format.

dump

Dump the deployment content into a file in yaml format.

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

Parameters

Name	Description
dest Required	Union[PathLike, str, IO[AnyStr]] The destination to receive this deployment'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.

code_path

The code directory containing the scoring script.

Returns

Type	Description
Union[str, <xref:PathLike>]

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.

scoring_script

The scoring script file path relative to the code directory.

Returns

Type	Description
Union[str, <xref:PathLike>]

type

Type of deployment.

Returns

Type	Description
str