PipelinesRestClient class
Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).
- Extends
Konstruktoren
| Pipelines |
Methoden
| create |
Erstellen einer Pipeline. |
| get |
Abrufen eines bestimmten Artefakts aus einer Pipelineausführung |
| get |
Abrufen eines bestimmten Protokolls aus einer Pipelineausführung |
| get |
Ruft eine Pipeline ab, optional in der angegebenen Version |
| get |
Ruft eine Ausführung für eine bestimmte Pipeline ab. |
| list |
Rufen Sie eine Liste mit Protokollen aus einer Pipelineausführung ab. |
| list |
Rufen Sie eine Liste der Pipelines ab. |
| list |
Ruft die ersten 10.000-Ausführungen für eine bestimmte Pipeline ab. |
| preview(Run |
Stellt eine Trockenausführung der Pipeline in die Warteschlange und gibt ein Objekt zurück, das den endgültigen yaml enthält. |
| run |
Führt eine Pipeline aus. |
Details zum Konstruktor
PipelinesRestClient(IVssRestClientOptions)
Details zur Methode
createPipeline(CreatePipelineParameters, string)
Erstellen einer Pipeline.
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>Parameter
- inputParameters
- CreatePipelineParameters
Eingabeparameter:
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
Abrufen eines bestimmten Artefakts aus einer Pipelineausführung
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>Parameter
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die ID der Pipeline.
- runId
-
number
ID der Ausführung dieser Pipeline.
- artifactName
-
string
Name des Artefakts.
- expand
- GetArtifactExpandOptions
Optionen erweitern. Der Standardwert ist None.
Gibt zurück
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
Abrufen eines bestimmten Protokolls aus einer Pipelineausführung
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>Parameter
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die ID der Pipeline.
- runId
-
number
ID der Ausführung dieser Pipeline.
- logId
-
number
ID des Protokolls.
- expand
- GetLogExpandOptions
Optionen erweitern. Der Standardwert ist None.
Gibt zurück
Promise<Log>
getPipeline(string, number, number)
Ruft eine Pipeline ab, optional in der angegebenen Version
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>Parameter
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die Pipeline-ID
- pipelineVersion
-
number
Die Pipelineversion
Gibt zurück
Promise<Pipeline>
getRun(string, number, number)
Ruft eine Ausführung für eine bestimmte Pipeline ab.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>Parameter
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die Pipeline-ID
- runId
-
number
Die Ausführungs-ID
Gibt zurück
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
Rufen Sie eine Liste mit Protokollen aus einer Pipelineausführung ab.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>Parameter
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die ID der Pipeline.
- runId
-
number
ID der Ausführung dieser Pipeline.
- expand
- GetLogExpandOptions
Optionen erweitern. Der Standardwert ist None.
Gibt zurück
Promise<LogCollection>
listPipelines(string, string, number, string)
Rufen Sie eine Liste der Pipelines ab.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- orderBy
-
string
Ein Sortierausdruck. Standardmäßig wird "name asc" verwendet.
- top
-
number
Die maximale Anzahl von Pipelines, die zurückgegeben werden sollen
- continuationToken
-
string
Ein Fortsetzungstoken aus einer vorherigen Anforderung, um die nächste Ergebnisseite abzurufen
Gibt zurück
Promise<Pipeline[]>
listRuns(string, number)
Ruft die ersten 10.000-Ausführungen für eine bestimmte Pipeline ab.
function listRuns(project: string, pipelineId: number): Promise<Run[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die Pipeline-ID
Gibt zurück
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
Stellt eine Trockenausführung der Pipeline in die Warteschlange und gibt ein Objekt zurück, das den endgültigen yaml enthält.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>Parameter
- runParameters
- RunPipelineParameters
Optionale zusätzliche Parameter für diese Ausführung.
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die Pipeline-ID.
- pipelineVersion
-
number
Die Pipelineversion.
Gibt zurück
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
Führt eine Pipeline aus.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>Parameter
- runParameters
- RunPipelineParameters
Optionale zusätzliche Parameter für diese Ausführung.
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die Pipeline-ID.
- pipelineVersion
-
number
Die Pipelineversion.
Gibt zurück
Promise<Run>