PipelineEndpoint 클래스

참조

고유한 엔드포인트 URL에서 트리거될 수 있는 Pipeline 워크플로를 나타냅니다.

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)

매개 변수

Name	Description
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를 제출합니다. 제출이 호출되면 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)

PipelineEndpoints 만들기 및 사용에 대한 추가 정보는 다음 Notebook을 참조하세요. https://aka.ms/pl-ver-endpoint.

메서드

add	PipelineEndpoint에 지정된 파이프라인을 추가합니다.
add_default	지정된 파이프라인을 PipelineEndpoint에 추가하고 기본 버전을 추가된 파이프라인 버전으로 설정합니다.
archive	PipelineEndpoint를 보관합니다.
disable	PipelineEndpoint를 'Disabled'로 설정하고 실행할 수 없습니다.
enable	PipelineEndpoint를 'Active'로 설정하고 실행할 수 있습니다.
get	이름 또는 ID로 PipelineEndpoint를 가져오고 둘 중 하나가 제공되지 않으면 예외가 throw됩니다.
get_all	현재 작업 영역에서 모든 활성 PipelineEndpoint를 가져옵니다. 모든 활성 PipelineEndpoint를 가져옵니다. 참고: 이 메서드는 PipelineEndpoint.list()를 위해 더 이상 사용되지 않습니다.
get_all_pipelines	PipelineEndpoint에서 파이프라인 목록을 가져옵니다. 참고: 이 메서드는 list_pipelines()를 위해 더 이상 사용되지 않습니다.
get_all_versions	PipelineEndpoint에서 파이프라인 및 해당 버전 목록을 가져옵니다. 참고: 이 메서드는 list_versions()를 위해 더 이상 사용되지 않습니다.
get_default_version	PipelineEndpoint의 기본 버전을 가져옵니다.
get_pipeline	지정된 버전 또는 기본값의 파이프라인을 가져옵니다. 버전을 찾을 수 없으면 예외가 throw됩니다.
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가 이미 존재하는 경우 예외가 throw됩니다.
reactivate	보관된 PipelineEndpoint를 다시 활성화합니다.
set_default	PipelineEndpoint의 기본 버전을 설정하고 지정된 파이프라인을 찾을 수 없는 경우 예외가 throw됩니다.
set_default_version	PipelineEndpoint의 기본 버전을 설정하고 지정된 버전을 찾을 수 없는 경우 예외가 throw됩니다.
set_name	PipelineEndpoint의 이름을 설정합니다.
submit	지정된 버전의 파이프라인 실험을 제출합니다. 버전이 None이면 파이프라인의 기본 버전이 트리거됩니다.

add

PipelineEndpoint에 지정된 파이프라인을 추가합니다.

add(pipeline)

매개 변수

Name	Description
pipeline 필수	PublishedPipeline 추가할 게시된 파이프라인입니다.

add_default

지정된 파이프라인을 PipelineEndpoint에 추가하고 기본 버전을 추가된 파이프라인 버전으로 설정합니다.

add_default(pipeline)

매개 변수

Name	Description
pipeline 필수	PublishedPipeline 기본 버전으로 추가할 게시된 파이프라인입니다.

disable

PipelineEndpoint를 'Disabled'로 설정하고 실행할 수 없습니다.

disable()

enable

PipelineEndpoint를 'Active'로 설정하고 실행할 수 있습니다.

enable()

get

이름 또는 ID로 PipelineEndpoint를 가져오고 둘 중 하나가 제공되지 않으면 예외가 throw됩니다.

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

매개 변수

Name	Description
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

반환

형식	Description
PipelineEndpoint	PipelineEndpoint 개체입니다.

get_all

현재 작업 영역에서 모든 활성 PipelineEndpoint를 가져옵니다.

모든 활성 PipelineEndpoint를 가져옵니다. 참고: 이 메서드는 PipelineEndpoint.list()를 위해 더 이상 사용되지 않습니다.

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

매개 변수

Name	Description
workspace 필수	Workspace 작업 영역입니다.
active_only	bool true인 경우 현재 활성화된 PipelineEndpoint만 반환합니다. 기본값: 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)

매개 변수

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

매개 변수

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 워크플로 공급자입니다. 기본값: None
_service_endpoint	str 서비스 엔드포인트입니다. 기본값: None

반환

형식	Description
list	PipelineVersion 개체의 목록.

get_default_version

PipelineEndpoint의 기본 버전을 가져옵니다.

get_default_version()

반환

형식	Description
str	파이프라인 엔드포인트의 기본 버전입니다.

get_pipeline

지정된 버전 또는 기본값의 파이프라인을 가져옵니다. 버전을 찾을 수 없으면 예외가 throw됩니다.

get_pipeline(version=None)

매개 변수

Name	Description
version	str 반환할 파이프라인의 버전입니다. 기본값: None

반환

형식	Description
PublishedPipeline	게시된 파이프라인입니다.

list

현재 작업 영역에서 활성 PipelineEndpoints를 나열합니다.

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

매개 변수

Name	Description
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

반환

형식	Description
list	PipelineEndpoint 개체의 목록.

list_pipelines

PipelineEndpoint와 연결된 파이프라인 목록을 가져옵니다.

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

매개 변수

Name	Description
active_only	bool 활성 파이프라인만 반환할지 여부를 나타냅니다. 기본값: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 워크플로 공급자입니다. 기본값: None
_service_endpoint	str 서비스 엔드포인트입니다. 기본값: None

반환

형식	Description
list	PublishedPipeline 개체의 목록.

list_versions

파이프라인 목록과 PipelineEndpoint의 해당 버전을 가져옵니다.

list_versions(_workflow_provider=None, _service_endpoint=None)

매개 변수

Name	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가 이미 존재하는 경우 예외가 throw됩니다.

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

매개 변수

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

매개 변수

Name	Description
name 필수	str 설정할 이름입니다.

반환

형식	Description
PipelineEndpoint	PipelineEndpoint 개체입니다.

set_default

PipelineEndpoint의 기본 버전을 설정하고 지정된 파이프라인을 찾을 수 없는 경우 예외가 throw됩니다.

set_default(pipeline)

매개 변수

Name	Description
pipeline 필수	PublishedPipeline 기본값으로 설정할 게시된 파이프라인입니다.

예외

형식	Description
ValueError

set_default_version

PipelineEndpoint의 기본 버전을 설정하고 지정된 버전을 찾을 수 없는 경우 예외가 throw됩니다.

set_default_version(version)

매개 변수

Name	Description
version 필수	str PipelineEndpoint에서 기본 버전으로 설정할 버전입니다.

예외

형식	Description
ValueError

set_name

PipelineEndpoint의 이름을 설정합니다.

set_name(name)

매개 변수

Name	Description
name 필수	str 설정할 이름입니다.

submit

지정된 버전의 파이프라인 실험을 제출합니다. 버전이 None이면 파이프라인의 기본 버전이 트리거됩니다.

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

매개 변수

Name	Description
experiment_name 필수	str 파이프라인을 제출할 실험의 이름입니다.
pipeline_parameters	dict 파이프라인 실행에 사용할 매개 변수로, {name: value} 사전으로 전달됩니다. 자세한 내용은 PipelineParameter를 참조하세요. 기본값: None
parent_run_id	str RunHistory에 반영되는 이 파이프라인 실행의 부모 실행을 설정하기 위해 실행 ID를 제공할 수 있습니다. 부모 실행은 이 파이프라인이 제출되는 동일한 실험에 속해야 합니다. 기본값: 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의 ID를 가져옵니다.

반환

형식	Description
str	PipelineEndpoint의 ID입니다.

name

PipelineEndpoint의 이름을 가져옵니다.

반환

형식	Description
str	이름입니다.

pipeline_version_list

파이프라인 버전 목록을 가져옵니다.

반환

형식	Description
list	PipelineIdVersion 개체의 목록.

status

PipelineEndpoint의 상태를 가져옵니다.

반환

형식	Description
str	상태입니다.

swaggerurl

PipelineEndpoint의 REST Swagger URL을 가져옵니다.

Swagger url은 파이프라인 엔드포인트의 보기 스키마일 수 있습니다.

반환

형식	Description
str	파이프라인을 실행하기 위한 PipelineEndpoint용 REST Swagger입니다.

다음을 통해 공유

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

반환

피드백

피드백

추가 리소스