次の方法で共有

PipelineEndpoint クラス

  • リファレンス

一意のエンドポイント URL からトリガーできる Pipeline ワークフローを表します。

PipelineEndpoint を使用すると、同じエンドポイントを維持しながら PublishedPipeline の新しいバージョンを作成できます。 PipelineEndpoint には、ワークスペース内で一意の名前が付けられます。

PipelineEndpoint オブジェクトの endpoint 属性を使用すると、外部アプリケーションから 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)

パラメーター

名前 説明
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。

注釈

PipelineEndpoint は、Pipeline または PublishedPipeline のいずれからでも作成できます。

Pipeline または PublishedPipeline から公開する例を次に示します。


   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 に反映される、このパイプライン実行の親実行を設定する実行 ID を指定できます。 親の実行は、このパイプラインが送信されるのと同じ実験に属している必要があります。

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

PipelineEndpoint の作成と使用の詳細については、次のノートブックを参照してください: https://aka.ms/pl-ver-endpoint。

メソッド

add

指定したパイプラインを PipelineEndpoint に追加します。
add_default

指定したパイプラインを PipelineEndpoint に追加し、既定のバージョンを、追加したパイプライン バージョンに設定します。
archive

PipelineEndpoint をアーカイブします。
disable

PipelineEndpoint を 'Disabled' に設定し、実行できないようにします。
enable

PipelineEndpoint を 'Active' に設定し、実行できるようにします。
get

名前または ID で PipelineEndpoint を取得します。どちらも指定されていない場合は例外をスローします。
get_all

現在のワークスペース内のすべてのアクティブな PipelineEndpoint を取得します。

すべてのアクティブな PipelineEndpoint を取得します。 メモ: このメソッドは非推奨となる予定であり、PipelineEndpoint.list() が優先になります。
get_all_pipelines

PipelineEndpoint のパイプラインの一覧を取得します。

メモ: このメソッドは非推奨となる予定であり、list_pipelines() が優先になります
get_all_versions

PipelineEndpoint のパイプラインおよび対応するバージョンの一覧を取得します。

メモ: このメソッドは非推奨となる予定であり、list_versions() が優先になります
get_default_version

PipelineEndpoint の既定のバージョンを取得します。
get_pipeline

指定したバージョンまたは既定のパイプラインを取得します。バージョンが見つからない場合は、例外をスローします。
list

現在のワークスペース内のアクティブな PipelineEndpoint を一覧表示します。
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

指定したバージョンのパイプライン実験を送信します。バージョンが none の場合は、パイプラインの既定のバージョンがトリガーされます。

add

指定したパイプラインを PipelineEndpoint に追加します。

add(pipeline)

パラメーター

名前 説明
pipeline
必須
PublishedPipeline

追加する公開されたパイプライン。

add_default

指定したパイプラインを PipelineEndpoint に追加し、既定のバージョンを、追加したパイプライン バージョンに設定します。

add_default(pipeline)

パラメーター

名前 説明
pipeline
必須
PublishedPipeline

既定のバージョンとして追加する公開されたパイプライン。

archive

PipelineEndpoint をアーカイブします。

archive()

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

現在のワークスペース内のすべてのアクティブな PipelineEndpoint を取得します。

すべてのアクティブな PipelineEndpoint を取得します。 メモ: このメソッドは非推奨となる予定であり、PipelineEndpoint.list() が優先になります。

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

パラメーター

名前 説明
workspace
必須
Workspace

ワークスペース。
active_only
bool

true の場合、現在アクティブな PipelineEndpoint のみを返します。

規定値: 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

現在のワークスペース内のアクティブな PipelineEndpoint を一覧表示します。

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

パラメーター

名前 説明
workspace
必須
Workspace

ワークスペース。
active_only
bool

true の場合、現在アクティブな PipelineEndpoint のみを返します。

規定値: 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

指定したバージョンのパイプライン実験を送信します。バージョンが none の場合は、パイプラインの既定のバージョンがトリガーされます。

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。