PipelineEndpoint Class

Reference

Represents a Pipeline workflow that can be triggered from a unique endpoint URL.

PipelineEndpoints can be used to create new versions of a PublishedPipeline while maintaining the same endpoint. PipelineEndpoints are uniquely named within a workspace.

Using the endpoint attribute of a PipelineEndpoint object, you can trigger new pipeline runs from external applications with REST calls. For information about how to authenticate when calling REST endpoints, see https://aka.ms/pl-restep-auth.

For more information about creating and running machine learning pipelines, see https://aka.ms/pl-first-pipeline.

Initialize PipelineEndpoint.

Inheritance: builtins.object

PipelineEndpoint

Constructor

PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)

Parameters

Name	Description
workspace Required	Workspace The workspace the PipelineEndpoint is defined in.
id Required	str The ID of the PipelineEndpoint.
name Required	str The name of the PipelineEndpoint.
description Required	str The description of the PipelineEndpoint.
status Required	str The new status of the PipelineEndpoint: 'Active' or 'Disabled'.
default_version Required	str The default version of pipeline in PipelineEndpoint, auto-increments, starts with "0".
endpoint Required	str The REST endpoint URL for the PipelineEndpoint, which can be used to submit pipeline runs.
pipeline_version_list Required	list The list of PipelineIdVersion objects.
_pipeline_endpoint_provider Required	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> The PipelineEndpoint provider.
_pipeline_endpoint_provider Required	The PublishedPipeline provider.
workspace Required	Workspace The workspace object this PipelineEndpoint will belong to.
id Required	str The ID of the PipelineEndpoint.
name Required	str The name of the PipelineEndpoint.
description Required	str The description of the PipelineEndpoint.
status Required	str The new status of the PipelineEndpoint: 'Active' or 'Disabled'.
default_version Required	str The default version of pipeline in PipelineEndpoint, auto-increments, starts with "0"
endpoint Required	str The REST endpoint URL for PipelineEndpoint to submit pipeline runs.
pipeline_version_list Required	list The list of PipelineIdVersion
_pipeline_endpoint_provider Required	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> The PipelineEndpoint provider.
_pipeline_endpoint_provider Required	The PublishedPipeline provider.
swaggerendpoint Required	The Swagger REST endpoint URL for PipelineEndpoint to submit pipeline runs.

Remarks

A PipelineEndpoint can be created from either a Pipeline or a PublishedPipeline.

An example to publish from a Pipeline or PublishedPipeline is as follows:


   from azureml.pipeline.core import PipelineEndpoint

   # The pipeline argument can be either a Pipeline or a PublishedPipeline
   pipeline_endpoint = PipelineEndpoint.publish(workspace=ws,
                                                name="PipelineEndpointName",
                                                pipeline=pipeline,
                                                description="New Pipeline Endpoint")

Submit a PipelineEndpoint using submit. When submit is called, a PipelineRun is created which in turn creates StepRun objects for each step in the workflow.

An example of how to submit a PipelineEndpoint is as follows:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint)

There are a number of optional settings that can be specified when submitting a PipelineEndpoint. These include:

pipeline_parameters: Parameters to pipeline execution, dictionary of {name: value}. See PipelineParameter for more details.
parent_run_id: You can supply a run ID to set the parent run of this pipeline run, which is reflected in RunHistory. The parent run must belong to the same experiment as the one this pipeline is being submitted to.
pipeline_version: The pipeline version to run.

An example to submit a PipelineEndpoint using these settings is as follows:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>",
                                    pipeline_version="0")

To add a new version of a PipelineEndpoint use:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_endpoint.add(published_pipeline)

See the following notebook for additional information on creating and using PipelineEndpoints: https://aka.ms/pl-ver-endpoint.

Methods

add	Add the specified pipeline to PipelineEndpoint.
add_default	Add the specified pipeline to PipelineEndpoint and set default version to added pipeline version.
archive	Archive the PipelineEndpoint.
disable	Set the PipelineEndpoint to 'Disabled' and unavailable to run.
enable	Set the PipelineEndpoint to 'Active' and available to run.
get	Get the PipelineEndpoint by name or ID, throws exception if either is not provided.
get_all	Get all active PipelineEndpoints in the current workspace. Get all active PipelineEndpoints. NOTE: This method is being deprecated in favor of PipelineEndpoint.list().
get_all_pipelines	Get list of pipelines in PipelineEndpoint. NOTE: This method is being deprecated in favor of list_pipelines()
get_all_versions	Get list of pipelines and corresponding versions in PipelineEndpoint. NOTE: This method is being deprecated in favor of list_versions()
get_default_version	Get the default version of PipelineEndpoint.
get_pipeline	Get the pipeline of a specified version or the default; throws an exception if the version is not found.
list	List active PipelineEndpoints in the current workspace.
list_pipelines	Get a list of pipelines associated with the PipelineEndpoint.
list_versions	Get a list of pipelines and corresponding versions of the PipelineEndpoint.
publish	Create a PipelineEndpoint with the specified name and pipeline/published pipeline. The pipeline endpoint is a REST API that can be used from external applications. For information about how to authenticate when calling REST endpoints, see https://aka.ms/pl-restep-auth. For more information about working with pipeline endpoints, see https://aka.ms/pl-first-pipeline. Throws Exception if a PipelineEndpoint with the given name already exists.
reactivate	Reactivate a PipelineEndpoint that was archived.
set_default	Set the default version of PipelineEndpoint, throws an exception if the specified pipeline is not found.
set_default_version	Set the default version of PipelineEndpoint, throws an exception if the specified version is not found.
set_name	Set the name of PipelineEndpoint.
submit	Submit a pipeline experiment of given version; if version is none triggers default version of the pipeline.

add

Add the specified pipeline to PipelineEndpoint.

add(pipeline)

Parameters

Name	Description
pipeline Required	PublishedPipeline A published pipeline to add.

add_default

Add the specified pipeline to PipelineEndpoint and set default version to added pipeline version.

add_default(pipeline)

Parameters

Name	Description
pipeline Required	PublishedPipeline A published pipeline to add as the default version.

disable

Set the PipelineEndpoint to 'Disabled' and unavailable to run.

disable()

enable

Set the PipelineEndpoint to 'Active' and available to run.

enable()

get

Get the PipelineEndpoint by name or ID, throws exception if either is not provided.

static get(workspace, id=None, name=None, _workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
workspace Required	Workspace The workspace the PipelineEndpoint was created in.
id	str The ID of the PipelineEndpoint. default value: None
name	str The name of the PipelineEndpoint. default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
PipelineEndpoint	The PipelineEndpoint object.

get_all

Get all active PipelineEndpoints in the current workspace.

Get all active PipelineEndpoints. NOTE: This method is being deprecated in favor of PipelineEndpoint.list().

static get_all(workspace, active_only=True, _workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
workspace Required	Workspace The workspace.
active_only	bool If true, only return PipelineEndpoints which are currently active. default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
list	The list of PipelineEndpoint objects.

get_all_pipelines

Get list of pipelines in PipelineEndpoint.

NOTE: This method is being deprecated in favor of list_pipelines()

get_all_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
active_only	bool Flag to return active only pipelines. default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
list	The list of PublishedPipeline objects.

get_all_versions

Get list of pipelines and corresponding versions in PipelineEndpoint.

NOTE: This method is being deprecated in favor of list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
list	The list of PipelineVersion objects.

get_default_version

Get the default version of PipelineEndpoint.

get_default_version()

Returns

Type	Description
str	The default version of the pipeline endpoint.

get_pipeline

Get the pipeline of a specified version or the default; throws an exception if the version is not found.

get_pipeline(version=None)

Parameters

Name	Description
version	str The version of the pipeline to return. default value: None

Returns

Type	Description
PublishedPipeline	A published pipeline.

list

List active PipelineEndpoints in the current workspace.

static list(workspace, active_only=True, max_results=100, _workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
workspace Required	Workspace The workspace.
active_only	bool If true, only return PipelineEndpoints which are currently active. default value: True
max_results	int max lines of returned PipelineEndpoints default value: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
list	The list of PipelineEndpoint objects.

list_pipelines

Get a list of pipelines associated with the PipelineEndpoint.

list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
active_only	bool Indicates whether to return only active pipelines. default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
list	The list of PublishedPipeline objects.

list_versions

Get a list of pipelines and corresponding versions of the PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None
_service_endpoint	str The service endpoint. default value: None

Returns

Type	Description
list	The list of PipelineVersion objects.

publish

Create a PipelineEndpoint with the specified name and pipeline/published pipeline.

The pipeline endpoint is a REST API that can be used from external applications. For information about how to authenticate when calling REST endpoints, see https://aka.ms/pl-restep-auth.

For more information about working with pipeline endpoints, see https://aka.ms/pl-first-pipeline.

Throws Exception if a PipelineEndpoint with the given name already exists.

static publish(workspace, name, description, pipeline, _workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
workspace Required	Workspace The workspace to create the PipelineEndpoint in.
name Required	str The name of the PipelineEndpoint.
description Required	str The description of the PipelineEndpoint.
pipeline Required	PublishedPipeline or Pipeline The published pipeline or pipeline.
_service_endpoint	str The service endpoint. default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> The workflow provider. default value: None

Returns

Type	Description
PipelineEndpoint	A new PipelineEndpoint.

Exceptions

Type	Description
ValueError

reactivate

Reactivate a PipelineEndpoint that was archived.

reactivate(name)

Parameters

Name	Description
name Required	str The name to set.

Returns

Type	Description
PipelineEndpoint	A PipelineEndpoint object.

set_default

Set the default version of PipelineEndpoint, throws an exception if the specified pipeline is not found.

set_default(pipeline)

Parameters

Name	Description
pipeline Required	PublishedPipeline The published pipeline to set as the default.

Exceptions

Type	Description
ValueError

set_default_version

Set the default version of PipelineEndpoint, throws an exception if the specified version is not found.

set_default_version(version)

Parameters

Name	Description
version Required	str The version to set as the default version in PipelineEndpoint.

Exceptions

Type	Description
ValueError

set_name

Set the name of PipelineEndpoint.

set_name(name)

Parameters

Name	Description
name Required	str The name to set.

submit

Submit a pipeline experiment of given version; if version is none triggers default version of the pipeline.

submit(experiment_name, pipeline_parameters=None, parent_run_id=None, pipeline_version=None)

Parameters

Name	Description
experiment_name Required	str The name of the experiment to submit the pipeline in.
pipeline_parameters	dict Parameters to use in pipeline execution, passed as a dictionary of {name: value}. See PipelineParameter for more details. default value: None
parent_run_id	str You can supply a run ID to set the parent run of this pipeline run, which is reflected in RunHistory. The parent run must belong to the same experiment as this pipeline is being submitted to. default value: None
pipeline_version	str The version of pipeline to run. default value: None

Returns

Type	Description
PipelineRun	The submitted pipeline run.

Exceptions

Type	Description
ValueError

Attributes

default_version

Get the default version of the PipelineEndpoint.

Returns

Type	Description
str	The default version.

description

Get the description of the PipelineEndpoint.

Returns

Type	Description
str	The description.

endpoint

Get the REST endpoint URL of the PipelineEndpoint.

The endpoint can be used to trigger runs of the pipeline.

Returns

Type	Description
str	REST endpoint for PipelineEndpoint to run pipeline.

id

Get the ID of the PipelineEndpoint.

Returns

Type	Description
str	The ID of the PipelineEndpoint.

name

Get the name of the PipelineEndpoint.

Returns

Type	Description
str	The name.

pipeline_version_list

Get the pipeline version list.

Returns

Type	Description
list	The list of PipelineIdVersion objects.

status

Get the status of the PipelineEndpoint.

Returns

Type	Description
str	The status.

swaggerurl

Get the REST Swagger URL of the PipelineEndpoint.

The Swagger url can be view schema of the pipeline endpoint.

Returns

Type	Description
str	REST Swagger for PipelineEndpoint to run pipeline.

PipelineEndpoint Class

Constructor

Parameters

Remarks

Methods

add

Parameters

add_default

Parameters

archive

disable

enable

get

Parameters

Returns

get_all

Parameters

Returns

get_all_pipelines

Parameters

Returns

get_all_versions

Parameters

Returns

get_default_version

Returns

get_pipeline

Parameters

Returns

list

Parameters

Returns

list_pipelines

Parameters

Returns

list_versions

Parameters

Returns

publish

Parameters

Returns

Exceptions

reactivate

Parameters

Returns

set_default

Parameters

Exceptions

set_default_version

Parameters

Exceptions

set_name

Parameters

submit

Parameters

Returns

Exceptions

Attributes

default_version

Returns

description

Returns

endpoint

Returns

id

Returns

name

Returns

pipeline_version_list

Returns

status

Returns

swaggerurl

Returns

Feedback

Feedback

Additional resources