PipelineEndpoint 类

表示可从唯一 Pipeline 终结点 URL 触发的工作流。

PipelineEndpoints 可用于创建新版本，同时维护同一 PublishedPipeline 终结点。 PipelineEndpoints 在工作区中唯一命名。

使用 PipelineEndpoint 对象的终结点属性，可以使用 REST 调用从外部应用程序触发新的管道运行。有关如何在调用 REST 终结点时进行身份验证的信息，请参阅 https://aka.ms/pl-restep-auth。

有关创建和运行机器学习管道的详细信息，请参阅 https://aka.ms/pl-first-pipeline。

初始化 PipelineEndpoint。

构造函数

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

参数

名称	说明
workspace 必需	Workspace PipelineEndpoint 中定义的工作区。
id 必需	str PipelineEndpoint 的 ID。
name 必需	str PipelineEndpoint 的名称。
description 必需	str PipelineEndpoint 的说明。
status 必需	str PipelineEndpoint 的新状态：“Active”或“Disabled”。
default_version 必需	str PipelineEndpoint 中管道的默认版本（自动递增）以“0”开头。
endpoint 必需	str PipelineEndpoint 的 REST 终结点 URL，可用于提交管道运行。
pipeline_version_list 必需	list 对象列表 PipelineIdVersion 。
_pipeline_endpoint_provider 必需	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> PipelineEndpoint 提供程序。
_pipeline_endpoint_provider 必需	PublishedPipeline 提供程序。
workspace 必需	Workspace 此 PipelineEndpoint 所属的工作区对象。
id 必需	str PipelineEndpoint 的 ID。
name 必需	str PipelineEndpoint 的名称。
description 必需	str PipelineEndpoint 的说明。
status 必需	str PipelineEndpoint 的新状态：“Active”或“Disabled”。
default_version 必需	str PipelineEndpoint 中管道的默认版本（自动递增）以“0”开头
endpoint 必需	str 用于提交管道运行的 PipelineEndpoint 的 REST 终结点 URL。
pipeline_version_list 必需	list 列表 PipelineIdVersion
_pipeline_endpoint_provider 必需	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> PipelineEndpoint 提供程序。
_pipeline_endpoint_provider 必需	PublishedPipeline 提供程序。
swaggerendpoint 必需	PipelineEndpoint 用于提交管道运行的 Swagger REST 终结点 URL。

注解

可以从一个或一个 Pipeline PublishedPipeline. 创建 PipelineEndpoint。

从管道或 PublishPipeline 发布的示例如下所示：


   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.. 提交 PipelineEndpoint。调用提交时，将创建一个 PipelineRun ，进而为工作流中的每个步骤创建 StepRun 对象。

如何提交 PipelineEndpoint 的示例如下所示：


   from azureml.pipeline.core import PipelineEndpoint

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

提交 PipelineEndpoint 时可以指定许多可选设置。这些包括：

pipeline_parameters：管道执行的参数，{name： value} 的字典。有关详细信息，请参阅 PipelineParameter。
parent_run_id：可以提供运行 ID 来设置此管道运行的父运行，该运行反映在 RunHistory 中。父运行必须与提交此管道的试验属于同一试验。
pipeline_version：要运行的管道版本。

使用以下设置提交 PipelineEndpoint 的示例如下所示：


   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")

若要添加新版本的 PipelineEndpoint，请使用：


   from azureml.pipeline.core import PipelineEndpoint

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

有关创建和使用 PipelineEndpoints 的其他信息，请参阅以下笔记本： https://aka.ms/pl-ver-endpoint

方法

add	将指定的管道添加到 PipelineEndpoint。
add_default	将指定的管道添加到 PipelineEndpoint，并将默认版本设置为添加的管道版本。
archive	存档 PipelineEndpoint。
disable	将 PipelineEndpoint 设置为“Disabled”且无法运行。
enable	将 PipelineEndpoint 设置为“Active”，并可供运行。
get	按名称或 ID 获取 PipelineEndpoint，如果未提供，则会引发异常。
get_all	获取当前工作区中的所有活动 PipelineEndpoints。获取所有活动的 PipelineEndpoints。注意：此方法被弃用，转而支持 PipelineEndpoint.list（）。
get_all_pipelines	获取 PipelineEndpoint 中的管道列表。注意：此方法被弃用，而不是list_pipelines（）
get_all_versions	获取 PipelineEndpoint 中管道和相应版本的列表。注意：此方法被弃用，而不是list_versions（）
get_default_version	获取 PipelineEndpoint 的默认版本。
get_pipeline	获取指定版本或默认值的管道;如果未找到版本，则引发异常。
list	列出当前工作区中的活动 PipelineEndpoints。
list_pipelines	获取与 PipelineEndpoint 关联的管道列表。
list_versions	获取管道列表和 PipelineEndpoint 的相应版本。
publish	创建具有指定名称和管道/已发布管道的 PipelineEndpoint。管道终结点是可从外部应用程序使用的 REST API。有关如何在调用 REST 终结点时进行身份验证的信息，请参阅 https://aka.ms/pl-restep-auth。有关使用管道终结点的详细信息，请参阅 https://aka.ms/pl-first-pipeline。如果已存在具有给定名称的 PipelineEndpoint，则引发异常。
reactivate	重新激活已存档的 PipelineEndpoint。
set_default	设置 PipelineEndpoint 的默认版本，如果未找到指定的管道，则会引发异常。
set_default_version	设置 PipelineEndpoint 的默认版本，如果未找到指定的版本，则会引发异常。
set_name	设置 PipelineEndpoint 的名称。
submit	提交给定版本的管道试验;如果版本不是，则不会触发管道的默认版本。

add

将指定的管道添加到 PipelineEndpoint。

add(pipeline)

参数

名称	说明
pipeline 必需	PublishedPipeline 要添加的已发布管道。

add_default

将指定的管道添加到 PipelineEndpoint，并将默认版本设置为添加的管道版本。

add_default(pipeline)

参数

名称	说明
pipeline 必需	PublishedPipeline 要添加为默认版本的已发布管道。

disable

将 PipelineEndpoint 设置为“Disabled”且无法运行。

disable()

enable

将 PipelineEndpoint 设置为“Active”，并可供运行。

enable()

get

按名称或 ID 获取 PipelineEndpoint，如果未提供，则会引发异常。

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

参数

名称	说明
workspace 必需	Workspace 在其中创建了 PipelineEndpoint 的工作区。
id	str PipelineEndpoint 的 ID。默认值: None
name	str PipelineEndpoint 的名称。默认值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
PipelineEndpoint	PipelineEndpoint 对象。

get_all

获取当前工作区中的所有活动 PipelineEndpoints。

获取所有活动的 PipelineEndpoints。注意：此方法被弃用，转而支持 PipelineEndpoint.list（）。

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

参数

名称	说明
workspace 必需	Workspace 工作区。
active_only	bool 如果为 true，则仅返回当前处于活动状态的 PipelineEndpoints。默认值: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
list	对象列表 PipelineEndpoint 。

get_all_pipelines

获取 PipelineEndpoint 中的管道列表。

注意：此方法被弃用，而不是list_pipelines（）

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

参数

名称	说明
active_only	bool 仅返回活动管道的标志。默认值: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
list	对象列表 PublishedPipeline 。

get_all_versions

获取 PipelineEndpoint 中管道和相应版本的列表。

注意：此方法被弃用，而不是list_versions（）

get_all_versions(_workflow_provider=None, _service_endpoint=None)

参数

名称	说明
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
list	对象列表 PipelineVersion 。

get_default_version

获取 PipelineEndpoint 的默认版本。

get_default_version()

类型	说明
str	管道终结点的默认版本。

get_pipeline

获取指定版本或默认值的管道;如果未找到版本，则引发异常。

get_pipeline(version=None)

参数

名称	说明
version	str 要返回的管道的版本。默认值: None

类型	说明
PublishedPipeline	已发布的管道。

list

列出当前工作区中的活动 PipelineEndpoints。

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

参数

名称	说明
workspace 必需	Workspace 工作区。
active_only	bool 如果为 true，则仅返回当前处于活动状态的 PipelineEndpoints。默认值: True
max_results	int 返回的 PipelineEndpoints 的最大行数默认值: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
list	对象列表 PipelineEndpoint 。

list_pipelines

获取与 PipelineEndpoint 关联的管道列表。

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

参数

名称	说明
active_only	bool 指示是否仅返回活动管道。默认值: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
list	对象列表 PublishedPipeline 。

list_versions

获取管道列表和 PipelineEndpoint 的相应版本。

list_versions(_workflow_provider=None, _service_endpoint=None)

参数

名称	说明
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None
_service_endpoint	str 服务终结点。默认值: None

类型	说明
list	对象列表 PipelineVersion 。

publish

创建具有指定名称和管道/已发布管道的 PipelineEndpoint。

管道终结点是可从外部应用程序使用的 REST API。有关如何在调用 REST 终结点时进行身份验证的信息，请参阅 https://aka.ms/pl-restep-auth。

有关使用管道终结点的详细信息，请参阅 https://aka.ms/pl-first-pipeline。

如果已存在具有给定名称的 PipelineEndpoint，则引发异常。

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

参数

名称	说明
workspace 必需	Workspace 要在其中创建 PipelineEndpoint 的工作区。
name 必需	str PipelineEndpoint 的名称。
description 必需	str PipelineEndpoint 的说明。
pipeline 必需	PublishedPipeline 或 Pipeline 已发布的管道或管道。
_service_endpoint	str 服务终结点。默认值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流提供程序。默认值: None

类型	说明
PipelineEndpoint	新的 PipelineEndpoint。

例外

类型	说明
ValueError

reactivate

重新激活已存档的 PipelineEndpoint。

reactivate(name)

参数

名称	说明
name 必需	str 要设置的名称。

类型	说明
PipelineEndpoint	PipelineEndpoint 对象。

set_default

设置 PipelineEndpoint 的默认版本，如果未找到指定的管道，则会引发异常。

set_default(pipeline)

参数

名称	说明
pipeline 必需	PublishedPipeline 要设置为默认值的已发布管道。

例外

类型	说明
ValueError

set_default_version

设置 PipelineEndpoint 的默认版本，如果未找到指定的版本，则会引发异常。

set_default_version(version)

参数

名称	说明
version 必需	str 要设置为 PipelineEndpoint 中的默认版本的版本。

例外

类型	说明
ValueError

set_name

设置 PipelineEndpoint 的名称。

set_name(name)

参数

名称	说明
name 必需	str 要设置的名称。

submit

提交给定版本的管道试验;如果版本不是，则不会触发管道的默认版本。

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

参数

名称	说明
experiment_name 必需	str 要在其中提交管道的试验的名称。
pipeline_parameters	dict 要在管道执行中使用的参数，作为 {name： value} 的字典传递。有关详细信息，请参阅 PipelineParameter。默认值: None
parent_run_id	str 可以提供运行 ID 来设置此管道运行的父运行，该运行反映在 RunHistory 中。父运行必须与提交此管道时所属于的实验相同。默认值: None
pipeline_version	str 要运行的管道版本。默认值: None

类型	说明
PipelineRun	提交的管道运行。

例外

类型	说明
ValueError

属性

default_version

获取 PipelineEndpoint 的默认版本。

类型	说明
str	默认版本。

description

获取 PipelineEndpoint 的说明。

类型	说明
str	说明。

endpoint

获取 PipelineEndpoint 的 REST 终结点 URL。

终结点可用于触发管道的运行。

类型	说明
str	用于运行管道的 PipelineEndpoint 的 REST 终结点。

id

获取 PipelineEndpoint 的 ID。

类型	说明
str	PipelineEndpoint 的 ID。

name

获取 PipelineEndpoint 的名称。

类型	说明
str	名称。

pipeline_version_list

获取管道版本列表。

类型	说明
list	对象列表 PipelineIdVersion 。

status

获取 PipelineEndpoint 的状态。

类型	说明
str	状态。

swaggerurl

获取 PipelineEndpoint 的 REST Swagger URL。

Swagger URL 可以是管道终结点的架构。

类型	说明
str	用于 PipelineEndpoint 的 REST Swagger 运行管道。

通过