Share via

PipelineComponentBatchDeployment Class

Pipeline Component Batch Deployment entity.

Constructor

PipelineComponentBatchDeployment(*, name: str, endpoint_name: str | None = None, component: Component | str | None = None, settings: Dict[str, str] | None = None, job_definition: Dict[str, BaseNode] | None = None, tags: Dict | None = None, description: str | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the deployment resource.
description
Required
Optional[str]

Description of the deployment resource.
component
Required
Optional[Union[Component, str]]

Component definition.
settings
Required
Optional[Dict[str, Any]]

Run-time settings for the pipeline job.
tags
Required
Optional[Dict[str, Any]]

A set of tags. The tags which will be applied to the job.
job_definition
Required
Optional[Dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]]

Arm ID or PipelineJob entity of an existing pipeline job.
endpoint_name
Required
Optional[str]

Name of the Endpoint resource, defaults to None.

Keyword-Only Parameters

Name Description
name
Required
endpoint_name
Default value: None
component
Default value: None
settings
Default value: None
job_definition
Default value: None
tags
Default value: None
description
Default value: 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.

instance_count

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