ModelBatchDeployment Class

Note

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

Job Definition entity.

Inheritance

azure.ai.ml.entities._deployment.deployment.Deployment

ModelBatchDeployment

Constructor

ModelBatchDeployment(*, name: str | None, endpoint_name: str | None = None, environment: str | Environment | None = None, properties: Dict[str, str] | None = None, model: str | Model | None = None, description: str | None = None, tags: Dict[str, Any] | None = None, settings: ModelBatchDeploymentSettings | None = None, resources: ResourceConfiguration | None = None, compute: str | None = None, code_configuration: CodeConfiguration | None = None, code_path: PathLike | str | None = None, scoring_script: PathLike | str | None = None, **kwargs: Any)

Parameters

Name	Description
type Required	str Job definition type. Allowed value is: pipeline
name Required	str Job name
job Required	Union[Job, str] Job definition
component Required	Union[Component, str] Component definition
settings Required	Dict[str, Any] Job settings
description Required	str Job description.
tags Required	Dict[str, Any] Job tags
properties Required	dict[str, str] The asset property dictionary.

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.

provisioning_state

Batch deployment provisioning state, readonly.

Returns

Type	Description
Optional[str]	Batch deployment provisioning state.

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