PipelineRunOperations interface

Pacote:

@azure/synapse-artifacts

Interface que representa um PipelineRunOperations.

Métodos

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)	Cancele um pipeline executado por sua ID de execução.
getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)	Obtenha um pipeline executado por sua ID de execução.
queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)	A atividade de consulta é executada com base nas condições de filtro de entrada.
queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)	O pipeline de consulta é executado no workspace com base nas condições de filtro de entrada.

Detalhes do método

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)

Cancele um pipeline executado por sua ID de execução.

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

Parâmetros

runId

string

O identificador de execução do pipeline.

options

PipelineRunCancelPipelineRunOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)

Obtenha um pipeline executado por sua ID de execução.

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

Parâmetros

runId

string

O identificador de execução do pipeline.

options

PipelineRunGetPipelineRunOptionalParams

Os parâmetros de opções.

Retornos

Promise<PipelineRun>

queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)

A atividade de consulta é executada com base nas condições de filtro de entrada.

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

Parâmetros

pipelineName

string

O nome do pipeline.

runId

string

O identificador de execução do pipeline.

filterParameters

RunFilterParameters

Parâmetros para filtrar as execuções da atividade.

options

PipelineRunQueryActivityRunsOptionalParams

Os parâmetros de opções.

Retornos

Promise<ActivityRunsQueryResponse>

queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)

O pipeline de consulta é executado no workspace com base nas condições de filtro de entrada.

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

Parâmetros

filterParameters

RunFilterParameters

Parâmetros para filtrar a execução do pipeline.

options

PipelineRunQueryPipelineRunsByWorkspaceOptionalParams

Os parâmetros de opções.

Retornos

Promise<PipelineRunsQueryResponse>