PipelinesRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Pipelines |
Methoden
| create |
Erstellen Sie eine 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 der Protokolle aus einer Pipelineausführung ab. |
| list |
Rufen Sie eine Liste der Pipelines ab. |
| list |
Ruft die Top 10000 Ausführungen für eine bestimmte Pipeline ab. |
| preview(Run |
Stellt einen Probelauf der Pipeline in die Warteschlange und gibt ein Objekt zurück, das die endgültige YAML-Datei enthält. |
| run |
Führt eine Pipeline aus. |
Details zum Konstruktor
PipelinesRestClient(IVssRestClientOptions)
Details zur Methode
createPipeline(CreatePipelineParameters, string)
Erstellen Sie eine 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
Erweitern Sie die Optionen. Der Standardwert ist Keine.
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
Erweitern Sie die Optionen. Der Standardwert ist Keine.
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 Pipeline-Version
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 der Protokolle 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
Erweitern Sie die Optionen. Der Standardwert ist Keine.
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 ist "name asc"
- top
-
number
Die maximale Anzahl von Pipelines, die zurückgegeben werden sollen
- continuationToken
-
string
Ein Fortsetzungstoken aus einer vorherigen Anforderung, um die nächste Seite mit den Ergebnissen abzurufen
Gibt zurück
Promise<Pipeline[]>
listRuns(string, number)
Ruft die Top 10000 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 einen Probelauf der Pipeline in die Warteschlange und gibt ein Objekt zurück, das die endgültige YAML-Datei enthält.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>Parameter
- runParameters
- RunPipelineParameters
Optionale zusätzliche Parameter für diesen Lauf.
- 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 diesen Lauf.
- project
-
string
Projekt-ID oder Projektname
- pipelineId
-
number
Die Pipeline-ID.
- pipelineVersion
-
number
Die Pipelineversion.
Gibt zurück
Promise<Run>