BuildRestClient class

Paket:: azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends: RestClientBase

Konstruktorer

Egenskaper

Metoder

addBuildTag(string, number, string)	Lägger till en tagg i en version.
addBuildTags(string[], string, number)	Lägger till taggar i en version.
addDefinitionTag(string, number, string)	Lägger till en tagg i en definition
addDefinitionTags(string[], string, number)	Lägger till flera taggar i en definition.
addRetentionLeases(NewRetentionLease[], string)	Lägger till nya lån för pipelinekörningar.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Associerar en artefakt med en version.
createDefinition(BuildDefinition, string, number, number)	Skapar en ny definition.
createFolder(Folder, string, string)	Skapar en ny mapp.
deleteBuild(string, number)	Tar bort en version.
deleteBuildTag(string, number, string)	Tar bort en tagg från en version. OBS! Det här API:et fungerar inte för taggar med specialtecken. Om du vill ta bort taggar med specialtecken använder du METODEN PATCH i stället (i 6.0+)
deleteDefinition(string, number)	Tar bort en definition och alla associerade versioner.
deleteDefinitionTag(string, number, string)	Tar bort en tagg från en definition. OBS! Det här API:et fungerar inte för taggar med specialtecken. Om du vill ta bort taggar med specialtecken använder du METODEN PATCH i stället (i 6.0+)
deleteFolder(string, string)	Tar bort en definitionsmapp. Definitioner och deras motsvarande versioner tas också bort.
deleteRetentionLeasesById(string, number[])	Tar bort specifika kvarhållningslån.
deleteTag(string, string)	Tar bort en tagg från versioner, definitioner och från taggarkivet
deleteTemplate(string, string)	Tar bort en mall för byggdefinitioner.
getArtifact(string, number, string)	Hämtar en specifik artefakt för en version.
getArtifactContentZip(string, number, string)	Hämtar en specifik artefakt för en version.
getArtifacts(string, number)	Hämtar alla artefakter för en version.
getAttachment(string, number, string, string, string, string)	Hämtar en specifik bifogad fil.
getAttachments(string, number, string)	Hämtar listan över bifogade filer av en viss typ som är associerade med en version.
getBadge(string, number, string)	Hämtar ett märke som anger status för den senaste versionen för en definition. Observera att det här API:et är inaktuellt. Föredrar StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Hämtar ett bygge
getBuildBadge(string, string, string, string)	Hämtar ett märke som anger status för den senaste versionen för den angivna grenen.
getBuildBadgeData(string, string, string, string)	Hämtar ett märke som anger status för den senaste versionen för den angivna grenen.
getBuildChanges(string, number, string, number, boolean)	Hämtar ändringarna som är associerade med en version
getBuildController(number)	Hämtar en kontrollant
getBuildControllers(string)	Hämtar kontrollant, eventuellt filtrerad efter namn
getBuildGeneralSettings(string)	Hämtar allmänna inställningar för pipeline.
getBuildLog(string, number, number, number, number)	Hämtar en enskild loggfil för ett bygge.
getBuildLogLines(string, number, number, number, number)	Hämtar en enskild loggfil för ett bygge.
getBuildLogs(string, number)	Hämtar loggarna för en version.
getBuildLogsZip(string, number)	Hämtar loggarna för en version.
getBuildLogZip(string, number, number, number, number)	Hämtar en enskild loggfil för ett bygge.
getBuildOptionDefinitions(string)	Hämtar alla byggdefinitionsalternativ som stöds av systemet.
getBuildProperties(string, number, string[])	Hämtar egenskaper för ett bygge.
getBuildReport(string, number, string)	Hämtar en byggrapport.
getBuildReportHtmlContent(string, number, string)	Hämtar en byggrapport.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Hämtar en lista över versioner.
getBuildSettings(string)	Hämtar bygginställningarna.
getBuildTags(string, number)	Hämtar taggarna för ett bygge.
getBuildTimeline(string, number, string, number, string)	Hämtar information för ett bygge
getBuildWorkItemsRefs(string, number, number)	Hämtar de arbetsobjekt som är associerade med en version. Endast arbetsobjekt i samma projekt returneras.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Hämtar de arbetsobjekt som är associerade med en bygge, filtrerade efter specifika incheckningar.
getChangesBetweenBuilds(string, number, number, number)	Hämtar de ändringar som gjorts i lagringsplatsen mellan två angivna versioner.
getDefinition(string, number, number, Date, string[], boolean)	Hämtar en definition, om du vill vid en specifik revision.
getDefinitionMetrics(string, number, Date)	Hämtar byggmått för en definition.
getDefinitionProperties(string, number, string[])	Hämtar egenskaper för en definition.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Hämtar alla revisioner av en definition.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Hämtar en lista med definitioner.
getDefinitionTags(string, number, number)	Hämtar taggarna för en definition.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Konverterar en definition till YAML, om du vill vid en viss revision.
getFile(string, number, string, string, string)	Hämtar en fil från bygget.
getFileContents(string, string, string, string, string, string)	Hämtar innehållet i en fil i den angivna källkodslagringsplatsen.
getFolders(string, string, FolderQueryOrder)	Hämtar en lista över versionsdefinitionsmappar.
getLatestBuild(string, string, string)	Hämtar den senaste versionen för en definition, eventuellt begränsad till en specifik gren.
getPathContents(string, string, string, string, string, string)	Hämtar innehållet i en katalog i den angivna källkodslagringsplatsen.
getProjectMetrics(string, string, Date)	Hämtar byggmått för ett projekt.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Hämtar ett pull-begärandeobjekt från källprovidern.
getResourceUsage()	Hämtar information om byggresurser i systemet.
getRetentionHistory(number)	Returnerar kvarhållningshistoriken för projektsamlingen. Detta omfattar pipelines som har anpassade kvarhållningsregler som kan förhindra att kvarhållningsjobbet rensar dem, körs per pipeline med kvarhållningstyp, filer som är associerade med pipelines som ägs av samlingen med kvarhållningstyp och antalet filer per pipeline.
getRetentionLease(string, number)	Returnerar information om kvarhållningslånet med ett låne-ID.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Returnerar lån som matchar angivna MinimalRetentionLeases
getRetentionLeasesByOwnerId(string, string, number, number)	Returnerar alla lån som ägs av den angivna entiteten, eventuellt begränsade till en enda pipelinedefinition och körning.
getRetentionLeasesByUserId(string, string, number, number)	Returnerar lån som ägs av den angivna användaren, eventuellt begränsade till en enda pipelinedefinition och körning.
getRetentionLeasesForBuild(string, number)	Hämtar alla kvarhållningslån som gäller för en specifik version.
getRetentionSettings(string)	Hämtar projektets kvarhållningsinställningar.
getStatusBadge(string, string, string, string, string, string, string)	<p>Hämtar versionsstatus för en definition, om möjligt omfång för en viss gren, fas, jobb och konfiguration.</p><p>Om det finns fler än en måste du skicka ett stageName-värde när du anger ett jobName, och samma regel gäller sedan för båda om du skickar en konfigurationsparameter.</p>
getTags(string)	Hämtar en lista över alla byggtaggar i projektet.
getTemplate(string, string)	Hämtar en specifik mall för byggdefinitioner.
getTemplates(string)	Hämtar alla definitionsmallar.
getWorkItemsBetweenBuilds(string, number, number, number)	Hämtar alla arbetsobjekt mellan två versioner.
listBranches(string, string, string, string, string)	Hämtar en lista över grenar för den angivna källkodslagringsplatsen.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Hämtar en lista över lagringsplatser för källkod.
listSourceProviders(string)	Hämta en lista över källprovidrar och deras funktioner.
listWebhooks(string, string, string, string)	Hämtar en lista över webhooks installerade på den angivna källkodslagringsplatsen.
queueBuild(Build, string, boolean, string, number, number)	Köar ett bygge
restoreDefinition(string, number, boolean)	Återställer en borttagen definition
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Återskapar webhooks för de angivna utlösarna i den angivna källkodslagringsplatsen.
saveTemplate(BuildDefinitionTemplate, string, string)	Uppdaterar en befintlig mall för byggdefinitioner.
updateBuild(Build, string, number, boolean)	Uppdaterar en version.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Uppdaterar allmänna inställningar för pipelinen.
updateBuildProperties(JsonPatchDocument, string, number)	Uppdaterar egenskaper för en version.
updateBuilds(Build[], string)	Uppdaterar flera versioner.
updateBuildSettings(BuildSettings, string)	Uppdaterar bygginställningarna.
updateBuildTags(UpdateTagParameters, string, number)	Lägger till/tar bort taggar från en version.
updateDefinition(BuildDefinition, string, number, number, number)	Uppdaterar en befintlig byggdefinition. För att den här åtgärden ska lyckas måste värdet för egenskapen "Revision" för begärandetexten matcha den befintliga versionsdefinitionens. Vi rekommenderar att du hämtar den befintliga byggdefinitionen med hjälp av GET, ändrar versionsdefinitionen efter behov och sedan skickar den ändrade definitionen med PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Uppdaterar egenskaper för en definition.
updateDefinitionTags(UpdateTagParameters, string, number)	Lägger till/tar bort taggar från en definition.
updateFolder(Folder, string, string)	Uppdaterar en befintlig mapp på angiven befintlig sökväg
updateRetentionLease(RetentionLeaseUpdate, string, number)	Uppdaterar varaktigheten eller pipelineskyddsstatusen för ett kvarhållningslån.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Uppdaterar projektets kvarhållningsinställningar.
updateStage(UpdateStageParameters, number, string, string)	Uppdatera en byggfas

Konstruktorinformation

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addBuildTag(string, number, string)

Lägger till en tagg i en version.

function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

tag: string

Taggen som ska läggas till.

Returer

Promise<string[]>

addBuildTags(string[], string, number)

Lägger till taggar i en version.

function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>

Parametrar

tags: string[]

Taggarna som ska läggas till. Begärandetexten består direkt från taggarna i listan.

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<string[]>

addDefinitionTag(string, number, string)

Lägger till en tagg i en definition

function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

tag: string

Taggen som ska läggas till.

Returer

Promise<string[]>

addDefinitionTags(string[], string, number)

Lägger till flera taggar i en definition.

function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>

Parametrar

tags: string[]

Taggarna som ska läggas till.

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

Returer

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Lägger till nya lån för pipelinekörningar.

function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>

Parametrar

newLeases: NewRetentionLease[]

project: string

Projekt-ID eller projektnamn

Returer

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Parametrar

resources: DefinitionResourceReference[]

project: string

Projekt-ID eller projektnamn

definitionId: number

Returer

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>

Parametrar

resources: DefinitionResourceReference[]

project: string

Projekt-ID eller projektnamn

Returer

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Associerar en artefakt med en version.

function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>

Parametrar

artifact: BuildArtifact

Artefakten.

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Skapar en ny definition.

function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>

Parametrar

definition: BuildDefinition

Definitionen.

project: string

Projekt-ID eller projektnamn

definitionToCloneId: number

definitionToCloneRevision: number

Returer

Promise<BuildDefinition>

createFolder(Folder, string, string)

Skapar en ny mapp.

function createFolder(folder: Folder, project: string, path: string): Promise<Folder>

Parametrar

folder: Folder

Mappen.

project: string

Projekt-ID eller projektnamn

path: string

Mappens fullständiga sökväg.

Returer

Promise<Folder>

deleteBuild(string, number)

Tar bort en version.

function deleteBuild(project: string, buildId: number): Promise<void>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<void>

deleteBuildTag(string, number, string)

Tar bort en tagg från en version. OBS! Det här API:et fungerar inte för taggar med specialtecken. Om du vill ta bort taggar med specialtecken använder du METODEN PATCH i stället (i 6.0+)

function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

tag: string

Taggen som du vill ta bort.

Returer

Promise<string[]>

deleteDefinition(string, number)

Tar bort en definition och alla associerade versioner.

function deleteDefinition(project: string, definitionId: number): Promise<void>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

Returer

Promise<void>

deleteDefinitionTag(string, number, string)

Tar bort en tagg från en definition. OBS! Det här API:et fungerar inte för taggar med specialtecken. Om du vill ta bort taggar med specialtecken använder du METODEN PATCH i stället (i 6.0+)

function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

tag: string

Taggen som du vill ta bort.

Returer

Promise<string[]>

deleteFolder(string, string)

Tar bort en definitionsmapp. Definitioner och deras motsvarande versioner tas också bort.

function deleteFolder(project: string, path: string): Promise<void>

Parametrar

project: string

Projekt-ID eller projektnamn

path: string

Den fullständiga sökvägen till mappen.

Returer

Promise<void>

deleteRetentionLeasesById(string, number[])

Tar bort specifika kvarhållningslån.

function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

Parametrar

project: string

Projekt-ID eller projektnamn

ids: number[]

Returer

Promise<void>

deleteTag(string, string)

Tar bort en tagg från versioner, definitioner och från taggarkivet

function deleteTag(project: string, tag: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

tag: string

Taggen som du vill ta bort.

Returer

Promise<string[]>

deleteTemplate(string, string)

Tar bort en mall för byggdefinitioner.

function deleteTemplate(project: string, templateId: string): Promise<void>

Parametrar

project: string

Projekt-ID eller projektnamn

templateId: string

Mallens ID.

Returer

Promise<void>

getArtifact(string, number, string)

Hämtar en specifik artefakt för en version.

function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

artifactName: string

Artefaktens namn.

Returer

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Hämtar en specifik artefakt för en version.

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

artifactName: string

Artefaktens namn.

Returer

Promise<ArrayBuffer>

getArtifacts(string, number)

Hämtar alla artefakter för en version.

function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<BuildArtifact[]>

getAttachment(string, number, string, string, string, string)

Hämtar en specifik bifogad fil.

function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

timelineId: string

Tidslinjens ID.

recordId: string

ID för tidslinjeposten.

type: string

Typ av bifogad fil.

name: string

Namnet på den bifogade filen.

Returer

Promise<ArrayBuffer>

getAttachments(string, number, string)

Hämtar listan över bifogade filer av en viss typ som är associerade med en version.

function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

type: string

Typ av bifogad fil.

Returer

Promise<Attachment[]>

getBadge(string, number, string)

Hämtar ett märke som anger status för den senaste versionen för en definition. Observera att det här API:et är inaktuellt. Föredrar StatusBadgeController.GetStatusBadge.

function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>

Parametrar

project: string

Projekt-ID eller namn.

definitionId: number

Definitionens ID.

branchName: string

Namnet på grenen.

Returer

Promise<string>

getBuild(string, number, string)

Hämtar ett bygge

function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

propertyFilters: string

Returer

Promise<Build>

getBuildBadge(string, string, string, string)

Hämtar ett märke som anger status för den senaste versionen för den angivna grenen.

function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>

Parametrar

project: string

Projekt-ID eller projektnamn

repoType: string

Lagringsplatsens typ.

repoId: string

Lagringsplatsens ID.

branchName: string

Grennamnet.

Returer

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Hämtar ett märke som anger status för den senaste versionen för den angivna grenen.

function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>

Parametrar

project: string

Projekt-ID eller projektnamn

repoType: string

Lagringsplatsens typ.

repoId: string

Lagringsplatsens ID.

branchName: string

Grennamnet.

Returer

Promise<string>

getBuildChanges(string, number, string, number, boolean)

Hämtar ändringarna som är associerade med en version

function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

continuationToken: string

top: number

Det maximala antalet ändringar som ska returneras

includeSourceChange: boolean

Returer

Promise<PagedList<Change>>

getBuildController(number)

Hämtar en kontrollant

function getBuildController(controllerId: number): Promise<BuildController>

Parametrar

controllerId: number

Returer

Promise<BuildController>

getBuildControllers(string)

Hämtar kontrollant, eventuellt filtrerad efter namn

function getBuildControllers(name?: string): Promise<BuildController[]>

Parametrar

name: string

Returer

Promise<BuildController[]>

getBuildGeneralSettings(string)

Hämtar allmänna inställningar för pipeline.

function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

Hämtar en enskild loggfil för ett bygge.

function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

logId: number

Loggfilens ID.

startLine: number

Startraden.

endLine: number

Slutlinjen.

Returer

Promise<string>

getBuildLogLines(string, number, number, number, number)

Hämtar en enskild loggfil för ett bygge.

function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

logId: number

Loggfilens ID.

startLine: number

Startraden.

endLine: number

Slutlinjen.

Returer

Promise<string[]>

getBuildLogs(string, number)

Hämtar loggarna för en version.

function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Hämtar loggarna för en version.

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

Hämtar en enskild loggfil för ett bygge.

function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

logId: number

Loggfilens ID.

startLine: number

Startraden.

endLine: number

Slutlinjen.

Returer

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Hämtar alla byggdefinitionsalternativ som stöds av systemet.

function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Hämtar egenskaper för ett bygge.

function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

filter: string[]

En kommaavgränsad lista med egenskaper. Om det anges filtrerar du efter dessa specifika egenskaper.

Returer

Promise<any>

getBuildReport(string, number, string)

Hämtar en byggrapport.

function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

type: string

Returer

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Hämtar en byggrapport.

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

type: string

Returer

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

Hämtar en lista över versioner.

function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>

Parametrar

project: string

Projekt-ID eller projektnamn

definitions: number[]

En kommaavgränsad lista över definitions-ID:t. Om det anges filtrerar du till versioner för dessa definitioner.

queues: number[]

En kommaavgränsad lista över kö-ID:t. Om det anges filtrerar du till versioner som kördes mot dessa köer.

buildNumber: string

Om det anges filtrerar du till versioner som matchar det här versionsnumret. Lägg till * för att göra en prefixsökning.

minTime: Date

Om det anges filtreras till versioner som har slutförts/startats/köat efter det här datumet baserat på den angivna queryOrdern.

maxTime: Date

Om det anges filtreras till versioner som har slutförts/startats/köat före det här datumet baserat på den angivna queryOrdern.

requestedFor: string

Om det anges filtrerar du till versioner som begärs för den angivna användaren.

reasonFilter: BuildReason

Om det anges filtrerar du till versioner som matchar den här orsaken.

statusFilter: BuildStatus

Om det anges filtrerar du till versioner som matchar den här statusen.

resultFilter: BuildResult

Om det anges filtrerar du till versioner som matchar det här resultatet.

tagFilters: string[]

En kommaavgränsad lista med taggar. Om det anges filtrerar du till versioner som har de angivna taggarna.

properties: string[]

En kommaavgränsad lista över egenskaper som ska hämtas.

top: number

Det maximala antalet versioner som ska returneras.

continuationToken: string

En fortsättningstoken, som returnerades av ett tidigare anrop till den här metoden, som kan användas för att returnera nästa uppsättning versioner.

maxBuildsPerDefinition: number

Det maximala antalet versioner som ska returneras per definition.

deletedFilter: QueryDeletedOption

Anger om du vill exkludera, inkludera eller endast returnera borttagna versioner.

queryOrder: BuildQueryOrder

I vilken ordning byggen ska returneras.

branchName: string

Om det anges filtrerar du till byggen som har skapat grenar som har skapat den här grenen.

buildIds: number[]

En kommaavgränsad lista som anger ID:t för versioner som ska hämtas.

repositoryId: string

Om det anges filtrerar du till versioner som skapats från den här lagringsplatsen.

repositoryType: string

Om det anges filtrerar du till versioner som skapats från lagringsplatser av den här typen.

Returer

Promise<PagedList<Build>>

getBuildSettings(string)

Hämtar bygginställningarna.

function getBuildSettings(project?: string): Promise<BuildSettings>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<BuildSettings>

getBuildTags(string, number)

Hämtar taggarna för ett bygge.

function getBuildTags(project: string, buildId: number): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

Hämtar information för ett bygge

function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

timelineId: string

changeId: number

planId: string

Returer

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Hämtar de arbetsobjekt som är associerade med en version. Endast arbetsobjekt i samma projekt returneras.

function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

top: number

Det maximala antalet arbetsobjekt som ska returneras.

Returer

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

Hämtar de arbetsobjekt som är associerade med en bygge, filtrerade efter specifika incheckningar.

function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Parametrar

commitIds: string[]

En kommaavgränsad lista över inchecknings-ID:t.

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

top: number

Det maximala antalet arbetsobjekt som ska returneras eller antalet incheckningar att överväga om inga inchecknings-ID:n har angetts.

Returer

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Hämtar de ändringar som gjorts i lagringsplatsen mellan två angivna versioner.

function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>

Parametrar

project: string

Projekt-ID eller projektnamn

fromBuildId: number

ID:t för den första versionen.

toBuildId: number

ID:t för den senaste versionen.

top: number

Det maximala antalet ändringar som ska returneras.

Returer

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

Hämtar en definition, om du vill vid en specifik revision.

function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

revision: number

Revisionsnumret som ska hämtas. Om detta inte anges returneras den senaste versionen.

minMetricsTime: Date

Om det anges anger det datum från vilket mått ska inkluderas.

propertyFilters: string[]

En kommaavgränsad lista över egenskaper som ska inkluderas i resultaten.

includeLatestBuilds: boolean

Returer

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Hämtar byggmått för en definition.

function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

minMetricsTime: Date

Det datum från vilket mått ska beräknas.

Returer

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Hämtar egenskaper för en definition.

function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

filter: string[]

En kommaavgränsad lista med egenskaper. Om det anges filtrerar du efter dessa specifika egenskaper.

Returer

Promise<any>

getDefinitionResources(string, number)

function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Returer

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Hämtar alla revisioner av en definition.

function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

Returer

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

Hämtar en lista med definitioner.

function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>

Parametrar

project: string

Projekt-ID eller projektnamn

name: string

Om det anges filtreras till definitioner vars namn matchar det här mönstret.

repositoryId: string

Ett lagringsplats-ID. Om det anges filtrerar du till definitioner som använder den här lagringsplatsen.

repositoryType: string

Om det anges filtrerar du till definitioner som har en lagringsplats av den här typen.

queryOrder: DefinitionQueryOrder

Anger i vilken ordning definitioner ska returneras.

top: number

Det maximala antalet definitioner som ska returneras.

continuationToken: string

En fortsättningstoken, som returnerades av ett tidigare anrop till den här metoden, som kan användas för att returnera nästa uppsättning definitioner.

minMetricsTime: Date

Om det anges anger det datum från vilket mått ska inkluderas.

definitionIds: number[]

En kommaavgränsad lista som anger ID:t för definitioner som ska hämtas.

path: string

Om det anges filtrerar du till definitioner under den här mappen.

builtAfter: Date

Om det anges filtrerar du till definitioner som har versioner efter det här datumet.

notBuiltAfter: Date

Om det anges filtrerar du till definitioner som inte har versioner efter det här datumet.

includeAllProperties: boolean

Anger om de fullständiga definitionerna ska returneras. Som standard returneras ytliga representationer av definitionerna.

includeLatestBuilds: boolean

Anger om du vill returnera de senaste och senaste färdiga versionerna för den här definitionen.

taskIdFilter: string

Om det anges filtrerar du till definitioner som använder den angivna aktiviteten.

processType: number

Om det anges filtrerar du till definitioner med den angivna processtypen.

yamlFilename: string

Om det anges filtrerar du till YAML-definitioner som matchar det angivna filnamnet. Om du vill använda det här filtret ska includeAllProperties anges till true

Returer

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Hämtar taggarna för en definition.

function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

revision: number

Definitionsrevisionsnumret. Om det inte anges använder du den senaste revisionen av definitionen.

Returer

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

Konverterar en definition till YAML, om du vill vid en viss revision.

function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

revision: number

Revisionsnumret som ska hämtas. Om detta inte anges returneras den senaste versionen.

minMetricsTime: Date

Om det anges anger det datum från vilket mått ska inkluderas.

propertyFilters: string[]

En kommaavgränsad lista över egenskaper som ska inkluderas i resultaten.

includeLatestBuilds: boolean

Returer

Promise<YamlBuild>

getFile(string, number, string, string, string)

Hämtar en fil från bygget.

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

artifactName: string

Artefaktens namn.

fileId: string

Den primära nyckeln för filen.

fileName: string

Namnet som filen ska anges till.

Returer

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

Hämtar innehållet i en fil i den angivna källkodslagringsplatsen.

function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>

Parametrar

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

repository: string

Om det anges den leverantörsspecifika identifieraren eller namnet på lagringsplatsen för att hämta grenar. Kan bara utelämnas för leverantörer som inte stöder flera lagringsplatser.

commitOrBranch: string

Identifieraren för incheckningen eller grenen som en fils innehåll hämtas från.

path: string

Sökvägen till filen som ska hämtas i förhållande till lagringsplatsens rot.

Returer

Promise<string>

getFolders(string, string, FolderQueryOrder)

Hämtar en lista över versionsdefinitionsmappar.

function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>

Parametrar

project: string

Projekt-ID eller projektnamn

path: string

Sökvägen att börja med.

queryOrder: FolderQueryOrder

I vilken ordning mappar ska returneras.

Returer

Promise<Folder[]>

getLatestBuild(string, string, string)

Hämtar den senaste versionen för en definition, eventuellt begränsad till en specifik gren.

function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>

Parametrar

project: string

Projekt-ID eller projektnamn

definition: string

definitionsnamn med valfri inledande mappsökväg eller definitions-ID

branchName: string

valfri parameter som anger den specifika gren som ska användas. Om den inte anges används standardgrenen.

Returer

Promise<Build>

getPathContents(string, string, string, string, string, string)

Hämtar innehållet i en katalog i den angivna källkodslagringsplatsen.

function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>

Parametrar

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

repository: string

Om det anges den leverantörsspecifika identifieraren eller namnet på lagringsplatsen för att hämta grenar. Kan bara utelämnas för leverantörer som inte stöder flera lagringsplatser.

commitOrBranch: string

Identifieraren för incheckningen eller grenen som en fils innehåll hämtas från.

path: string

Sökvägsinnehållet som ska listas i förhållande till lagringsplatsens rot.

Returer

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Hämtar byggmått för ett projekt.

function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>

Parametrar

project: string

Projekt-ID eller projektnamn

metricAggregationType: string

Den sammansättningstyp som ska användas (varje timme, varje dag).

minMetricsTime: Date

Det datum från vilket mått ska beräknas.

Returer

Promise<BuildMetric[]>

getProjectResources(string, string, string)

function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

id: string

Returer

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

Hämtar ett pull-begärandeobjekt från källprovidern.

function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>

Parametrar

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

pullRequestId: string

Leverantörsspecifikt ID för pull-begäran.

repositoryId: string

Leverantörsspecifik identifierare eller namnet på lagringsplatsen som innehåller pull-begäran.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

Returer

Promise<PullRequest>

getResourceUsage()

Hämtar information om byggresurser i systemet.

function getResourceUsage(): Promise<BuildResourceUsage>

Returer

Promise<BuildResourceUsage>

getRetentionHistory(number)

Returnerar kvarhållningshistoriken för projektsamlingen. Detta omfattar pipelines som har anpassade kvarhållningsregler som kan förhindra att kvarhållningsjobbet rensar dem, körs per pipeline med kvarhållningstyp, filer som är associerade med pipelines som ägs av samlingen med kvarhållningstyp och antalet filer per pipeline.

function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

Parametrar

daysToLookback: number

Returer

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Returnerar information om kvarhållningslånet med ett låne-ID.

function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

Parametrar

project: string

Projekt-ID eller projektnamn

leaseId: number

Returer

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Returnerar lån som matchar angivna MinimalRetentionLeases

function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>

Parametrar

project: string

Projekt-ID eller projektnamn

leasesToFetch: MinimalRetentionLease[]

Lista över JSON-serialiserade MinimalRetentionLeases avgränsade med |

Returer

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Returnerar alla lån som ägs av den angivna entiteten, eventuellt begränsade till en enda pipelinedefinition och körning.

function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Parametrar

project: string

Projekt-ID eller projektnamn

ownerId: string

definitionId: number

En valfri parameter för att begränsa sökningen till en specifik pipelinedefinition.

runId: number

En valfri parameter för att begränsa sökningen till en enda pipelinekörning. Kräver definitionId.

Returer

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Returnerar lån som ägs av den angivna användaren, eventuellt begränsade till en enda pipelinedefinition och körning.

function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Parametrar

project: string

Projekt-ID eller projektnamn

userOwnerId: string

Användar-ID:t att söka efter.

definitionId: number

En valfri parameter för att begränsa sökningen till en specifik pipelinedefinition.

runId: number

En valfri parameter för att begränsa sökningen till en enda pipelinekörning. Kräver definitionId.

Returer

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Hämtar alla kvarhållningslån som gäller för en specifik version.

function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<RetentionLease[]>

getRetentionSettings(string)

Hämtar projektets kvarhållningsinställningar.

function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p>Hämtar versionsstatus för en definition, om möjligt omfång för en viss gren, fas, jobb och konfiguration.</p><p>Om det finns fler än en måste du skicka ett stageName-värde när du anger ett jobName, och samma regel gäller sedan för båda om du skickar en konfigurationsparameter.</p>

function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>

Parametrar

project: string

Projekt-ID eller projektnamn

definition: string

Antingen definitionsnamnet med valfri inledande mappsökväg eller definitions-ID.

branchName: string

Tänk bara på den senaste versionen för den här grenen. Om den inte anges används standardgrenen.

stageName: string

Använd det här steget i pipelinen för att återge statusen.

jobName: string

Använd det här jobbet i ett steg i pipelinen för att återge statusen.

configuration: string

Använd den här jobbkonfigurationen för att återge statusen

label: string

Ersätter standardtexten till vänster i märket.

Returer

Promise<string>

getTags(string)

Hämtar en lista över alla byggtaggar i projektet.

function getTags(project: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<string[]>

getTemplate(string, string)

Hämtar en specifik mall för byggdefinitioner.

function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>

Parametrar

project: string

Projekt-ID eller projektnamn

templateId: string

ID för den begärda mallen.

Returer

Promise<BuildDefinitionTemplate>

getTemplates(string)

Hämtar alla definitionsmallar.

function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Hämtar alla arbetsobjekt mellan två versioner.

function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>

Parametrar

project: string

Projekt-ID eller projektnamn

fromBuildId: number

ID:t för den första versionen.

toBuildId: number

ID:t för den senaste versionen.

top: number

Det maximala antalet arbetsobjekt som ska returneras.

Returer

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

Hämtar en lista över grenar för den angivna källkodslagringsplatsen.

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>

Parametrar

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

repository: string

Den leverantörsspecifika identifieraren eller namnet på lagringsplatsen för att hämta grenar. Kan bara utelämnas för leverantörer som inte stöder flera lagringsplatser.

branchName: string

Om det anges namnet på grenen för att söka efter specifikt.

Returer

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

Hämtar en lista över lagringsplatser för källkod.

function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>

Parametrar

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

repository: string

Om det anges den leverantörsspecifika identifieraren eller namnet på en enda lagringsplats att hämta.

resultSet: ResultSet

"top" för de lagringsplatser som är mest relevanta för slutpunkten. Om den inte har angetts returneras alla lagringsplatser. Ignoreras om "lagringsplats" har angetts.

pageResults: boolean

Om värdet är true begränsar detta resultatuppsättningen och returnerar en fortsättningstoken för att fortsätta frågan.

continuationToken: string

Vid växling av resultat är detta en fortsättningstoken, som returnerades av ett tidigare anrop till den här metoden, som kan användas för att returnera nästa uppsättning lagringsplatser.

Returer

Promise<SourceRepositories>

listSourceProviders(string)

Hämta en lista över källprovidrar och deras funktioner.

function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Hämtar en lista över webhooks installerade på den angivna källkodslagringsplatsen.

function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>

Parametrar

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

repository: string

Om det anges, den leverantörsspecifika identifieraren eller namnet på lagringsplatsen för att hämta webhooks. Kan bara utelämnas för leverantörer som inte stöder flera lagringsplatser.

Returer

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

Köar ett bygge

function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>

Parametrar

build: Build

project: string

Projekt-ID eller projektnamn

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Valfritt definitions-ID för att köa ett bygge utan brödtext. Ignoreras om det finns en giltig brödtext

Returer

Promise<Build>

restoreDefinition(string, number, boolean)

Återställer en borttagen definition

function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>

Parametrar

project: string

Projekt-ID eller projektnamn

definitionId: number

Identifieraren för definitionen som ska återställas.

deleted: boolean

När värdet är falskt återställs en borttagen definition.

Returer

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

Återskapar webhooks för de angivna utlösarna i den angivna källkodslagringsplatsen.

function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>

Parametrar

triggerTypes: DefinitionTriggerType[]

De typer av utlösare som du vill återställa webhooks för.

project: string

Projekt-ID eller projektnamn

providerName: string

Namnet på källprovidern.

serviceEndpointId: string

Om det anges frågar ID:t för tjänstslutpunkten. Kan endast utelämnas för leverantörer som inte använder tjänstslutpunkter, t.ex. TFVC eller TFGit.

repository: string

Om det anges, den leverantörsspecifika identifieraren eller namnet på lagringsplatsen för att hämta webhooks. Kan bara utelämnas för leverantörer som inte stöder flera lagringsplatser.

Returer

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Uppdaterar en befintlig mall för byggdefinitioner.

function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>

Parametrar

template: BuildDefinitionTemplate

Den nya versionen av mallen.

project: string

Projekt-ID eller projektnamn

templateId: string

Mallens ID.

Returer

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Uppdaterar en version.

function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>

Parametrar

build: Build

Bygget.

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

retry: boolean

Returer

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Uppdaterar allmänna inställningar för pipelinen.

function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>

Parametrar

newSettings: PipelineGeneralSettings

project: string

Projekt-ID eller projektnamn

Returer

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Uppdaterar egenskaper för en version.

function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>

Parametrar

document: JsonPatchDocument

Ett json-patch-dokument som beskriver de egenskaper som ska uppdateras.

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<any>

updateBuilds(Build[], string)

Uppdaterar flera versioner.

function updateBuilds(builds: Build[], project: string): Promise<Build[]>

Parametrar

builds: Build[]

De versioner som ska uppdateras.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Uppdaterar bygginställningarna.

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

Parametrar

settings: BuildSettings

De nya inställningarna.

project: string

Projekt-ID eller projektnamn

Returer

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Lägger till/tar bort taggar från en version.

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

Parametrar

updateParameters: UpdateTagParameters

Taggarna som ska läggas till/ta bort.

project: string

Projekt-ID eller projektnamn

buildId: number

ID:t för bygget.

Returer

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number)

Uppdaterar en befintlig byggdefinition. För att den här åtgärden ska lyckas måste värdet för egenskapen "Revision" för begärandetexten matcha den befintliga versionsdefinitionens. Vi rekommenderar att du hämtar den befintliga byggdefinitionen med hjälp av GET, ändrar versionsdefinitionen efter behov och sedan skickar den ändrade definitionen med PUT.

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>

Parametrar

definition: BuildDefinition

Den nya versionen av definitionen. Egenskapen "Revision" måste matcha den befintliga definitionen för att uppdateringen ska accepteras.

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Returer

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Uppdaterar egenskaper för en definition.

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

Parametrar

document: JsonPatchDocument

Ett json-patch-dokument som beskriver de egenskaper som ska uppdateras.

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

Returer

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Lägger till/tar bort taggar från en definition.

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

Parametrar

updateParameters: UpdateTagParameters

Taggarna som ska läggas till/ta bort.

project: string

Projekt-ID eller projektnamn

definitionId: number

Definitionens ID.

Returer

Promise<string[]>

updateFolder(Folder, string, string)

Uppdaterar en befintlig mapp på angiven befintlig sökväg

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

Parametrar

folder: Folder

Den nya versionen av mappen.

project: string

Projekt-ID eller projektnamn

path: string

Den fullständiga sökvägen till mappen.

Returer

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Uppdaterar varaktigheten eller pipelineskyddsstatusen för ett kvarhållningslån.

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

Parametrar

leaseUpdate: RetentionLeaseUpdate

De nya data för kvarhållningslånet.

project: string

Projekt-ID eller projektnamn

leaseId: number

ID:t för lånet som ska uppdateras.

Returer

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Uppdaterar projektets kvarhållningsinställningar.

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

Parametrar

updateModel: UpdateProjectRetentionSettingModel

project: string

Projekt-ID eller projektnamn

Returer

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Uppdatera en byggfas

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

Parametrar

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

Feedback

Var den här sidan till hjälp?

Dela via

BuildRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

BuildRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

addBuildTag(string, number, string)

Parametrar

Returer

addBuildTags(string[], string, number)

Parametrar

Returer

addDefinitionTag(string, number, string)

Parametrar

Returer

addDefinitionTags(string[], string, number)

Parametrar

Returer

addRetentionLeases(NewRetentionLease[], string)

Parametrar

Returer

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parametrar

Returer

authorizeProjectResources(DefinitionResourceReference[], string)

Parametrar

Returer

createArtifact(BuildArtifact, string, number)

Parametrar

Returer

createDefinition(BuildDefinition, string, number, number)

Parametrar

Returer

createFolder(Folder, string, string)

Parametrar

Returer

deleteBuild(string, number)

Parametrar

Returer

deleteBuildTag(string, number, string)

Parametrar

Returer

deleteDefinition(string, number)

Parametrar

Returer

deleteDefinitionTag(string, number, string)

Parametrar

Returer

deleteFolder(string, string)

Parametrar

Returer

deleteRetentionLeasesById(string, number[])

Parametrar

Returer

deleteTag(string, string)

Parametrar

Returer

deleteTemplate(string, string)

Parametrar

Returer

getArtifact(string, number, string)

Parametrar

Returer

getArtifactContentZip(string, number, string)

Parametrar

Returer

getArtifacts(string, number)

Parametrar

Returer

getAttachment(string, number, string, string, string, string)

Parametrar

Returer

getAttachments(string, number, string)

Parametrar