BuildRestClient class

Başvuru

Paket:: azure-devops-extension-api

VSS REST API'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends: RestClientBase

Oluşturucular

BuildRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

addBuildTag(string, number, string)	Derlemeye etiket ekler.
addBuildTags(string[], string, number)	Derlemeye etiketler ekler.
addDefinitionTag(string, number, string)	Tanıma etiket ekler
addDefinitionTags(string[], string, number)	Tanıma birden çok etiket ekler.
addRetentionLeases(NewRetentionLease[], string)	İşlem hattı çalıştırmaları için yeni kiralar ekler.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Yapıtı bir derlemeyle ilişkilendirir.
createDefinition(BuildDefinition, string, number, number)	Yeni bir tanım oluşturur.
createFolder(Folder, string, string)	Yeni bir klasör oluşturur.
deleteBuild(string, number)	Derlemeyi siler.
deleteBuildTag(string, number, string)	Bir derlemeden etiketi kaldırır. NOT: Bu API, özel karakterler içeren etiketlerde çalışmaz. Özel karakterler içeren etiketleri kaldırmak için bunun yerine PATCH yöntemini kullanın (6,0+)
deleteDefinition(string, number)	Bir tanımı ve tüm ilişkili derlemeleri siler.
deleteDefinitionTag(string, number, string)	Tanımdan etiket kaldırır. NOT: Bu API, özel karakterler içeren etiketlerde çalışmaz. Özel karakterler içeren etiketleri kaldırmak için bunun yerine PATCH yöntemini kullanın (6,0+)
deleteFolder(string, string)	Tanım klasörünü siler. Tanımlar ve bunlara karşılık gelen derlemeler de silinir.
deleteRetentionLeasesById(string, number[])	Belirli bekletme kiralamalarını kaldırır.
deleteTag(string, string)	Bir etiketi derlemelerden, tanımlardan ve etiket deposundan kaldırır
deleteTemplate(string, string)	Derleme tanımı şablonunu siler.
getArtifact(string, number, string)	Derleme için belirli bir yapıtı alır.
getArtifactContentZip(string, number, string)	Derleme için belirli bir yapıtı alır.
getArtifacts(string, number)	Derlemenin tüm yapıtlarını alır.
getAttachment(string, number, string, string, string, string)	Belirli bir eki alır.
getAttachments(string, number, string)	Derlemeyle ilişkili belirli bir türdeki eklerin listesini alır.
getBadge(string, number, string)	Bir tanım için en son derlemenin durumunu gösteren bir rozet alır. Bu API'nin kullanım dışı bırakıldığını unutmayın. StatusBadgeController.GetStatusBadge'ı tercih edin.
getBuild(string, number, string)	Derleme alır
getBuildBadge(string, string, string, string)	Belirtilen dal için en son derlemenin durumunu gösteren bir rozet alır.
getBuildBadgeData(string, string, string, string)	Belirtilen dal için en son derlemenin durumunu gösteren bir rozet alır.
getBuildChanges(string, number, string, number, boolean)	Derlemeyle ilişkili değişiklikleri alır
getBuildController(number)	Denetleyici alır
getBuildControllers(string)	İsteğe bağlı olarak ada göre filtrelenmiş denetleyiciyi alır
getBuildGeneralSettings(string)	İşlem hattı genel ayarlarını alır.
getBuildLog(string, number, number, number, number)	Derleme için tek bir günlük dosyası alır.
getBuildLogLines(string, number, number, number, number)	Derleme için tek bir günlük dosyası alır.
getBuildLogs(string, number)	Derlemenin günlüklerini alır.
getBuildLogsZip(string, number)	Derlemenin günlüklerini alır.
getBuildLogZip(string, number, number, number, number)	Derleme için tek bir günlük dosyası alır.
getBuildOptionDefinitions(string)	Sistem tarafından desteklenen tüm derleme tanımı seçeneklerini alır.
getBuildProperties(string, number, string[])	Derlemenin özelliklerini alır.
getBuildReport(string, number, string)	Derleme raporu alır.
getBuildReportHtmlContent(string, number, string)	Derleme raporu alır.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Derlemelerin listesini alır.
getBuildSettings(string)	Derleme ayarlarını alır.
getBuildTags(string, number)	Derlemenin etiketlerini alır.
getBuildTimeline(string, number, string, number, string)	Derlemenin ayrıntılarını alır
getBuildWorkItemsRefs(string, number, number)	Bir derlemeyle ilişkili iş öğelerini alır. Yalnızca aynı projedeki iş öğeleri döndürülür.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Belirli işlemelere göre filtrelenmiş bir derlemeyle ilişkili iş öğelerini alır.
getChangesBetweenBuilds(string, number, number, number)	Verilen iki derleme arasında depoda yapılan değişiklikleri alır.
getDefinition(string, number, number, Date, string[], boolean)	İsteğe bağlı olarak belirli bir düzeltmede bir tanım alır.
getDefinitionMetrics(string, number, Date)	Bir tanım için derleme ölçümlerini alır.
getDefinitionProperties(string, number, string[])	Bir tanımın özelliklerini alır.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Tanımın tüm düzeltmelerini alır.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Tanımların listesini alır.
getDefinitionTags(string, number, number)	Tanımın etiketlerini alır.
getDefinitionYaml(string, number, number, Date, string[], boolean)	İsteğe bağlı olarak belirli bir düzeltmede tanımı YAML'ye dönüştürür.
getFile(string, number, string, string, string)	Derlemeden bir dosya alır.
getFileContents(string, string, string, string, string, string)	Belirtilen kaynak kodu deposundaki bir dosyanın içeriğini alır.
getFolders(string, string, FolderQueryOrder)	Derleme tanımı klasörlerinin listesini alır.
getLatestBuild(string, string, string)	İsteğe bağlı olarak belirli bir dala kapsamı belirlenmiş bir tanım için en son derlemeyi alır.
getPathContents(string, string, string, string, string, string)	Verilen kaynak kodu deposundaki bir dizinin içeriğini alır.
getProjectMetrics(string, string, Date)	Bir proje için derleme ölçümlerini alır.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Kaynak sağlayıcıdan bir çekme isteği nesnesi alır.
getResourceUsage()	Sistemdeki derleme kaynakları hakkında bilgi alır.
getRetentionHistory(number)	Proje koleksiyonu için bekletme geçmişini döndürür. Bu, bekletme işinin bunları temizlemesini engelleyebilecek özel bekletme kurallarına sahip işlem hatlarını, bekletme türüyle işlem hattı başına çalıştırmaları, bekletme türüne sahip koleksiyonun sahip olduğu işlem hatlarıyla ilişkili dosyaları ve işlem hattı başına dosya sayısını içerir.
getRetentionLease(string, number)	Bir kira kimliği verilip bekletme kirasının ayrıntılarını döndürür.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Belirtilen MinimalRetentionLeases ile eşleşen tüm kiraları döndürür
getRetentionLeasesByOwnerId(string, string, number, number)	Belirtilen varlığa ait, isteğe bağlı olarak kapsamı tek bir işlem hattı tanımına ve çalıştırmaya sahip olan tüm kiralamaları döndürür.
getRetentionLeasesByUserId(string, string, number, number)	Belirtilen kullanıcının sahip olduğu, isteğe bağlı olarak tek bir işlem hattı tanımı kapsamındaki ve çalıştırılan tüm kiralamaları döndürür.
getRetentionLeasesForBuild(string, number)	Belirli bir derleme için geçerli olan tüm bekletme kiralamalarını alır.
getRetentionSettings(string)	Projenin bekletme ayarlarını alır.
getStatusBadge(string, string, string, string, string, string, string)	<p>İsteğe bağlı olarak belirli bir dal, aşama, iş ve yapılandırma kapsamına sahip bir tanımın derleme durumunu alır.< /p><p>Birden fazla varsa, jobName belirtirken stageName değerinin geçirilmesi gerekir ve aynı kural, yapılandırma parametresi geçirilirken her ikisi için de geçerlidir.< /P>
getTags(string)	Projedeki tüm derleme etiketlerinin listesini alır.
getTemplate(string, string)	Belirli bir derleme tanımı şablonunu alır.
getTemplates(string)	Tüm tanım şablonlarını alır.
getWorkItemsBetweenBuilds(string, number, number, number)	İki derleme arasındaki tüm iş öğelerini alır.
listBranches(string, string, string, string, string)	Verilen kaynak kodu deposu için dalların listesini alır.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Kaynak kod depolarının listesini alır.
listSourceProviders(string)	Kaynak sağlayıcıların ve bunların özelliklerinin listesini alın.
listWebhooks(string, string, string, string)	Verilen kaynak kodu deposunda yüklü web kancalarının listesini alır.
queueBuild(Build, string, boolean, string, number, number)	Derlemeyi kuyruğa alır
restoreDefinition(string, number, boolean)	Silinen tanımı geri yükler
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Belirtilen kaynak kodu deposunda belirtilen tetikleyiciler için web kancalarını yeniden oluşturur.
saveTemplate(BuildDefinitionTemplate, string, string)	Mevcut derleme tanımı şablonunu Güncelleştirmeler.
updateBuild(Build, string, number, boolean)	Derleme Güncelleştirmeler.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	İşlem hattı genel ayarlarını Güncelleştirmeler.
updateBuildProperties(JsonPatchDocument, string, number)	Derlemenin özelliklerini Güncelleştirmeler.
updateBuilds(Build[], string)	Birden çok derleme Güncelleştirmeler.
updateBuildSettings(BuildSettings, string)	Derleme ayarlarını Güncelleştirmeler.
updateBuildTags(UpdateTagParameters, string, number)	Derlemedeki etiketleri ekler/kaldırır.
updateDefinition(BuildDefinition, string, number, number, number)	Var olan bir derleme tanımını Güncelleştirmeler. Bu işlemin başarılı olması için istek gövdesinin "Revision" özelliğinin değeri mevcut derleme tanımının değeriyle eşleşmelidir. GET kullanarak mevcut derleme tanımını edinmeniz, derleme tanımını gerektiği gibi değiştirmeniz ve ardından değiştirilen tanımı PUT ile göndermeniz önerilir.
updateDefinitionProperties(JsonPatchDocument, string, number)	Bir tanımın özelliklerini Güncelleştirmeler.
updateDefinitionTags(UpdateTagParameters, string, number)	Tanımdaki etiketleri ekler/kaldırır.
updateFolder(Folder, string, string)	Verilen mevcut yolda var olan bir klasörü Güncelleştirmeler
updateRetentionLease(RetentionLeaseUpdate, string, number)	Bekletme kiralamasının süresini veya işlem hattı koruma durumunu Güncelleştirmeler.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Projenin bekletme ayarlarını Güncelleştirmeler.
updateStage(UpdateStageParameters, number, string, string)	Derleme aşamasını güncelleştirme

Oluşturucu Ayrıntıları

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametreler

options: IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

addBuildTag(string, number, string)

Derlemeye etiket ekler.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

tag: string

Eklenecek etiket.

Döndürülenler

Promise<string[]>

addBuildTags(string[], string, number)

Derlemeye etiketler ekler.

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

Parametreler

tags: string[]

Eklenecek etiketler. İstek gövdesi doğrudan listelenen etiketlerden oluşturulur.

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<string[]>

addDefinitionTag(string, number, string)

Tanıma etiket ekler

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

tag: string

Eklenecek etiket.

Döndürülenler

Promise<string[]>

addDefinitionTags(string[], string, number)

Tanıma birden çok etiket ekler.

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

Parametreler

tags: string[]

Eklenecek etiketler.

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

Döndürülenler

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

İşlem hattı çalıştırmaları için yeni kiralar ekler.

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

Parametreler

newLeases: NewRetentionLease[]

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parametreler

resources: DefinitionResourceReference[]

project: string

Proje Kimliği veya proje adı

definitionId: number

Döndürülenler

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parametreler

resources: DefinitionResourceReference[]

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Yapıtı bir derlemeyle ilişkilendirir.

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

Parametreler

artifact: BuildArtifact

Yapıt.

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Yeni bir tanım oluşturur.

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

Parametreler

definition: BuildDefinition

Tanımı.

project: string

Proje Kimliği veya proje adı

definitionToCloneId: number

definitionToCloneRevision: number

Döndürülenler

Promise<BuildDefinition>

createFolder(Folder, string, string)

Yeni bir klasör oluşturur.

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

Parametreler

folder: Folder

Klasör.

project: string

Proje Kimliği veya proje adı

path: string

Klasörün tam yolu.

Döndürülenler

Promise<Folder>

deleteBuild(string, number)

Derlemeyi siler.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<void>

deleteBuildTag(string, number, string)

Bir derlemeden etiketi kaldırır. NOT: Bu API, özel karakterler içeren etiketlerde çalışmaz. Özel karakterler içeren etiketleri kaldırmak için bunun yerine PATCH yöntemini kullanın (6,0+)

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

tag: string

Kaldırılacak etiket.

Döndürülenler

Promise<string[]>

deleteDefinition(string, number)

Bir tanımı ve tüm ilişkili derlemeleri siler.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

Döndürülenler

Promise<void>

deleteDefinitionTag(string, number, string)

Tanımdan etiket kaldırır. NOT: Bu API, özel karakterler içeren etiketlerde çalışmaz. Özel karakterler içeren etiketleri kaldırmak için bunun yerine PATCH yöntemini kullanın (6,0+)

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

tag: string

Kaldırılacak etiket.

Döndürülenler

Promise<string[]>

deleteFolder(string, string)

Tanım klasörünü siler. Tanımlar ve bunlara karşılık gelen derlemeler de silinir.

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

Parametreler

project: string

Proje Kimliği veya proje adı

path: string

Klasörün tam yolu.

Döndürülenler

Promise<void>

deleteRetentionLeasesById(string, number[])

Belirli bekletme kiralamalarını kaldırır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

ids: number[]

Döndürülenler

Promise<void>

deleteTag(string, string)

Bir etiketi derlemelerden, tanımlardan ve etiket deposundan kaldırır

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

Parametreler

project: string

Proje Kimliği veya proje adı

tag: string

Kaldırılacak etiket.

Döndürülenler

Promise<string[]>

deleteTemplate(string, string)

Derleme tanımı şablonunu siler.

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

Parametreler

project: string

Proje Kimliği veya proje adı

templateId: string

Şablonun kimliği.

Döndürülenler

Promise<void>

getArtifact(string, number, string)

Derleme için belirli bir yapıtı alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

artifactName: string

Yapıtın adı.

Döndürülenler

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Derleme için belirli bir yapıtı alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

artifactName: string

Yapıtın adı.

Döndürülenler

Promise<ArrayBuffer>

getArtifacts(string, number)

Derlemenin tüm yapıtlarını alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<BuildArtifact[]>

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

Belirli bir eki alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

timelineId: string

Zaman çizelgesinin kimliği.

recordId: string

Zaman çizelgesi kaydının kimliği.

type: string

Ekin türü.

name: string

Ekin adı.

Döndürülenler

Promise<ArrayBuffer>

getAttachments(string, number, string)

Derlemeyle ilişkili belirli bir türdeki eklerin listesini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

type: string

Ekin türü.

Döndürülenler

Promise<Attachment[]>

getBadge(string, number, string)

Bir tanım için en son derlemenin durumunu gösteren bir rozet alır. Bu API'nin kullanım dışı bırakıldığını unutmayın. StatusBadgeController.GetStatusBadge'ı tercih edin.

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

Parametreler

project: string

Proje kimliği veya adı.

definitionId: number

Tanımın kimliği.

branchName: string

Dalın adı.

Döndürülenler

Promise<string>

getBuild(string, number, string)

Derleme alır

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

propertyFilters: string

Döndürülenler

Promise<Build>

getBuildBadge(string, string, string, string)

Belirtilen dal için en son derlemenin durumunu gösteren bir rozet alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

repoType: string

Depo türü.

repoId: string

Depo kimliği.

branchName: string

Dal adı.

Döndürülenler

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Belirtilen dal için en son derlemenin durumunu gösteren bir rozet alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

repoType: string

Depo türü.

repoId: string

Depo kimliği.

branchName: string

Dal adı.

Döndürülenler

Promise<string>

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

Derlemeyle ilişkili değişiklikleri alır

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

continuationToken: string

top: number

Döndürülecek en fazla değişiklik sayısı

includeSourceChange: boolean

Döndürülenler

Promise<PagedList<Change>>

getBuildController(number)

Denetleyici alır

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

Parametreler

controllerId: number

Döndürülenler

Promise<BuildController>

getBuildControllers(string)

İsteğe bağlı olarak ada göre filtrelenmiş denetleyiciyi alır

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

Parametreler

name: string

Döndürülenler

Promise<BuildController[]>

getBuildGeneralSettings(string)

İşlem hattı genel ayarlarını alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<PipelineGeneralSettings>

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

Derleme için tek bir günlük dosyası alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

logId: number

Günlük dosyasının kimliği.

startLine: number

Başlangıç çizgisi.

endLine: number

Bitiş çizgisi.

Döndürülenler

Promise<string>

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

Derleme için tek bir günlük dosyası alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

logId: number

Günlük dosyasının kimliği.

startLine: number

Başlangıç çizgisi.

endLine: number

Bitiş çizgisi.

Döndürülenler

Promise<string[]>

getBuildLogs(string, number)

Derlemenin günlüklerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Derlemenin günlüklerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<ArrayBuffer>

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

Derleme için tek bir günlük dosyası alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

logId: number

Günlük dosyasının kimliği.

startLine: number

Başlangıç çizgisi.

endLine: number

Bitiş çizgisi.

Döndürülenler

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Sistem tarafından desteklenen tüm derleme tanımı seçeneklerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Derlemenin özelliklerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

filter: string[]

Virgülle ayrılmış özellikler listesi. Belirtilirse, bu özelliklere filtre uygulayın.

Döndürülenler

Promise<any>

getBuildReport(string, number, string)

Derleme raporu alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

type: string

Döndürülenler

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Derleme raporu alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

type: string

Döndürülenler

Promise<any>

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

Derlemelerin listesini alır.

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>>

Parametreler

project: string

Proje Kimliği veya proje adı

definitions: number[]

Tanım kimliklerinin virgülle ayrılmış listesi. Belirtilirse, bu tanımlar için derlemeler için filtreler.

queues: number[]

Kuyruk kimliklerinin virgülle ayrılmış listesi. Belirtilirse, bu kuyruklara karşı çalışan derlemelere filtre uygulayın.

buildNumber: string

Belirtilirse, bu derleme numarasıyla eşleşen derlemelere filtre ekler. Önek araması yapmak için * öğesini ekleme.

minTime: Date

Belirtilirse, belirtilen queryOrder değerini temel alarak bu tarihten sonra tamamlanan/başlatılan/kuyruğa alınan derlemelere filtre ekler.

maxTime: Date

Belirtilirse, belirtilen queryOrder değerine göre bu tarihten önce tamamlanmış/başlatılmış/kuyruğa alınmış derlemelere filtre ekler.

requestedFor: string

Belirtilirse, belirtilen kullanıcı için istenen derlemelere filtre ekler.

reasonFilter: BuildReason

Belirtilirse, bu nedenle eşleşen derlemelere filtre ekler.

statusFilter: BuildStatus

Belirtilirse, bu durumla eşleşen derlemelere filtre ekler.

resultFilter: BuildResult

Belirtilirse, bu sonuçla eşleşen derlemelere filtre ekler.

tagFilters: string[]

Virgülle ayrılmış etiket listesi. Belirtilirse, belirtilen etiketlere sahip derlemelere filtre ekler.

properties: string[]

Alınacak özelliklerin virgülle ayrılmış listesi.

top: number

Döndürülecek derleme sayısı üst sınırı.

continuationToken: string

Bu yönteme önceki bir çağrı tarafından döndürülen ve sonraki derleme kümesini döndürmek için kullanılabilecek bir devamlılık belirteci.

maxBuildsPerDefinition: number

Tanım başına döndürülecek derleme sayısı üst sınırı.

deletedFilter: QueryDeletedOption

Yalnızca silinen derlemelerin dışlanması, dahil edilip edilmeyeceğini veya döndürülmesi gerekip gerekmediğini gösterir.

queryOrder: BuildQueryOrder

Derlemelerin döndürülmesi gereken sıra.

branchName: string

Belirtilirse, bu dalı oluşturan dalları oluşturan derlemelere filtre ekler.

buildIds: number[]

Alınacak derlemelerin kimliklerini belirten virgülle ayrılmış liste.

repositoryId: string

Belirtilirse, bu depodan oluşturulan derlemelere filtre ekler.

repositoryType: string

Belirtilirse, bu türdeki depolardan oluşturulan derlemelere filtre ekler.

Döndürülenler

Promise<PagedList<Build>>

getBuildSettings(string)

Derleme ayarlarını alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<BuildSettings>

getBuildTags(string, number)

Derlemenin etiketlerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<string[]>

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

Derlemenin ayrıntılarını alır

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

timelineId: string

changeId: number

planId: string

Döndürülenler

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Bir derlemeyle ilişkili iş öğelerini alır. Yalnızca aynı projedeki iş öğeleri döndürülür.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

top: number

Döndürülecek iş öğesi sayısı üst sınırı.

Döndürülenler

Promise<ResourceRef[]>

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

Belirli işlemelere göre filtrelenmiş bir derlemeyle ilişkili iş öğelerini alır.

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

Parametreler

commitIds: string[]

İşleme kimliklerinin virgülle ayrılmış listesi.

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

top: number

Döndürülecek iş öğesi sayısı üst sınırı veya işleme kimlikleri belirtilmezse dikkate alınacak işleme sayısı.

Döndürülenler

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Verilen iki derleme arasında depoda yapılan değişiklikleri alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

fromBuildId: number

İlk derlemenin kimliği.

toBuildId: number

Son derlemenin kimliği.

top: number

Döndürülecek en fazla değişiklik sayısı.

Döndürülenler

Promise<Change[]>

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

İsteğe bağlı olarak belirli bir düzeltmede bir tanım alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

revision: number

Alınacak düzeltme numarası. Bu belirtilmezse en son sürüm döndürülür.

minMetricsTime: Date

Belirtilirse, ölçümlerin dahil edilmesi gereken tarihi gösterir.

propertyFilters: string[]

Sonuçlara eklenecek özelliklerin virgülle ayrılmış listesi.

includeLatestBuilds: boolean

Döndürülenler

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Bir tanım için derleme ölçümlerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

minMetricsTime: Date

Ölçümlerin hesaplandığı tarih.

Döndürülenler

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Bir tanımın özelliklerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

filter: string[]

Virgülle ayrılmış özellikler listesi. Belirtilirse, bu özelliklere filtre uygulayın.

Döndürülenler

Promise<any>

getDefinitionResources(string, number)

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Döndürülenler

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Tanımın tüm düzeltmelerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

Döndürülenler

Promise<BuildDefinitionRevision[]>

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

Tanımların listesini alır.

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>>

Parametreler

project: string

Proje Kimliği veya proje adı

name: string

Belirtilirse, adları bu desenle eşleşen tanımlara filtre uygular.

repositoryId: string

Depo kimliği. Belirtilirse, bu deponun kullanıldığı tanımlara filtre ekler.

repositoryType: string

Belirtilirse, bu tür bir depoya sahip tanımlara filtre uygulanır.

queryOrder: DefinitionQueryOrder

Tanımların döndürülme sırasını gösterir.

top: number

Döndürülecek tanım sayısı üst sınırı.

continuationToken: string

Bu yönteme yapılan önceki bir çağrı tarafından döndürülen ve sonraki tanım kümesini döndürmek için kullanılabilecek bir devamlılık belirteci.

minMetricsTime: Date

Belirtilirse, ölçümlerin dahil edilmesi gereken tarihi gösterir.

definitionIds: number[]

Alınacak tanımların kimliklerini belirten virgülle ayrılmış liste.

path: string

Belirtilirse, bu klasör altındaki tanımlara filtre ekler.

builtAfter: Date

Belirtilirse, bu tarihten sonra derlemeleri olan tanımlara filtre ekler.

notBuiltAfter: Date

Belirtilirse, bu tarihten sonra derlemeleri olmayan tanımlara filtre ekler.

includeAllProperties: boolean

Tam tanımların döndürülmesi gerekip gerekmediğini gösterir. Varsayılan olarak tanımların basit gösterimleri döndürülür.

includeLatestBuilds: boolean

Bu tanım için en son ve en son tamamlanan derlemelerin döndürülip döndürülmeyeceğini gösterir.

taskIdFilter: string

Belirtilirse, belirtilen görevi kullanan tanımlara filtre ekler.

processType: number

Belirtilirse, verilen işlem türüne sahip tanımlara filtre ekler.

yamlFilename: string

Belirtilirse, verilen dosya adıyla eşleşen YAML tanımlarına filtre uygulayın. Bu filtreyi kullanmak için includeAllProperties true olarak ayarlanmalıdır

Döndürülenler

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Tanımın etiketlerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

revision: number

Tanım düzeltme numarası. Belirtilmezse, tanımın en son düzeltmesini kullanır.

Döndürülenler

Promise<string[]>

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

İsteğe bağlı olarak belirli bir düzeltmede tanımı YAML'ye dönüştürür.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

revision: number

Alınacak düzeltme numarası. Bu belirtilmezse en son sürüm döndürülür.

minMetricsTime: Date

Belirtilirse, ölçümlerin dahil edilmesi gereken tarihi gösterir.

propertyFilters: string[]

Sonuçlara eklenecek özelliklerin virgülle ayrılmış listesi.

includeLatestBuilds: boolean

Döndürülenler

Promise<YamlBuild>

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

Derlemeden bir dosya alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

artifactName: string

Yapıtın adı.

fileId: string

Dosyanın birincil anahtarı.

fileName: string

Dosyanın ayarlanacağı ad.

Döndürülenler

Promise<ArrayBuffer>

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

Belirtilen kaynak kodu deposundaki bir dosyanın içeriğini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

repository: string

Belirtilirse, dalları almak için satıcıya özgü tanımlayıcı veya deponun adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

commitOrBranch: string

Dosyanın içeriğinin alındığı işlemenin veya dalın tanımlayıcısı.

path: string

Deponun köküne göre alınacak dosyanın yolu.

Döndürülenler

Promise<string>

getFolders(string, string, FolderQueryOrder)

Derleme tanımı klasörlerinin listesini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

path: string

Başlangıç yolu.

queryOrder: FolderQueryOrder

Klasörlerin döndürülme sırası.

Döndürülenler

Promise<Folder[]>

getLatestBuild(string, string, string)

İsteğe bağlı olarak belirli bir dala kapsamı belirlenmiş bir tanım için en son derlemeyi alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

definition: string

isteğe bağlı baştaki klasör yolu veya tanım kimliği ile tanım adı

branchName: string

kullanılacak belirli dalı gösteren isteğe bağlı parametre. Belirtilmezse, varsayılan dal kullanılır.

Döndürülenler

Promise<Build>

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

Verilen kaynak kodu deposundaki bir dizinin içeriğini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

repository: string

Belirtilirse, dalları almak için satıcıya özgü tanımlayıcı veya deponun adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

commitOrBranch: string

Dosyanın içeriğinin alındığı işlemenin veya dalın tanımlayıcısı.

path: string

Deponun köküne göre, listenin yol içeriği.

Döndürülenler

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Bir proje için derleme ölçümlerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

metricAggregationType: string

Kullanılacak toplama türü (saatlik, günlük).

minMetricsTime: Date

Ölçümlerin hesaplandığı tarih.

Döndürülenler

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parametreler

project: string

Proje Kimliği veya proje adı

type: string

id: string

Döndürülenler

Promise<DefinitionResourceReference[]>

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

Kaynak sağlayıcıdan bir çekme isteği nesnesi alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

pullRequestId: string

Çekme isteğinin satıcıya özgü kimliği.

repositoryId: string

Satıcıya özgü tanımlayıcı veya çekme isteğini içeren deponun adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

Döndürülenler

Promise<PullRequest>

getResourceUsage()

Sistemdeki derleme kaynakları hakkında bilgi alır.

function getResourceUsage(): Promise<BuildResourceUsage>

Döndürülenler

Promise<BuildResourceUsage>

getRetentionHistory(number)

Proje koleksiyonu için bekletme geçmişini döndürür. Bu, bekletme işinin bunları temizlemesini engelleyebilecek özel bekletme kurallarına sahip işlem hatlarını, bekletme türüyle işlem hattı başına çalıştırmaları, bekletme türüne sahip koleksiyonun sahip olduğu işlem hatlarıyla ilişkili dosyaları ve işlem hattı başına dosya sayısını içerir.

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

Parametreler

daysToLookback: number

Döndürülenler

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Bir kira kimliği verilip bekletme kirasının ayrıntılarını döndürür.

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

Parametreler

project: string

Proje Kimliği veya proje adı

leaseId: number

Döndürülenler

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Belirtilen MinimalRetentionLeases ile eşleşen tüm kiraları döndürür

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

Parametreler

project: string

Proje Kimliği veya proje adı

leasesToFetch: MinimalRetentionLease[]

'|' ile ayrılmış JSON serileştirilmiş MinimalRetentionLeases listesi

Döndürülenler

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Belirtilen varlığa ait, isteğe bağlı olarak kapsamı tek bir işlem hattı tanımına ve çalıştırmaya sahip olan tüm kiralamaları döndürür.

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

Parametreler

project: string

Proje Kimliği veya proje adı

ownerId: string

definitionId: number

Aramayı belirli bir işlem hattı tanımıyla sınırlamak için isteğe bağlı bir parametre.

runId: number

Aramayı tek bir işlem hattı çalıştırması ile sınırlamak için isteğe bağlı bir parametre. definitionId gerektirir.

Döndürülenler

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Belirtilen kullanıcının sahip olduğu, isteğe bağlı olarak tek bir işlem hattı tanımı kapsamındaki ve çalıştırılan tüm kiralamaları döndürür.

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

Parametreler

project: string

Proje Kimliği veya proje adı

userOwnerId: string

Aranacak kullanıcı kimliği.

definitionId: number

Aramayı belirli bir işlem hattı tanımıyla sınırlamak için isteğe bağlı bir parametre.

runId: number

Aramayı tek bir işlem hattı çalıştırması ile sınırlamak için isteğe bağlı bir parametre. definitionId gerektirir.

Döndürülenler

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Belirli bir derleme için geçerli olan tüm bekletme kiralamalarını alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<RetentionLease[]>

getRetentionSettings(string)

Projenin bekletme ayarlarını alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<ProjectRetentionSetting>

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

<p>İsteğe bağlı olarak belirli bir dal, aşama, iş ve yapılandırma kapsamına sahip bir tanımın derleme durumunu alır.< /p><p>Birden fazla varsa, jobName belirtirken stageName değerinin geçirilmesi gerekir ve aynı kural, yapılandırma parametresi geçirilirken her ikisi için de geçerlidir.< /P>

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

Parametreler

project: string

Proje Kimliği veya proje adı

definition: string

İsteğe bağlı baştaki klasör yoluna sahip tanım adı veya tanım kimliği.

branchName: string

Yalnızca bu dal için en son derlemeyi göz önünde bulundurun. Belirtilmezse, varsayılan dal kullanılır.

stageName: string

Durumu işlemek için işlem hattı içinde bu aşamayı kullanın.

jobName: string

Durumu işlemek için işlem hattının bir aşamasında bu işi kullanın.

configuration: string

Durumu işlemek için bu iş yapılandırmasını kullanın

label: string

Rozetin sol tarafındaki varsayılan metni değiştirir.

Döndürülenler

Promise<string>

getTags(string)

Projedeki tüm derleme etiketlerinin listesini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<string[]>

getTemplate(string, string)

Belirli bir derleme tanımı şablonunu alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

templateId: string

İstenen şablonun kimliği.

Döndürülenler

Promise<BuildDefinitionTemplate>

getTemplates(string)

Tüm tanım şablonlarını alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

İki derleme arasındaki tüm iş öğelerini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

fromBuildId: number

İlk derlemenin kimliği.

toBuildId: number

Son derlemenin kimliği.

top: number

Döndürülecek iş öğesi sayısı üst sınırı.

Döndürülenler

Promise<ResourceRef[]>

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

Verilen kaynak kodu deposu için dalların listesini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

repository: string

Dalları almak için satıcıya özgü tanımlayıcı veya deponun adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

branchName: string

Sağlanırsa, özellikle denetlenecek dalın adı.

Döndürülenler

Promise<string[]>

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

Kaynak kod depolarının listesini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

repository: string

Belirtilirse, satıcıya özgü tanımlayıcı veya alınacak tek bir deponun adı.

resultSet: ResultSet

Uç noktayla en ilgili depolar için 'top'. Ayarlanmadıysa, tüm depolar döndürülür. 'Depo' ayarlandıysa yoksayılır.

pageResults: boolean

True olarak ayarlanırsa, bu işlem sonuç kümesini sınırlandırır ve sorguya devam etmek için bir devamlılık belirteci döndürür.

continuationToken: string

Sonuçları sayfalarken, bu yönteme yapılan önceki bir çağrı tarafından döndürülen ve sonraki depo kümesini döndürmek için kullanılabilecek bir devamlılık belirtecidir.

Döndürülenler

Promise<SourceRepositories>

listSourceProviders(string)

Kaynak sağlayıcıların ve bunların özelliklerinin listesini alın.

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

Parametreler

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Verilen kaynak kodu deposunda yüklü web kancalarının listesini alır.

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

Parametreler

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

repository: string

Belirtilirse, web kancalarını almak için satıcıya özgü tanımlayıcı veya deponun adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

Döndürülenler

Promise<RepositoryWebhook[]>

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

Derlemeyi kuyruğa alır

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

Parametreler

build: Build

project: string

Proje Kimliği veya proje adı

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Bir derlemeyi gövdesiz kuyruğa almak için isteğe bağlı tanım kimliği. Geçerli bir gövde varsa yoksayılır

Döndürülenler

Promise<Build>

restoreDefinition(string, number, boolean)

Silinen tanımı geri yükler

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

Parametreler

project: string

Proje Kimliği veya proje adı

definitionId: number

Geri yükleneceği tanımın tanımlayıcısı.

deleted: boolean

False olduğunda, silinen bir tanımı geri yükler.

Döndürülenler

Promise<BuildDefinition>

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

Belirtilen kaynak kodu deposunda belirtilen tetikleyiciler için web kancalarını yeniden oluşturur.

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

Parametreler

triggerTypes: DefinitionTriggerType[]

Web kancalarını geri yükleyen tetikleyici türleri.

project: string

Proje Kimliği veya proje adı

providerName: string

Kaynak sağlayıcının adı.

serviceEndpointId: string

Belirtilirse, sorguya alınacak hizmet uç noktasının kimliği. Yalnızca TFVC veya TFGit gibi hizmet uç noktalarını kullanmayan sağlayıcılar için atlanabilir.

repository: string

Belirtilirse, web kancalarını almak için satıcıya özgü tanımlayıcı veya deponun adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

Döndürülenler

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Mevcut derleme tanımı şablonunu Güncelleştirmeler.

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

Parametreler

template: BuildDefinitionTemplate

Şablonun yeni sürümü.

project: string

Proje Kimliği veya proje adı

templateId: string

Şablonun kimliği.

Döndürülenler

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Derleme Güncelleştirmeler.

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

Parametreler

build: Build

Derleme.

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

retry: boolean

Döndürülenler

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

İşlem hattı genel ayarlarını Güncelleştirmeler.

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

Parametreler

newSettings: PipelineGeneralSettings

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Derlemenin özelliklerini Güncelleştirmeler.

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

Parametreler

document: JsonPatchDocument

Güncelleştirilecek özellikleri açıklayan bir json düzeltme eki belgesi.

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<any>

updateBuilds(Build[], string)

Birden çok derleme Güncelleştirmeler.

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

Parametreler

builds: Build[]

Güncelleştirilecek derlemeler.

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Derleme ayarlarını Güncelleştirmeler.

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

Parametreler

settings: BuildSettings

Yeni ayarlar.

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Derlemedeki etiketleri ekler/kaldırır.

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

Parametreler

updateParameters: UpdateTagParameters

Eklenecek/kaldırılacak etiketler.

project: string

Proje Kimliği veya proje adı

buildId: number

Derlemenin kimliği.

Döndürülenler

Promise<string[]>

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

Var olan bir derleme tanımını Güncelleştirmeler. Bu işlemin başarılı olması için istek gövdesinin "Revision" özelliğinin değeri mevcut derleme tanımının değeriyle eşleşmelidir. GET kullanarak mevcut derleme tanımını edinmeniz, derleme tanımını gerektiği gibi değiştirmeniz ve ardından değiştirilen tanımı PUT ile göndermeniz önerilir.

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

Parametreler

definition: BuildDefinition

Tanımın yeni sürümü. Güncelleştirmenin kabul edilmesi için "Revision" özelliğinin mevcut tanımıyla eşleşmesi gerekir.

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Döndürülenler

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Bir tanımın özelliklerini Güncelleştirmeler.

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

Parametreler

document: JsonPatchDocument

Güncelleştirilecek özellikleri açıklayan bir json düzeltme eki belgesi.

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

Döndürülenler

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Tanımdaki etiketleri ekler/kaldırır.

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

Parametreler

updateParameters: UpdateTagParameters

Eklenecek/kaldırılacak etiketler.

project: string

Proje Kimliği veya proje adı

definitionId: number

Tanımın kimliği.

Döndürülenler

Promise<string[]>

updateFolder(Folder, string, string)

Verilen mevcut yolda var olan bir klasörü Güncelleştirmeler

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

Parametreler

folder: Folder

Klasörün yeni sürümü.

project: string

Proje Kimliği veya proje adı

path: string

Klasörün tam yolu.

Döndürülenler

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Bekletme kiralamasının süresini veya işlem hattı koruma durumunu Güncelleştirmeler.

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

Parametreler

leaseUpdate: RetentionLeaseUpdate

Bekletme kirası için yeni veriler.

project: string

Proje Kimliği veya proje adı

leaseId: number

Güncelleştirilecek kiranın kimliği.

Döndürülenler

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Projenin bekletme ayarlarını Güncelleştirmeler.

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

Parametreler

updateModel: UpdateProjectRetentionSettingModel

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Derleme aşamasını güncelleştirme

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

Parametreler

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Proje Kimliği veya proje adı

Döndürülenler

Promise<void>

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Aracılığıyla paylaş

BuildRestClient class

Oluşturucular

Özellikler

Yöntemler

Oluşturucu Ayrıntıları

BuildRestClient(IVssRestClientOptions)

Parametreler

Özellik Ayrıntıları

RESOURCE_AREA_ID

Özellik Değeri

Yöntem Ayrıntıları

addBuildTag(string, number, string)

Parametreler

Döndürülenler

addBuildTags(string[], string, number)

Parametreler

Döndürülenler

addDefinitionTag(string, number, string)

Parametreler

Döndürülenler

addDefinitionTags(string[], string, number)

Parametreler

Döndürülenler

addRetentionLeases(NewRetentionLease[], string)

Parametreler

Döndürülenler

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parametreler

Döndürülenler

authorizeProjectResources(DefinitionResourceReference[], string)

Parametreler

Döndürülenler

createArtifact(BuildArtifact, string, number)

Parametreler

Döndürülenler

createDefinition(BuildDefinition, string, number, number)

Parametreler

Döndürülenler

createFolder(Folder, string, string)

Parametreler

Döndürülenler

deleteBuild(string, number)

Parametreler

Döndürülenler

deleteBuildTag(string, number, string)

Parametreler

Döndürülenler

deleteDefinition(string, number)

Parametreler

Döndürülenler

deleteDefinitionTag(string, number, string)

Parametreler

Döndürülenler

deleteFolder(string, string)

Parametreler

Döndürülenler

deleteRetentionLeasesById(string, number[])

Parametreler

Döndürülenler

deleteTag(string, string)

Parametreler

Döndürülenler

deleteTemplate(string, string)

Parametreler

Döndürülenler

getArtifact(string, number, string)

Parametreler

Döndürülenler

getArtifactContentZip(string, number, string)

Parametreler

Döndürülenler

getArtifacts(string, number)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

getAttachments(string, number, string)

Parametreler