PipelinesRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Konstruktorok
| Pipelines |
Metódusok
| create |
Hozzon létre egy folyamatot. |
| get |
Adott összetevő lekérése egy folyamatfuttatásból |
| get |
Adott napló lekérése egy folyamatfuttatásból |
| get |
Lekér egy folyamatot, opcionálisan a megadott verzióban |
| get |
Lekéri egy adott folyamat futtatását. |
| list |
Szerezze be a naplók listáját egy folyamatfuttatásból. |
| list |
Szerezze be a folyamatok listáját. |
| list |
Lekéri az első 10000 futtatást egy adott folyamathoz. |
| preview(Run |
Várólista a folyamat száraz futtatása, és visszaad egy objektumot, amely tartalmazza a végső yaml-t. |
| run |
Folyamatot futtat. |
Konstruktor adatai
PipelinesRestClient(IVssRestClientOptions)
Metódus adatai
createPipeline(CreatePipelineParameters, string)
Hozzon létre egy folyamatot.
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>Paraméterek
- inputParameters
- CreatePipelineParameters
Bemeneti paraméterek.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
Adott összetevő lekérése egy folyamatfuttatásból
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
Az adatfolyam azonosítója.
- runId
-
number
A folyamat futtatásának azonosítója.
- artifactName
-
string
Az összetevő neve.
- expand
- GetArtifactExpandOptions
Bontsa ki a lehetőségeket. Az alapértelmezett érték a Nincs.
Válaszok
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
Adott napló lekérése egy folyamatfuttatásból
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
Az adatfolyam azonosítója.
- runId
-
number
A folyamat futtatásának azonosítója.
- logId
-
number
A napló azonosítója.
- expand
- GetLogExpandOptions
Bontsa ki a lehetőségeket. Az alapértelmezett érték a Nincs.
Válaszok
Promise<Log>
getPipeline(string, number, number)
Lekér egy folyamatot, opcionálisan a megadott verzióban
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
A folyamat azonosítója
- pipelineVersion
-
number
A folyamat verziója
Válaszok
Promise<Pipeline>
getRun(string, number, number)
Lekéri egy adott folyamat futtatását.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
A folyamat azonosítója
- runId
-
number
A futtatás azonosítója
Válaszok
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
Szerezze be a naplók listáját egy folyamatfuttatásból.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
Az adatfolyam azonosítója.
- runId
-
number
A folyamat futtatásának azonosítója.
- expand
- GetLogExpandOptions
Bontsa ki a lehetőségeket. Az alapértelmezett érték a Nincs.
Válaszok
Promise<LogCollection>
listPipelines(string, string, number, string)
Szerezze be a folyamatok listáját.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- orderBy
-
string
Rendezési kifejezés. Alapértelmezés szerint "név asc"
- top
-
number
A visszaadandó folyamatok maximális száma
- continuationToken
-
string
Folytatási jogkivonat egy korábbi kérésből az eredmények következő oldalának lekéréséhez
Válaszok
Promise<Pipeline[]>
listRuns(string, number)
Lekéri az első 10000 futtatást egy adott folyamathoz.
function listRuns(project: string, pipelineId: number): Promise<Run[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
A folyamat azonosítója
Válaszok
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
Várólista a folyamat száraz futtatása, és visszaad egy objektumot, amely tartalmazza a végső yaml-t.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>Paraméterek
- runParameters
- RunPipelineParameters
Opcionális további paraméterek ehhez a futtatáshoz.
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
A folyamat azonosítója.
- pipelineVersion
-
number
A folyamat verziója.
Válaszok
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
Folyamatot futtat.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>Paraméterek
- runParameters
- RunPipelineParameters
Opcionális további paraméterek ehhez a futtatáshoz.
- project
-
string
Projektazonosító vagy projektnév
- pipelineId
-
number
A folyamat azonosítója.
- pipelineVersion
-
number
A folyamat verziója.
Válaszok
Promise<Run>