PipelineEndpoint 類別
表示可從唯一 Pipeline 端點 URL 觸發的工作流程。
PipelineEndpoints 可用來建立新版本的 ， PublishedPipeline 同時維護相同的端點。 PipelineEndpoints 在工作區內是唯一命名的。
使用 PipelineEndpoint 物件的端點屬性，您可以使用 REST 呼叫從外部應用程式觸發新的管線執行。 如需如何在呼叫 REST 端點時進行驗證的資訊，請參閱 https://aka.ms/pl-restep-auth 。
如需建立和執行機器學習管線的詳細資訊，請參閱 https://aka.ms/pl-first-pipeline 。
初始化 PipelineEndpoint。
- 繼承
-
builtins.objectPipelineEndpoint
建構函式
PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)參數
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
PipelineEndpoint 提供者。
- _pipeline_endpoint_provider
PublishedPipeline 提供者。
- _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
add_default
將指定的管線新增至 PipelineEndpoint，並將預設版本設定為新增的管線版本。
add_default(pipeline)參數
archive
封存 PipelineEndpoint。
archive()disable
將 PipelineEndpoint 設定為 [已停用]，且無法執行。
disable()enable
將 PipelineEndpoint 設定為 [作用中]，並可供執行。
enable()get
依名稱或識別碼取得 PipelineEndpoint，如果未提供例外狀況，則會擲回例外狀況。
static get(workspace, id=None, name=None, _workflow_provider=None, _service_endpoint=None)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
PipelineEndpoint 物件。
傳回類型
get_all
取得目前工作區中的所有作用中 PipelineEndpoints。
取得所有作用中的 PipelineEndpoints。 注意：這個方法已被取代為 PipelineEndpoint.list () 。
static get_all(workspace, active_only=True, _workflow_provider=None, _service_endpoint=None)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
PipelineEndpoint 物件的清單。
傳回類型
get_all_pipelines
取得 PipelineEndpoint 中的管線清單。
注意：這個方法已被取代，而不是list_pipelines ()
get_all_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
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>
工作流程提供者。
傳回
PipelineVersion 物件的清單。
傳回類型
get_default_version
get_pipeline
取得指定版本的管線或預設值;如果找不到版本，則會擲回例外狀況。
get_pipeline(version=None)參數
傳回
已發佈的管線。
傳回類型
list
列出目前工作區中的作用中 PipelineEndpoints。
static list(workspace, active_only=True, max_results=100, _workflow_provider=None, _service_endpoint=None)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
PipelineEndpoint 物件的清單。
傳回類型
list_pipelines
取得與 PipelineEndpoint 相關聯的管線清單。
list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
PublishedPipeline 物件的清單。
傳回類型
list_versions
取得管線清單和管線Endpoint 的對應版本。
list_versions(_workflow_provider=None, _service_endpoint=None)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
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)參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
工作流程提供者。
傳回
新的 PipelineEndpoint。
傳回類型
例外狀況
reactivate
重新啟用封存的 PipelineEndpoint。
reactivate(name)參數
傳回
PipelineEndpoint 物件。
傳回類型
set_default
設定預設版本的 PipelineEndpoint，如果找不到指定的管線，則會擲回例外狀況。
set_default(pipeline)參數
例外狀況
set_default_version
設定 PipelineEndpoint 的預設版本，如果找不到指定的版本，則會擲回例外狀況。
set_default_version(version)參數
例外狀況
set_name
submit
提交指定版本的管線實驗;如果 version 不是觸發管線的預設版本，則為 。
submit(experiment_name, pipeline_parameters=None, parent_run_id=None, pipeline_version=None)參數
- pipeline_parameters
- dict
在管線執行中使用的參數，傳遞為 {name： value} 的字典。 如需更多詳細資料，請參閱 PipelineParameter \(英文\)。
傳回
提交的管線執行。
傳回類型
例外狀況
屬性
default_version
description
endpoint
id
name
pipeline_version_list
status
swaggerurl
取得 PipelineEndpoint 的 REST Swagger URL。
Swagger URL 可以是管線端點的架構。
傳回
REST Swagger for PipelineEndpoint 以執行管線。
傳回類型
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應