PipelinesRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
| Pipelines |
Методы
| create |
Создали конвейер. |
| get |
Получение определенного артефакта из выполнения конвейера |
| get |
Получение определенного журнала из выполнения конвейера |
| get |
Возвращает конвейер (при необходимости в указанной версии). |
| get |
Возвращает выполнение для определенного конвейера. |
| list |
Получение списка журналов из выполнения конвейера. |
| list |
Получение списка конвейеров. |
| list |
Возвращает первые 10000 запусков для определенного конвейера. |
| preview(Run |
Помещает в очередь сухой запуск конвейера и возвращает объект, содержащий окончательный yaml. |
| run |
Запускает конвейер. |
Сведения о конструкторе
PipelinesRestClient(IVssRestClientOptions)
Сведения о методе
createPipeline(CreatePipelineParameters, string)
Создали конвейер.
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>Параметры
- inputParameters
- CreatePipelineParameters
Входные параметры.
- project
-
string
Идентификатор или имя проекта
Возвращаемое значение
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
Получение определенного артефакта из выполнения конвейера
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>Параметры
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера.
- runId
-
number
Идентификатор выполнения этого конвейера.
- artifactName
-
string
Имя артефакта.
- expand
- GetArtifactExpandOptions
Разверните параметры. Значение по умолчанию — Нет.
Возвращаемое значение
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
Получение определенного журнала из выполнения конвейера
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>Параметры
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера.
- runId
-
number
Идентификатор выполнения этого конвейера.
- logId
-
number
Идентификатор журнала.
- expand
- GetLogExpandOptions
Разверните параметры. Значение по умолчанию — Нет.
Возвращаемое значение
Promise<Log>
getPipeline(string, number, number)
Возвращает конвейер (при необходимости в указанной версии).
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>Параметры
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера
- pipelineVersion
-
number
Версия конвейера
Возвращаемое значение
Promise<Pipeline>
getRun(string, number, number)
Возвращает выполнение для определенного конвейера.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>Параметры
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера
- runId
-
number
Идентификатор выполнения
Возвращаемое значение
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
Получение списка журналов из выполнения конвейера.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>Параметры
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера.
- runId
-
number
Идентификатор выполнения этого конвейера.
- expand
- GetLogExpandOptions
Разверните параметры. Значение по умолчанию — Нет.
Возвращаемое значение
Promise<LogCollection>
listPipelines(string, string, number, string)
Получение списка конвейеров.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>Параметры
- project
-
string
Идентификатор или имя проекта
- orderBy
-
string
Выражение сортировки. По умолчанию используется значение "name asc"
- top
-
number
Максимальное число возвращаемых конвейеров
- continuationToken
-
string
Маркер продолжения из предыдущего запроса для получения следующей страницы результатов
Возвращаемое значение
Promise<Pipeline[]>
listRuns(string, number)
Возвращает первые 10000 запусков для определенного конвейера.
function listRuns(project: string, pipelineId: number): Promise<Run[]>Параметры
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера
Возвращаемое значение
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
Помещает в очередь сухой запуск конвейера и возвращает объект, содержащий окончательный yaml.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>Параметры
- runParameters
- RunPipelineParameters
Необязательные дополнительные параметры для этого запуска.
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера.
- pipelineVersion
-
number
Версия конвейера.
Возвращаемое значение
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
Запускает конвейер.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>Параметры
- runParameters
- RunPipelineParameters
Необязательные дополнительные параметры для этого запуска.
- project
-
string
Идентификатор или имя проекта
- pipelineId
-
number
Идентификатор конвейера.
- pipelineVersion
-
number
Версия конвейера.
Возвращаемое значение
Promise<Run>