PipelineComponentBatchDeployment Class

Note

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

Pipeline Component Batch Deployment entity.

Inheritance

azure.ai.ml.entities._resource.Resource

PipelineComponentBatchDeployment

Constructor

PipelineComponentBatchDeployment(*, name: str | None, 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
type Required	Optional[str] Job definition type. Allowed value: "pipeline"
name Required	Optional[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.

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.

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.