PipelineRunOperations interface

Пакет:

@azure/synapse-artifacts

Интерфейс, представляющий PipelineRunOperations.

Методы

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)	Отмена конвейера, выполняемого его идентификатором выполнения.
getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)	Получение конвейера, выполняемого его идентификатором выполнения.
queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)	Действие запроса выполняется в зависимости от условий фильтра ввода.
queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)	Конвейер запросов выполняется в рабочей области на основе условий фильтра ввода.

Сведения о методе

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)

Отмена конвейера, выполняемого его идентификатором выполнения.

function cancelPipelineRun(runId: string, options?: PipelineRunCancelPipelineRunOptionalParams): Promise<void>

Параметры

runId

string

Идентификатор выполнения конвейера.

options

PipelineRunCancelPipelineRunOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)

Получение конвейера, выполняемого его идентификатором выполнения.

function getPipelineRun(runId: string, options?: PipelineRunGetPipelineRunOptionalParams): Promise<PipelineRun>

Параметры

runId

string

Идентификатор выполнения конвейера.

options

PipelineRunGetPipelineRunOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PipelineRun>

queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)

Действие запроса выполняется в зависимости от условий фильтра ввода.

function queryActivityRuns(pipelineName: string, runId: string, filterParameters: RunFilterParameters, options?: PipelineRunQueryActivityRunsOptionalParams): Promise<ActivityRunsQueryResponse>

Параметры

pipelineName

string

Имя конвейера.

runId

string

Идентификатор выполнения конвейера.

filterParameters

RunFilterParameters

Параметры для фильтрации выполнения действия.

options

PipelineRunQueryActivityRunsOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ActivityRunsQueryResponse>

queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)

Конвейер запросов выполняется в рабочей области на основе условий фильтра ввода.

function queryPipelineRunsByWorkspace(filterParameters: RunFilterParameters, options?: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams): Promise<PipelineRunsQueryResponse>

Параметры

filterParameters

RunFilterParameters

Параметры для фильтрации выполнения конвейера.

options

PipelineRunQueryPipelineRunsByWorkspaceOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PipelineRunsQueryResponse>