PipelineEndpoint 類別

參考

表示可從唯一 Pipeline 端點 URL 觸發的工作流程。

PipelineEndpoints 可用來建立新版本的， PublishedPipeline 同時維護相同的端點。 PipelineEndpoints 在工作區內是唯一命名的。

使用 PipelineEndpoint 物件的端點屬性，您可以使用 REST 呼叫從外部應用程式觸發新的管線執行。如需如何在呼叫 REST 端點時進行驗證的資訊，請參閱 https://aka.ms/pl-restep-auth 。

如需建立和執行機器學習管線的詳細資訊，請參閱 https://aka.ms/pl-first-pipeline 。

初始化 PipelineEndpoint。

繼承: builtins.object

PipelineEndpoint

建構函式

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

參數

名稱	Description
workspace 必要	Workspace PipelineEndpoint 定義所在的工作區。
id 必要	str PipelineEndpoint 的識別碼。
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 的識別碼。
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，可提交管線執行。

備註

您可以從或 PublishedPipeline 建立 Pipeline 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。呼叫 submit 時，會建立， 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：您可以提供執行識別碼來設定此管線執行的父回合，這會反映在 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 設定為 [已停用]，且無法執行。
enable	將 PipelineEndpoint 設定為 [作用中]，並可供執行。
get	依名稱或識別碼取得 PipelineEndpoint，如果未提供例外狀況，則會擲回例外狀況。
get_all	取得目前工作區中的所有作用中 PipelineEndpoints。取得所有作用中的 PipelineEndpoints。注意：這個方法已被取代為 PipelineEndpoint.list () 。
get_all_pipelines	取得 PipelineEndpoint 中的管線清單。注意：這個方法已被取代，而不是list_pipelines ()
get_all_versions	取得 PipelineEndpoint 中的管線和對應版本清單。注意：這個方法已被取代，而不是list_versions ()
get_default_version	取得管線Endpoint 的預設版本。
get_pipeline	取得指定版本的管線或預設值;如果找不到版本，則會擲回例外狀況。
list	列出目前工作區中的作用中 PipelineEndpoints。
list_pipelines	取得與 PipelineEndpoint 相關聯的管線清單。
list_versions	取得管線清單和管線Endpoint 的對應版本。
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	提交指定版本的管線實驗;如果 version 不是觸發管線的預設版本，則為。

add

將指定的管線新增至 PipelineEndpoint。

add(pipeline)

參數

名稱	Description
pipeline 必要	PublishedPipeline 要新增的已發佈管線。

add_default

將指定的管線新增至 PipelineEndpoint，並將預設版本設定為新增的管線版本。

add_default(pipeline)

參數

名稱	Description
pipeline 必要	PublishedPipeline 要新增為預設版本的已發佈管線。

disable

將 PipelineEndpoint 設定為 [已停用]，且無法執行。

disable()

enable

將 PipelineEndpoint 設定為 [作用中]，並可供執行。

enable()

get

依名稱或識別碼取得 PipelineEndpoint，如果未提供例外狀況，則會擲回例外狀況。

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

參數

名稱	Description
workspace 必要	Workspace PipelineEndpoint 建立所在的工作區。
id	str PipelineEndpoint 的識別碼。預設值: None
name	str PipelineEndpoint 的名稱。預設值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
PipelineEndpoint	PipelineEndpoint 物件。

get_all

取得目前工作區中的所有作用中 PipelineEndpoints。

取得所有作用中的 PipelineEndpoints。注意：這個方法已被取代為 PipelineEndpoint.list () 。

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

參數

名稱	Description
workspace 必要	Workspace 工作區。
active_only	bool 如果為 true，則只會傳回目前作用中的 PipelineEndpoints。預設值: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
list	PipelineEndpoint 物件的清單。

get_all_pipelines

取得 PipelineEndpoint 中的管線清單。

注意：這個方法已被取代，而不是list_pipelines ()

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

參數

名稱	Description
active_only	bool 僅傳回作用中管線的旗標。預設值: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
list	PublishedPipeline 物件的清單。

get_all_versions

取得 PipelineEndpoint 中的管線和對應版本清單。

注意：這個方法已被取代，而不是list_versions ()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

參數

名稱	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
list	PipelineVersion 物件的清單。

get_default_version

取得管線Endpoint 的預設版本。

get_default_version()

傳回

類型	Description
str	管線端點的預設版本。

get_pipeline

取得指定版本的管線或預設值;如果找不到版本，則會擲回例外狀況。

get_pipeline(version=None)

參數

名稱	Description
version	str 要傳回之管線的版本。預設值: None

傳回

類型	Description
PublishedPipeline	已發佈的管線。

list

列出目前工作區中的作用中 PipelineEndpoints。

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

參數

名稱	Description
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

傳回

類型	Description
list	PipelineEndpoint 物件的清單。

list_pipelines

取得與 PipelineEndpoint 相關聯的管線清單。

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

參數

名稱	Description
active_only	bool 指出是否只傳回作用中的管線。預設值: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
list	PublishedPipeline 物件的清單。

list_versions

取得管線清單和管線Endpoint 的對應版本。

list_versions(_workflow_provider=None, _service_endpoint=None)

參數

名稱	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
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)

參數

名稱	Description
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

傳回

類型	Description
PipelineEndpoint	新的 PipelineEndpoint。

例外狀況

類型	Description
ValueError

reactivate

重新啟用封存的 PipelineEndpoint。

reactivate(name)

參數

名稱	Description
name 必要	str 要設定的名稱。

傳回

類型	Description
PipelineEndpoint	PipelineEndpoint 物件。

set_default

設定預設版本的 PipelineEndpoint，如果找不到指定的管線，則會擲回例外狀況。

set_default(pipeline)

參數

名稱	Description
pipeline 必要	PublishedPipeline 要設定為預設值的已發佈管線。

例外狀況

類型	Description
ValueError

set_default_version

設定 PipelineEndpoint 的預設版本，如果找不到指定的版本，則會擲回例外狀況。

set_default_version(version)

參數

名稱	Description
version 必要	str 要設定為 PipelineEndpoint 中預設版本的版本。

例外狀況

類型	Description
ValueError

set_name

設定 PipelineEndpoint 的名稱。

set_name(name)

參數

名稱	Description
name 必要	str 要設定的名稱。

submit

提交指定版本的管線實驗;如果 version 不是觸發管線的預設版本，則為。

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

參數

名稱	Description
experiment_name 必要	str 要提交管線的實驗名稱。
pipeline_parameters	dict 在管線執行中使用的參數，傳遞為 {name： value} 的字典。如需更多詳細資料，請參閱 PipelineParameter \(英文\)。預設值: None
parent_run_id	str 您可以提供執行識別碼來設定此管線執行的父回合，這會反映在 RunHistory 中。父執行必須屬於此管線要提交到的相同實驗。預設值: None
pipeline_version	str 要執行的管線版本。預設值: None

傳回

類型	Description
PipelineRun	提交的管線執行。

例外狀況

類型	Description
ValueError

屬性

default_version

取得 PipelineEndpoint 的預設版本。

傳回

類型	Description
str	預設版本。

description

取得 PipelineEndpoint 的描述。

傳回

類型	Description
str	描述。

endpoint

取得 PipelineEndpoint 的 REST 端點 URL。

端點可用來觸發管線的執行。

傳回

類型	Description
str	用於執行管線之 PipelineEndpoint 的 REST 端點。

id

取得 PipelineEndpoint 的識別碼。

傳回

類型	Description
str	PipelineEndpoint 的識別碼。

name

取得 PipelineEndpoint 的名稱。

傳回

類型	Description
str	名稱。

pipeline_version_list

取得管線版本清單。

傳回

類型	Description
list	PipelineIdVersion 物件的清單。

status

取得 PipelineEndpoint 的狀態。

傳回

類型	Description
str	狀態。

swaggerurl

取得 PipelineEndpoint 的 REST Swagger URL。

Swagger URL 可以是管線端點的架構。

傳回

類型	Description
str	REST Swagger for PipelineEndpoint 以執行管線。

共用方式為

PipelineEndpoint 類別

建構函式

參數

備註

方法

add

參數

add_default

參數

archive

disable

enable

get

參數

傳回

get_all

參數

傳回

get_all_pipelines

參數

傳回

get_all_versions

參數

傳回

get_default_version

傳回

get_pipeline

參數

傳回

list

參數

傳回

list_pipelines

參數

傳回

list_versions

參數

傳回

publish

參數

傳回

例外狀況

reactivate

參數

傳回

set_default

參數

例外狀況

set_default_version

參數

例外狀況

set_name

參數

submit

參數

傳回

例外狀況

屬性

default_version

傳回

description

傳回

endpoint

傳回

id

傳回

name

傳回

pipeline_version_list

傳回

status

傳回

swaggerurl

傳回

意見反應

其他資源