BuildRestClient class

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

Oluşturucular

Özellikler

Yöntemler

addBuildTag(string, number, string)	Bir yapıya bir etiket ekler.
addBuildTags(string[], string, number)	Bir yapıya etiketler ekler.
addDefinitionTag(string, number, string)	Tanıma etiket ekler
addDefinitionTags(string[], string, number)	Bir tanıma birden fazla etiket ekler.
addRetentionLeases(NewRetentionLease[], string)	Boru hattı çalışmaları için yeni kira sözleşmeleri ekler.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Bir eseri bir yapı ile 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 yapıdan bir etiketi kaldırır. NOT: Bu API, özel karakterli etiketler için çalışmaz. Özel karakterli etiketleri kaldırmak için PATCH yöntemini kullanın (6.0+ içinde).
deleteDefinition(string, number)	Bir tanımı ve ilişkili tüm derlemeleri siler.
deleteDefinitionTag(string, number, string)	Tanımdan bir etiketi çıkarır. NOT: Bu API, özel karakterli etiketler için çalışmaz. Özel karakterli etiketleri kaldırmak için PATCH yöntemini kullanın (6.0+ içinde).
deleteFolder(string, string)	Bir tanım klasörünü siler. Tanımlar ve ilgili yapılar da silinecek.
deleteRetentionLeasesById(string, number[])	Belirli tutma kiralamalarını kaldırır.
deleteTag(string, string)	Bir etiketi yapılardan, tanımlardan ve etiket deposundan kaldırır
deleteTemplate(string, string)	Bir derleme tanımı şablonunu siler.
getArtifact(string, number, string)	Bir yapı için özel bir artefakt alıyor.
getArtifactContentZip(string, number, string)	Bir yapı için özel bir artefakt alıyor.
getArtifacts(string, number)	Bir yapı için tüm artefaktları alıyor.
getAttachment(string, number, string, string, string, string)	Özel bir bağlanma takılır.
getAttachments(string, number, string)	Bir yapıya bağlı belirli bir tip eklentilerin listesini alır.
getBadge(string, number, string)	En son derlemenin durumunu belirten bir rozet alır. Bu API'nin kullanımdan dolayı kullanılmadığını unutmayın. StatusBadgeController.GetStatusBadge'i tercih et.
getBuild(string, number, string)	Derleme alır
getBuildBadge(string, string, string, string)	Belirtilen dal için en son derleme durumunu gösteren bir rozet alır.
getBuildBadgeData(string, string, string, string)	Belirtilen dal için en son derleme durumunu gösteren bir rozet alır.
getBuildChanges(string, number, string, number, boolean)	Bir yapıya bağlı değişiklikleri alır
getBuildController(number)	Bir kontrolcü alıyor
getBuildControllers(string)	Kontrolcü alıyor, isteğe bağlı olarak isimle filtreleniyor
getBuildGeneralSettings(string)	Boru hattı genel ayarlarını alıyor.
getBuildLog(string, number, number, number, number)	Bir derleme için bireysel bir log dosyası alır.
getBuildLogLines(string, number, number, number, number)	Bir derleme için bireysel bir log dosyası alır.
getBuildLogs(string, number)	Bir yapı için logları alıyor.
getBuildLogsZip(string, number)	Bir yapı için logları alıyor.
getBuildLogZip(string, number, number, number, number)	Bir derleme için bireysel bir log dosyası alır.
getBuildOptionDefinitions(string)	Sistem tarafından desteklenen tüm derleme tanımı seçeneklerini alıyor.
getBuildProperties(string, number, string[])	Bir yapı için mülk alıyor.
getBuildReport(string, number, string)	Bir yapı raporu alıyor.
getBuildReportHtmlContent(string, number, string)	Bir yapı raporu alıyor.
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)	Yapı ayarlarını alıyor.
getBuildStageLatestTimeline(string, number, string, number, string)	Belirli bir aşamaya göre filtrelenmiş bir derleme için en son zaman çizelgesini alır.
getBuildStageTimeline(string, number, string, string, number, string)	Belirli bir aşamaya göre filtrelenmiş bir derlemenin zaman çizelgesini alır.
getBuildTags(string, number)	Bir build için etiketleri alıyor.
getBuildTimeline(string, number, string, number, string)	Bir yapı için detaylar
getBuildWorkItemsRefs(string, number, number)	Bir yapıya bağlı iş eşyalarını alıyor. Aynı projedeki sadece iş maddeleri iade edilir.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Bir yapıya bağlı iş öğelerini belirli commit'lere filtreliyor.
getChangesBetweenBuilds(string, number, number, number)	Verilen iki yapı arasında depoda yapılan değişiklikleri alıyor.
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 build metriklerini alıyor.
getDefinitionProperties(string, number, string[])	Bir tanım için özellikler elde eder.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Bir tanımın tüm revizyonlarını 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 etiketlerini alıyor.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Bir tanımı YAML'ye dönüştürür, isteğe bağlı olarak belirli bir revizyonda.
getFile(string, number, string, string, string)	Yapıdan bir dosya alıyor.
getFileContents(string, string, string, string, string, string)	Verilen kaynak kod deposunda bir dosyanın içeriğini alır.
getFolders(string, string, FolderQueryOrder)	Bir derleme tanımı klasörleri alıyor.
getLatestBuild(string, string, string)	İsteğe bağlı olarak belirli bir dal kapsamına alınmış bir tanım için en son derlemeyi alır.
getPathContents(string, string, string, string, string, string)	Verilen kaynak kod deposunda bir dizinin içeriğini alır.
getProjectMetrics(string, string, Date)	Bir proje için inşa metriklerini alır.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Kaynak sağlayıcıdan bir pull request object alıyor.
getResourceUsage()	Sistemdeki yapı kaynakları hakkında bilgi toplar.
getRetentionHistory(number)	Proje koleksiyonunun tutma geçmişini döndürür. Bu, tutma işinin temizlenmesini engelleyebilecek özel tutma kurallarına sahip boru hatlarını, tutma tipine sahip boru hattı başına çalıştırmaları, koleksiyonun sahip olduğu boru hatlarıyla ilişkili dosyaları ve boru hattı başına dosya sayısını içerir.
getRetentionLease(string, number)	Kiralama kimliği verilen tutma kira sözleşmesinin detaylarını iade eder.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Belirtilen MinimalRetentionLeases ile eşleşen tüm kira sözleşmelerini döndürür
getRetentionLeasesByOwnerId(string, string, number, number)	Belirtilen kuruluşa ait olan tüm kiralamaları döndürür, isteğe bağlı olarak tek bir boru hattı tanımına göre kapsamlı ve çalıştırılır.
getRetentionLeasesByUserId(string, string, number, number)	Belirtilen kullanıcıya ait olan tüm kiralamaları döndürür, isteğe bağlı olarak tek bir boru hattı tanımına göre kapsamlı ve çalıştırılır.
getRetentionLeasesForBuild(string, number)	Belirli bir yapıya uygulanan tüm tutma kira sözleşmelerini alıyor.
getRetentionSettings(string)	Projenin tutma ayarlarını alıyor.
getStatusBadge(string, string, string, string, string, string, string)	<p>Bir tanım için derleme durumunu alır, isteğe bağlı olarak belirli bir dal, aşama, iş ve yapılandırmaya göre kapsamlıdır.</p><p>Birden fazla varsa, bir jobName belirtirken stageName değeri girmesi gerekir ve aynı kural yapılandırma parametresi geçirildiğinde her ikisi için de geçerlidir.</p>
getTags(string)	Projedeki tüm yapı etiketlerinin listesini alıyor.
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 yapı arasındaki tüm iş eşyalarını alıyor.
listBranches(string, string, string, string, string)	Verilen kaynak kod deposu için dalların listesini alır.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Kaynak kodu depolarının listesini alıyor.
listSourceProviders(string)	Kaynak sağlayıcıların ve yeteneklerinin listesini alın.
listWebhooks(string, string, string, string)	Verilen kaynak kodu deposunda yüklü olan 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)	Verilen kaynak kod deposunda belirtilen tetikleyiciler için web kancalarını yeniden oluşturur.
saveTemplate(BuildDefinitionTemplate, string, string)	Mevcut bir derleme tanımı şablonunu güncelleştirir.
updateBuild(Build, string, number, boolean)	Derlemeyi güncelleştirir.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Boru hattı genel ayarlarını güncelliyor.
updateBuildProperties(JsonPatchDocument, string, number)	Bir yapı için özellikleri güncelliyor.
updateBuilds(Build[], string)	Birden çok derlemeyi güncelleştirir.
updateBuildSettings(BuildSettings, string)	Yapı ayarlarını güncelliyor.
updateBuildTags(UpdateTagParameters, string, number)	Bir yapıdan etiket ekler/kaldırır.
updateDefinition(BuildDefinition, string, number, number, number, boolean)	Mevcut derleme tanımını güncelleştirir. 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 için özellikleri güncelliyor.
updateDefinitionTags(UpdateTagParameters, string, number)	Tanımdan etiket ekler/kaldırır.
updateFolder(Folder, string, string)	Mevcut bir klasörü belirli bir mevcut yolda güncelliyor
updateRetentionLease(RetentionLeaseUpdate, string, number)	Bir tutma kira sözleşmesinin süresi veya boru hattı koruma durumunu günceller.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Projenin tutma ayarlarını günceller.
updateStage(UpdateStageParameters, number, string, string)	Derleme aşamasını güncelleştirme

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametreler

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "965220d5-5bb9-42cf-8d67-9b146df2a5a4" = "965220d5-5bb9-42cf-8d67-9b146df2a5a4"

Özellik Değeri

"965220d5-5bb9-42cf-8d67-9b146df2a5a4"

addBuildTag(string, number, string)

Bir yapıya bir 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)

Bir yapıya 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)

Bir tanıma birden fazla 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)

Boru hattı çalışmaları için yeni kira sözleşmeleri 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)

Bir eseri bir yapı ile ilişkilendirir.

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

Parametreler

artifact: BuildArtifact

Eser.

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 yapıdan bir etiketi kaldırır. NOT: Bu API, özel karakterli etiketler için çalışmaz. Özel karakterli etiketleri kaldırmak için PATCH yöntemini kullanın (6.0+ içinde).

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

Çıkarılacak etiket.

Döndürülenler

Promise<string[]>

deleteDefinition(string, number)

Bir tanımı ve ilişkili tüm 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 bir etiketi çıkarır. NOT: Bu API, özel karakterli etiketler için çalışmaz. Özel karakterli etiketleri kaldırmak için PATCH yöntemini kullanın (6.0+ içinde).

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

Çıkarılacak etiket.

Döndürülenler

Promise<string[]>

deleteFolder(string, string)

Bir tanım klasörünü siler. Tanımlar ve ilgili yapılar da silinecek.

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 tutma 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 yapılardan, 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

Çıkarılacak etiket.

Döndürülenler

Promise<string[]>

deleteTemplate(string, string)

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

Bir yapı için özel bir artefakt alıyor.

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)

Bir yapı için özel bir artefakt alıyor.

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)

Bir yapı için tüm artefaktları alıyor.

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)

Özel bir bağlanma takılı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

Bağlanmanın türü.

name: string

Ekin adı.

Döndürülenler

Promise<ArrayBuffer>

getAttachments(string, number, string)

Bir yapıya bağlı belirli bir tip eklentilerin 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

Eklentinin türü.

Döndürülenler

Promise<Attachment[]>

getBadge(string, number, string)

En son derlemenin durumunu belirten bir rozet alır. Bu API'nin kullanımdan dolayı kullanılmadığını unutmayın. StatusBadgeController.GetStatusBadge'i tercih et.

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

Bir yapıya bağlı 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

Geri dönecek maksimum değişiklik sayısı

includeSourceChange: boolean

Döndürülenler

Promise<PagedList<Change>>

getBuildController(number)

Bir kontrolcü alıyor

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

Parametreler

controllerId: number

Döndürülenler

Promise<BuildController>

getBuildControllers(string)

Kontrolcü alıyor, isteğe bağlı olarak isimle filtreleniyor

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

Parametreler

name: string

Döndürülenler

Promise<BuildController[]>

getBuildGeneralSettings(string)

Boru hattı genel ayarlarını alıyor.

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)

Bir derleme için bireysel bir log 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

Son çizgi.

Döndürülenler

Promise<string>

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

Bir derleme için bireysel bir log 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

Son çizgi.

Döndürülenler

Promise<string[]>

getBuildLogs(string, number)

Bir yapı için logları alıyor.

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)

Bir yapı için logları alıyor.

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)

Bir derleme için bireysel bir log 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

Son çizgi.

Döndürülenler

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

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

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[])

Bir yapı için mülk alıyor.

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ış bir özellik listesi. Belirtilirse, bu özel özelliklere göre filtreler.

Döndürülenler

Promise<any>

getBuildReport(string, number, string)

Bir yapı raporu alıyor.

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)

Bir yapı raporu alıyor.

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 * ekle'yi seçin.

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ğerini temel alarak bu tarihten önce tamamlanan/başlatılan/kuyruğa alınan 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ış etiketler 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

Silinen derlemelerin dışlanıp dışlanmayacağını, dahil edilip edilmeyeceğini veya yalnızca döndürülmesi gerekip gerekmediğini gösterir.

queryOrder: BuildQueryOrder

Derlemelerin döndürülme sırası.

branchName: string

Belirtilirse, bu dalı oluşturan dalları oluşturan derlemeler için filtreler.

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)

Yapı ayarlarını alıyor.

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

Parametreler

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<BuildSettings>

getBuildStageLatestTimeline(string, number, string, number, string)

Belirli bir aşamaya göre filtrelenmiş bir derleme için en son zaman çizelgesini alır.

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

Parametreler

project: string

Proje kimliği veya proje adı

buildId: number

Derlemenin kimliği.

stageName: string

Filtrelenecek aşamanın adı.

changeId: number

Filtre ölçütü olarak değişiklik kimliği.

planId: string

Planın kimliği.

Döndürülenler

Promise<Timeline>

getBuildStageTimeline(string, number, string, string, number, string)

Belirli bir aşamaya göre filtrelenmiş bir derlemenin zaman çizelgesini alır.

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

Parametreler

project: string

Proje kimliği veya proje adı

buildId: number

Derlemenin kimliği.

timelineId: string

Zaman çizelgesinin kimliği.

stageName: string

Filtrelenecek aşamanın adı.

changeId: number

Filtre ölçütü olarak değişiklik kimliği.

planId: string

Planın kimliği.

Döndürülenler

Promise<Timeline>

getBuildTags(string, number)

Bir build için etiketleri alıyor.

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)

Bir yapı için detaylar

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 yapıya bağlı iş eşyalarını alıyor. Aynı projedeki sadece iş maddeleri iade edilir.

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

Iade edilmesi gereken maksimum iş öğesi.

Döndürülenler

Promise<ResourceRef[]>

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

Bir yapıya bağlı iş öğelerini belirli commit'lere filtreliyor.

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

Parametreler

commitIds: string[]

Commit ID'lerin virgülle ayrılmış listesi.

project: string

Proje kimliği veya proje adı

buildId: number

Derlemenin kimliği.

top: number

Geri dönmesi gereken maksimum iş öğesi sayısı veya commit ID'leri belirtilmediyse dikkate alınacak commit sayısı.

Döndürülenler

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

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

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

Parametreler

project: string

Proje kimliği veya proje adı

fromBuildId: number

İlk yapımın kimliği.

toBuildId: number

Son montajın 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 virgülle ayrılmış özellikler listesi.

includeLatestBuilds: boolean

Döndürülenler

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Bir tanım için build metriklerini alıyor.

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

Metriklerin hesaplanacağı tarih.

Döndürülenler

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Bir tanım için özellikler elde eder.

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ış bir özellik listesi. Belirtilirse, bu özel özelliklere göre filtreler.

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)

Bir tanımın tüm revizyonlarını 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 uygulama.

repositoryType: string

Belirtilirse, bu tür bir deposu olan 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 ö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ımları filtreler.

notBuiltAfter: Date

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

includeAllProperties: boolean

Tam tanımların döndürülmesi gerekip gerekmediğini gösterir. Varsayılan olarak, tanımların sığ 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 değeri true olarak ayarlanmalıdır

Döndürülenler

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Tanım etiketlerini alıyor.

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ı. Belirtilmemişse, tanımın en son revizyonunu kullanır.

Döndürülenler

Promise<string[]>

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

Bir tanımı YAML'ye dönüştürür, isteğe bağlı olarak belirli bir revizyonda.

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 virgülle ayrılmış özellikler listesi.

includeLatestBuilds: boolean

Döndürülenler

Promise<YamlBuild>

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

Yapıdan bir dosya alıyor.

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ğı isim.

Döndürülenler

Promise<ArrayBuffer>

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

Verilen kaynak kod deposunda 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, sağlayıcıya özgü tanımlayıcı veya dalları almak için depo adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

commitOrBranch: string

Bir dosyanın içeriğinin alındığı commit veya branch'in tanımlayıcısı.

path: string

Dosyanın geri alınacak yolu, deponun köküne göre.

Döndürülenler

Promise<string>

getFolders(string, string, FolderQueryOrder)

Bir derleme tanımı klasörleri alıyor.

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 geri gönderilme sırası.

Döndürülenler

Promise<Folder[]>

getLatestBuild(string, string, string)

İsteğe bağlı olarak belirli bir dal kapsamına alınmış 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ı öndeki klasör yolu veya tanım kimliğiyle 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 kod deposunda 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, sağlayıcıya özgü tanımlayıcı veya dalları almak için depo adı. Yalnızca birden çok depo desteklemeyen sağlayıcılar için atlanabilir.

commitOrBranch: string

Bir dosyanın içeriğinin alındığı commit veya branch'in tanımlayıcısı.

path: string

Liste yoluyla olan yolun içeriği, deponun köküne göre.

Döndürülenler

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Bir proje için inşa metriklerini 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

Metriklerin hesaplanacağı 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 pull request object alıyor.

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

Pull request'in satıcıya özgü kimliği.

repositoryId: string

Satıcıya özgü tanımlayıcı veya pull request'i içeren depo 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 yapı kaynakları hakkında bilgi toplar.

function getResourceUsage(): Promise<BuildResourceUsage>

Döndürülenler

Promise<BuildResourceUsage>

getRetentionHistory(number)

Proje koleksiyonunun tutma geçmişini döndürür. Bu, tutma işinin temizlenmesini engelleyebilecek özel tutma kurallarına sahip boru hatlarını, tutma tipine sahip boru hattı başına çalıştırmaları, koleksiyonun sahip olduğu boru hatlarıyla ilişkili dosyaları ve boru 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)

Kiralama kimliği verilen tutma kira sözleşmesinin detaylarını iade eder.

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 kira sözleşmelerini döndürür

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

Parametreler

project: string

Proje kimliği veya proje adı

leasesToFetch: MinimalRetentionLease[]

JSON serisi olarak seriye edilmiş MinimalRetentionLeases listesi '|' ile ayrılmıştır

Döndürülenler

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Belirtilen kuruluşa ait olan tüm kiralamaları döndürür, isteğe bağlı olarak tek bir boru hattı tanımına göre kapsamlı ve çalıştırılı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 boru hattı tanımıyla sınırlamak için isteğe bağlı bir parametre.

runId: number

Aramayı tek bir boru hattı çalıştırmasıyla sınırlamak için isteğe bağlı bir parametre. Tanım Id gerektirir.

Döndürülenler

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Belirtilen kullanıcıya ait olan tüm kiralamaları döndürür, isteğe bağlı olarak tek bir boru hattı tanımına göre kapsamlı ve çalıştırılır.

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

Parametreler

project: string

Proje kimliği veya proje adı

userOwnerId: string

Aramanız gereken kullanıcı kimliği.

definitionId: number

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

runId: number

Aramayı tek bir boru hattı çalıştırmasıyla sınırlamak için isteğe bağlı bir parametre. Tanım Id gerektirir.

Döndürülenler

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Belirli bir yapıya uygulanan tüm tutma kira sözleşmelerini alıyor.

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 tutma ayarlarını alıyor.

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>Bir tanım için derleme durumunu alır, isteğe bağlı olarak belirli bir dal, aşama, iş ve yapılandırmaya göre kapsamlıdır.</p><p>Birden fazla varsa, bir jobName belirtirken stageName değeri girmesi gerekir ve aynı kural yapılandırma parametresi geçirildiğinde 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

Ya tanım adı ve isteğe bağlı ön klasör yolu ya da tanım kimliği.

branchName: string

Sadece bu dal için en yeni yapıyı düşünün. Belirtilmezse, varsayılan dal kullanılır.

stageName: string

Durumu görüntülemek için boru hattı içindeki bu aşamayı kullanın.

jobName: string

Bu işi boru hattının bir aşamasında kullanarak durumu render edin.

configuration: string

Bu iş yapılandırmasını kullanarak durumu render edin

label: string

Rozetin sol tarafındaki varsayılan metin yerine koyar.

Döndürülenler

Promise<string>

getTags(string)

Projedeki tüm yapı etiketlerinin listesini alıyor.

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 yapı arasındaki tüm iş eşyalarını alıyor.

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

Parametreler

project: string

Proje kimliği veya proje adı

fromBuildId: number

İlk yapımın kimliği.

toBuildId: number

Son montajın kimliği.

top: number

Iade edilmesi gereken maksimum iş öğesi.

Döndürülenler

Promise<ResourceRef[]>

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

Verilen kaynak kod 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

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

branchName: string

Eğer sağlanırsa, özellikle kontrol edilecek şube adı.

Döndürülenler

Promise<string[]>

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

Kaynak kodu depolarının listesini alıyor.

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

Belirtilmişse, alınacak tedarikçiye özgü tanımlayıcı veya tek bir deponun adı.

resultSet: ResultSet

uç nokta için en ilgili depolar için 'top'. Ayarlanmadıysa, tüm depolar geri döner. 'Depo' ayarlanmışsa görmezden gelinir.

pageResults: boolean

Doğru olarak ayarlanırsa, bu sonuç kümesini sınırlar ve sorguya devam etmek için bir devam belirteci döner.

continuationToken: string

Sayfalama sonuçları olduğunda, bu bir devam belirtekenidir ve bu yönteme önceki çağrı ile döndürülür ve bir sonraki depo setini döndürmek için kullanılabilir.

Döndürülenler

Promise<SourceRepositories>

listSourceProviders(string)

Kaynak sağlayıcıların ve yeteneklerinin 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ü olan 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)

Verilen kaynak kod 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[]

Webhook'ları geri yüklemek için 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 bir derleme tanımı şablonunu güncelleştirir.

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

Parametreler

template: BuildDefinitionTemplate

Şablonun yeni versiyonu.

project: string

Proje kimliği veya proje adı

templateId: string

Şablonun kimliği.

Döndürülenler

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Derlemeyi güncelleştirir.

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)

Boru hattı genel ayarlarını güncelliyor.

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)

Bir yapı için özellikleri güncelliyor.

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

Parametreler

document: JsonPatchDocument

Güncellenecek özellikleri açıklayan bir json-patch 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 derlemeyi güncelleştirir.

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)

Yapı ayarlarını güncelliyor.

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)

Bir yapıdan etiket ekler/kaldırır.

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

Parametreler

updateParameters: UpdateTagParameters

Ekleme/kaldırma etiketleri.

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, boolean)

Mevcut derleme tanımını güncelleştirir. 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, cancelPausedBuilds?: boolean): Promise<BuildDefinition>

Parametreler

definition: BuildDefinition

Tanımın yeni versiyonu. Güncellemenin kabul edilmesi için "Revizyon" özelliğinin mevcut tanımla uyumlu olması gerekir.

project: string

Proje kimliği veya proje adı

definitionId: number

Tanımın kimliği.

secretsSourceDefinitionId: number

Gizli diziler için kaynak olarak kullanılacak tanımın isteğe bağlı kimliği.

secretsSourceDefinitionRevision: number

Gizli dizi kaynak tanımının isteğe bağlı düzeltmesi.

cancelPausedBuilds: boolean

Doğruysa, işlem hattı duraklatılmış veya devre dışı durumdan etkinleştirildiğinde duraklatılmış derlemeleri iptal eder.

Döndürülenler

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Bir tanım için özellikleri güncelliyor.

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

Parametreler

document: JsonPatchDocument

Güncellenecek özellikleri açıklayan bir json-patch 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ımdan etiket ekler/kaldırır.

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

Parametreler

updateParameters: UpdateTagParameters

Ekleme/kaldırma etiketleri.

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)

Mevcut bir klasörü belirli bir mevcut yolda güncelliyor

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

Parametreler

folder: Folder

Klasörün yeni versiyonu.

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)

Bir tutma kira sözleşmesinin süresi veya boru hattı koruma durumunu günceller.

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

Parametreler

leaseUpdate: RetentionLeaseUpdate

Tutma kirası için yeni veriler.

project: string

Proje kimliği veya proje adı

leaseId: number

Kira sözleşmesinin kimliği güncellenmesi gerekiyor.

Döndürülenler

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Projenin tutma ayarlarını günceller.

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>

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

Döndürülenler