次の方法で共有

PipelineEndpoint クラス

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

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。

注釈

PipelineEndpoint は、 Pipeline または PublishedPipelineから作成できます。

パイプラインまたは 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 を送信します。 送信が呼び出されると、 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 を "無効" に設定し、実行できません。
enable

PipelineEndpoint を "アクティブ" に設定し、実行できるようにします。
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 を "無効" に設定し、実行できません。

disable()

enable

PipelineEndpoint を "アクティブ" に設定し、実行できるようにします。

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。