BuildRestClient class

‏‏المرجع

الحزمة:: azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى واجهة برمجة تطبيقات VSS REST

Extends: RestClientBase

المنشئون

BuildRestClient(IVssRestClientOptions)

الخصائص

RESOURCE_AREA_ID

الأساليب

addBuildTag(string, number, string)	إضافة علامة إلى بنية.
addBuildTags(string[], string, number)	إضافة علامات إلى بنية.
addDefinitionTag(string, number, string)	إضافة علامة إلى تعريف
addDefinitionTags(string[], string, number)	إضافة علامات متعددة إلى تعريف.
addRetentionLeases(NewRetentionLease[], string)	إضافة عقود إيجار جديدة لتشغيل البنية الأساسية لبرنامج ربط العمليات التجارية.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	إقران البيانات الاصطناعية ببنية.
createDefinition(BuildDefinition, string, number, number)	إنشاء تعريف جديد.
createFolder(Folder, string, string)	إنشاء مجلد جديد.
deleteBuild(string, number)	حذف بنية.
deleteBuildTag(string, number, string)	إزالة علامة من بنية. ملاحظة: لن تعمل واجهة برمجة التطبيقات هذه مع العلامات ذات الأحرف الخاصة. لإزالة العلامات ذات الأحرف الخاصة، استخدم أسلوب PATCH بدلا من ذلك (في 6.0+)
deleteDefinition(string, number)	حذف تعريف وجميع البنيات المقترنة.
deleteDefinitionTag(string, number, string)	إزالة علامة من تعريف. ملاحظة: لن تعمل واجهة برمجة التطبيقات هذه مع العلامات ذات الأحرف الخاصة. لإزالة العلامات ذات الأحرف الخاصة، استخدم أسلوب PATCH بدلا من ذلك (في 6.0+)
deleteFolder(string, string)	حذف مجلد تعريف. سيتم أيضا حذف التعريفات وبنياتها المقابلة.
deleteRetentionLeasesById(string, number[])	يزيل عقود إيجار استبقاء محددة.
deleteTag(string, string)	إزالة علامة من البنيات والتعريفات ومن مخزن العلامات
deleteTemplate(string, string)	حذف قالب تعريف البنية.
getArtifact(string, number, string)	الحصول على بيانات اصطناعية محددة للبناء.
getArtifactContentZip(string, number, string)	الحصول على بيانات اصطناعية محددة للبناء.
getArtifacts(string, number)	يحصل على جميع البيانات الاصطناعية للبناء.
getAttachment(string, number, string, string, string, string)	يحصل على مرفق معين.
getAttachments(string, number, string)	الحصول على قائمة المرفقات من نوع معين المقترنة ببنية.
getBadge(string, number, string)	الحصول على شارة تشير إلى حالة أحدث إصدار لتعريف. لاحظ أن واجهة برمجة التطبيقات هذه مهملة. تفضل StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	الحصول على بنية
getBuildBadge(string, string, string, string)	يحصل على شارة تشير إلى حالة أحدث إصدار للفرع المحدد.
getBuildBadgeData(string, string, string, string)	يحصل على شارة تشير إلى حالة أحدث إصدار للفرع المحدد.
getBuildChanges(string, number, string, number, boolean)	الحصول على التغييرات المقترنة ببنية
getBuildController(number)	الحصول على وحدة تحكم
getBuildControllers(string)	يحصل على وحدة تحكم، تمت تصفيتها اختياريا حسب الاسم
getBuildGeneralSettings(string)	يحصل على الإعدادات العامة للبنية الأساسية لبرنامج ربط العمليات التجارية.
getBuildLog(string, number, number, number, number)	يحصل على ملف سجل فردي للإنشاء.
getBuildLogLines(string, number, number, number, number)	يحصل على ملف سجل فردي للإنشاء.
getBuildLogs(string, number)	الحصول على سجلات البناء.
getBuildLogsZip(string, number)	الحصول على سجلات البناء.
getBuildLogZip(string, number, number, number, number)	يحصل على ملف سجل فردي للإنشاء.
getBuildOptionDefinitions(string)	يحصل على جميع خيارات تعريف البناء التي يدعمها النظام.
getBuildProperties(string, number, string[])	يحصل على خصائص للبنية.
getBuildReport(string, number, string)	الحصول على تقرير البناء.
getBuildReportHtmlContent(string, number, string)	الحصول على تقرير البناء.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	الحصول على قائمة بالبناءات.
getBuildSettings(string)	الحصول على إعدادات البناء.
getBuildTags(string, number)	الحصول على علامات البناء.
getBuildTimeline(string, number, string, number, string)	الحصول على تفاصيل للبنية
getBuildWorkItemsRefs(string, number, number)	الحصول على عناصر العمل المقترنة ببنية. يتم إرجاع عناصر العمل في نفس المشروع فقط.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	يحصل على عناصر العمل المقترنة ببنية، وتصفيتها إلى تثبيتات محددة.
getChangesBetweenBuilds(string, number, number, number)	يحصل على التغييرات التي تم إجراؤها على المستودع بين بناءين معينين.
getDefinition(string, number, number, Date, string[], boolean)	الحصول على تعريف، اختياريا في مراجعة معينة.
getDefinitionMetrics(string, number, Date)	يحصل على مقاييس البناء لتعريف.
getDefinitionProperties(string, number, string[])	يحصل على خصائص لتعريف.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	يحصل على جميع مراجعات التعريف.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	الحصول على قائمة بالتعريفات.
getDefinitionTags(string, number, number)	الحصول على علامات تعريف.
getDefinitionYaml(string, number, number, Date, string[], boolean)	تحويل تعريف إلى YAML، اختياريا في مراجعة معينة.
getFile(string, number, string, string, string)	الحصول على ملف من البنية.
getFileContents(string, string, string, string, string, string)	يحصل على محتويات ملف في مستودع التعليمات البرمجية المصدر المحدد.
getFolders(string, string, FolderQueryOrder)	الحصول على قائمة بمجلدات تعريف البناء.
getLatestBuild(string, string, string)	الحصول على أحدث إصدار لتعريف، يتم تحديد نطاقه اختياريا إلى فرع معين.
getPathContents(string, string, string, string, string, string)	يحصل على محتويات دليل في مستودع التعليمات البرمجية المصدر المحدد.
getProjectMetrics(string, string, Date)	يحصل على مقاييس البناء لمشروع.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	يحصل على كائن طلب سحب من موفر المصدر.
getResourceUsage()	الحصول على معلومات حول إنشاء الموارد في النظام.
getRetentionHistory(number)	إرجاع محفوظات الاستبقاء لمجموعة المشاريع. يتضمن ذلك البنية الأساسية لبرنامج ربط العمليات التجارية التي تحتوي على قواعد استبقاء مخصصة قد تمنع مهمة الاستبقاء من تنظيفها، وتشغيلها لكل مسار بنوع استبقاء، والملفات المرتبطة بالبنية الأساسية لبرنامج ربط العمليات التجارية المملوكة للمجموعة بنوع الاستبقاء، وعدد الملفات لكل مسار.
getRetentionLease(string, number)	إرجاع تفاصيل عقد إيجار الاستبقاء نظرا لمعرف التأجير.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	إرجاع أي عقود إيجار مطابقة ل MinimalRetentionLeases المحددة
getRetentionLeasesByOwnerId(string, string, number, number)	إرجاع أي عقود إيجار مملوكة للكيان المحدد، والتي تم تحديد نطاقها اختياريا لتعريف مسار واحد وتشغيلها.
getRetentionLeasesByUserId(string, string, number, number)	إرجاع أي عقود إيجار مملوكة للمستخدم المحدد، والتي تم تحديد نطاقها اختياريا لتعريف مسار واحد وتشغيلها.
getRetentionLeasesForBuild(string, number)	يحصل على جميع عقود إيجار الاستبقاء التي تنطبق على إصدار معين.
getRetentionSettings(string)	يحصل على إعدادات استبقاء المشروع.
getStatusBadge(string, string, string, string, string, string, string)	<p>يحصل على حالة الإنشاء لتعريف، يتم تحديد نطاقه اختياريا إلى فرع ومرحلة ووظيفة وتكوين معين.< /p><p>إذا كان هناك أكثر من واحد، فمن المطلوب تمرير قيمة stageName عند تحديد jobName، وتنطبق نفس القاعدة على كليهما في حالة تمرير معلمة تكوين.< /ف>
getTags(string)	الحصول على قائمة بجميع علامات الإنشاء في المشروع.
getTemplate(string, string)	الحصول على قالب تعريف بناء معين.
getTemplates(string)	يحصل على جميع قوالب التعريف.
getWorkItemsBetweenBuilds(string, number, number, number)	يحصل على جميع عناصر العمل بين بناءين.
listBranches(string, string, string, string, string)	يحصل على قائمة بالفروع لمستودع التعليمات البرمجية المصدر المحدد.
listRepositories(string, string, string, string, ResultSet, boolean, string)	يحصل على قائمة بمستودعات التعليمات البرمجية المصدر.
listSourceProviders(string)	احصل على قائمة بموفري المصادر وقدراتهم.
listWebhooks(string, string, string, string)	يحصل على قائمة خطافات الويب المثبتة في مستودع التعليمات البرمجية المصدر المحدد.
queueBuild(Build, string, boolean, string, number, number)	قوائم انتظار بنية
restoreDefinition(string, number, boolean)	استعادة تعريف محذوف
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	إعادة إنشاء خطافات الويب للمشغلات المحددة في مستودع التعليمات البرمجية المصدر المحدد.
saveTemplate(BuildDefinitionTemplate, string, string)	التحديثات قالب تعريف بناء موجود.
updateBuild(Build, string, number, boolean)	التحديثات بناء.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	التحديثات الإعدادات العامة للبنية الأساسية لبرنامج ربط العمليات التجارية.
updateBuildProperties(JsonPatchDocument, string, number)	التحديثات خصائص للبنية.
updateBuilds(Build[], string)	التحديثات بنيات متعددة.
updateBuildSettings(BuildSettings, string)	التحديثات إعدادات البناء.
updateBuildTags(UpdateTagParameters, string, number)	إضافة/إزالة العلامات من بنية.
updateDefinition(BuildDefinition, string, number, number, number)	التحديثات تعريف بناء موجود. لكي تنجح هذه العملية، يجب أن تتطابق قيمة الخاصية "Revision" لنص الطلب مع تعريف البناء الموجود. يوصى بالحصول على تعريف البناء الموجود باستخدام GET، وتعديل تعريف البناء حسب الضرورة، ثم إرسال التعريف المعدل باستخدام PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	التحديثات خصائص لتعريف.
updateDefinitionTags(UpdateTagParameters, string, number)	إضافة/إزالة العلامات من تعريف.
updateFolder(Folder, string, string)	التحديثات مجلد موجود في مسار موجود معين
updateRetentionLease(RetentionLeaseUpdate, string, number)	التحديثات مدة عقد إيجار الاستبقاء أو حالة حماية البنية الأساسية لبرنامج ربط العمليات التجارية.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	التحديثات إعدادات استبقاء المشروع.
updateStage(UpdateStageParameters, number, string, string)	تحديث مرحلة الإنشاء

تفاصيل المنشئ

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

تفاصيل الخاصية

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

تفاصيل الأسلوب

addBuildTag(string, number, string)

إضافة علامة إلى بنية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

tag: string

العلامة المراد إضافتها.

المرتجعات

Promise<string[]>

addBuildTags(string[], string, number)

إضافة علامات إلى بنية.

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

المعلمات

tags: string[]

العلامات المراد إضافتها. يتكون نص الطلب مباشرة من العلامات المدرجة.

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<string[]>

addDefinitionTag(string, number, string)

إضافة علامة إلى تعريف

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

tag: string

العلامة المراد إضافتها.

المرتجعات

Promise<string[]>

addDefinitionTags(string[], string, number)

إضافة علامات متعددة إلى تعريف.

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

المعلمات

tags: string[]

العلامات المراد إضافتها.

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

المرتجعات

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

إضافة عقود إيجار جديدة لتشغيل البنية الأساسية لبرنامج ربط العمليات التجارية.

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

المعلمات

newLeases: NewRetentionLease[]

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

المعلمات

resources: DefinitionResourceReference[]

project: string

معرف المشروع أو اسم المشروع

definitionId: number

المرتجعات

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

المعلمات

resources: DefinitionResourceReference[]

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

إقران البيانات الاصطناعية ببنية.

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

المعلمات

artifact: BuildArtifact

البيانات الاصطناعية.

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

إنشاء تعريف جديد.

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

المعلمات

definition: BuildDefinition

التعريف.

project: string

معرف المشروع أو اسم المشروع

definitionToCloneId: number

definitionToCloneRevision: number

المرتجعات

Promise<BuildDefinition>

createFolder(Folder, string, string)

إنشاء مجلد جديد.

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

المعلمات

folder: Folder

المجلد.

project: string

معرف المشروع أو اسم المشروع

path: string

المسار الكامل للمجلد.

المرتجعات

Promise<Folder>

deleteBuild(string, number)

حذف بنية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<void>

deleteBuildTag(string, number, string)

إزالة علامة من بنية. ملاحظة: لن تعمل واجهة برمجة التطبيقات هذه مع العلامات ذات الأحرف الخاصة. لإزالة العلامات ذات الأحرف الخاصة، استخدم أسلوب PATCH بدلا من ذلك (في 6.0+)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

tag: string

العلامة المراد إزالتها.

المرتجعات

Promise<string[]>

deleteDefinition(string, number)

حذف تعريف وجميع البنيات المقترنة.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

المرتجعات

Promise<void>

deleteDefinitionTag(string, number, string)

إزالة علامة من تعريف. ملاحظة: لن تعمل واجهة برمجة التطبيقات هذه مع العلامات ذات الأحرف الخاصة. لإزالة العلامات ذات الأحرف الخاصة، استخدم أسلوب PATCH بدلا من ذلك (في 6.0+)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

tag: string

العلامة المراد إزالتها.

المرتجعات

Promise<string[]>

deleteFolder(string, string)

حذف مجلد تعريف. سيتم أيضا حذف التعريفات وبنياتها المقابلة.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

path: string

المسار الكامل إلى المجلد.

المرتجعات

Promise<void>

deleteRetentionLeasesById(string, number[])

يزيل عقود إيجار استبقاء محددة.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

ids: number[]

المرتجعات

Promise<void>

deleteTag(string, string)

إزالة علامة من البنيات والتعريفات ومن مخزن العلامات

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

tag: string

العلامة المراد إزالتها.

المرتجعات

Promise<string[]>

deleteTemplate(string, string)

حذف قالب تعريف البنية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

templateId: string

معرف القالب.

المرتجعات

Promise<void>

getArtifact(string, number, string)

الحصول على بيانات اصطناعية محددة للبناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

artifactName: string

اسم البيانات الاصطناعية.

المرتجعات

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

الحصول على بيانات اصطناعية محددة للبناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

artifactName: string

اسم البيانات الاصطناعية.

المرتجعات

Promise<ArrayBuffer>

getArtifacts(string, number)

يحصل على جميع البيانات الاصطناعية للبناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<BuildArtifact[]>

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

يحصل على مرفق معين.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

timelineId: string

معرف المخطط الزمني.

recordId: string

معرف سجل المخطط الزمني.

type: string

نوع المرفق.

name: string

اسم المرفق.

المرتجعات

Promise<ArrayBuffer>

getAttachments(string, number, string)

الحصول على قائمة المرفقات من نوع معين المقترنة ببنية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

type: string

نوع المرفق.

المرتجعات

Promise<Attachment[]>

getBadge(string, number, string)

الحصول على شارة تشير إلى حالة أحدث إصدار لتعريف. لاحظ أن واجهة برمجة التطبيقات هذه مهملة. تفضل StatusBadgeController.GetStatusBadge.

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

المعلمات

project: string

معرف المشروع أو اسمه.

definitionId: number

معرف التعريف.

branchName: string

اسم الفرع.

المرتجعات

Promise<string>

getBuild(string, number, string)

الحصول على بنية

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

propertyFilters: string

المرتجعات

Promise<Build>

getBuildBadge(string, string, string, string)

يحصل على شارة تشير إلى حالة أحدث إصدار للفرع المحدد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

repoType: string

نوع المستودع.

repoId: string

معرف المستودع.

branchName: string

اسم الفرع.

المرتجعات

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

يحصل على شارة تشير إلى حالة أحدث إصدار للفرع المحدد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

repoType: string

نوع المستودع.

repoId: string

معرف المستودع.

branchName: string

اسم الفرع.

المرتجعات

Promise<string>

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

الحصول على التغييرات المقترنة ببنية

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

continuationToken: string

top: number

الحد الأقصى لعدد التغييرات التي يجب إرجاعها

includeSourceChange: boolean

المرتجعات

Promise<PagedList<Change>>

getBuildController(number)

الحصول على وحدة تحكم

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

المعلمات

controllerId: number

المرتجعات

Promise<BuildController>

getBuildControllers(string)

يحصل على وحدة تحكم، تمت تصفيتها اختياريا حسب الاسم

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

المعلمات

name: string

المرتجعات

Promise<BuildController[]>

getBuildGeneralSettings(string)

يحصل على الإعدادات العامة للبنية الأساسية لبرنامج ربط العمليات التجارية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<PipelineGeneralSettings>

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

يحصل على ملف سجل فردي للإنشاء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

logId: number

معرف ملف السجل.

startLine: number

خط البدء.

endLine: number

خط النهاية.

المرتجعات

Promise<string>

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

يحصل على ملف سجل فردي للإنشاء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

logId: number

معرف ملف السجل.

startLine: number

خط البدء.

endLine: number

خط النهاية.

المرتجعات

Promise<string[]>

getBuildLogs(string, number)

الحصول على سجلات البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<BuildLog[]>

getBuildLogsZip(string, number)

الحصول على سجلات البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<ArrayBuffer>

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

يحصل على ملف سجل فردي للإنشاء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

logId: number

معرف ملف السجل.

startLine: number

خط البدء.

endLine: number

خط النهاية.

المرتجعات

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

يحصل على جميع خيارات تعريف البناء التي يدعمها النظام.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

يحصل على خصائص للبنية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

filter: string[]

قائمة خصائص محددة بفاصلة. إذا تم تحديدها، يتم تصفية هذه الخصائص المحددة.

المرتجعات

Promise<any>

getBuildReport(string, number, string)

الحصول على تقرير البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

type: string

المرتجعات

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

الحصول على تقرير البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

type: string

المرتجعات

Promise<any>

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

الحصول على قائمة بالبناءات.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitions: number[]

قائمة محددة بفاصلة من معرفات التعريف. إذا تم تحديده، يقوم بتصفية الإصدارات لهذه التعريفات.

queues: number[]

قائمة محددة بفاصلة من معرفات قائمة الانتظار. إذا تم تحديده، يقوم بتصفية الإصدارات التي تم تشغيلها مقابل قوائم الانتظار هذه.

buildNumber: string

إذا تم تحديده، يقوم بتصفية الإصدارات التي تطابق رقم البناء هذا. إلحاق * لإجراء بحث عن بادئة.

minTime: Date

إذا تم تحديده، يقوم بتصفية الإصدارات التي انتهت/بدأت/في قائمة الانتظار بعد هذا التاريخ استنادا إلى queryOrder المحدد.

maxTime: Date

إذا تم تحديده، يقوم بتصفية الإصدارات التي انتهت/بدأت/في قائمة الانتظار قبل هذا التاريخ استنادا إلى queryOrder المحدد.

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

getBuildSettings(string)

الحصول على إعدادات البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<BuildSettings>

getBuildTags(string, number)

الحصول على علامات البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

المرتجعات

Promise<string[]>

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

الحصول على تفاصيل للبنية

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

timelineId: string

changeId: number

planId: string

المرتجعات

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

الحصول على عناصر العمل المقترنة ببنية. يتم إرجاع عناصر العمل في نفس المشروع فقط.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

top: number

الحد الأقصى لعدد عناصر العمل المراد إرجاعها.

المرتجعات

Promise<ResourceRef[]>

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

يحصل على عناصر العمل المقترنة ببنية، وتصفيتها إلى تثبيتات محددة.

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

المعلمات

commitIds: string[]

قائمة محددة بفاصلة من معرفات التثبيت.

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

top: number

الحد الأقصى لعدد عناصر العمل المراد إرجاعها، أو عدد التثبيتات التي يجب مراعاتها إذا لم يتم تحديد معرفات التثبيت.

المرتجعات

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

يحصل على التغييرات التي تم إجراؤها على المستودع بين بناءين معينين.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

fromBuildId: number

معرف الإصدار الأول.

toBuildId: number

معرف الإصدار الأخير.

top: number

الحد الأقصى لعدد التغييرات التي يجب إرجاعها.

المرتجعات

Promise<Change[]>

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

الحصول على تعريف، اختياريا في مراجعة معينة.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

revision: number

رقم المراجعة المراد استرداده. إذا لم يتم تحديد ذلك، فسيتم إرجاع أحدث إصدار.

minMetricsTime: Date

إذا تم تحديده، يشير إلى التاريخ الذي يجب تضمين المقاييس منه.

propertyFilters: string[]

قائمة خصائص محددة بفاصلة لتضمينها في النتائج.

includeLatestBuilds: boolean

المرتجعات

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

يحصل على مقاييس البناء لتعريف.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

minMetricsTime: Date

التاريخ الذي يتم من خلاله حساب المقاييس.

المرتجعات

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

يحصل على خصائص لتعريف.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

filter: string[]

قائمة خصائص محددة بفاصلة. إذا تم تحديدها، يتم تصفية هذه الخصائص المحددة.

المرتجعات

Promise<any>

getDefinitionResources(string, number)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

المرتجعات

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

يحصل على جميع مراجعات التعريف.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

المرتجعات

Promise<BuildDefinitionRevision[]>

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

الحصول على قائمة بالتعريفات.

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

المعلمات

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

إذا تم تحديدها، يتم تصفية تعريفات YAML التي تطابق اسم الملف المحدد. لاستخدام عامل التصفية هذا، يجب تعيينAllProperties إلى true

المرتجعات

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

الحصول على علامات تعريف.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

revision: number

رقم مراجعة التعريف. إذا لم يتم تحديده، يستخدم أحدث مراجعة للتعريف.

المرتجعات

Promise<string[]>

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

تحويل تعريف إلى YAML، اختياريا في مراجعة معينة.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

revision: number

رقم المراجعة المراد استرداده. إذا لم يتم تحديد ذلك، فسيتم إرجاع أحدث إصدار.

minMetricsTime: Date

إذا تم تحديده، يشير إلى التاريخ الذي يجب تضمين المقاييس منه.

propertyFilters: string[]

قائمة خصائص محددة بفاصلة لتضمينها في النتائج.

includeLatestBuilds: boolean

المرتجعات

Promise<YamlBuild>

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

الحصول على ملف من البنية.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البنية.

artifactName: string

اسم البيانات الاصطناعية.

fileId: string

المفتاح الأساسي للملف.

fileName: string

الاسم الذي سيتم تعيين الملف إليه.

المرتجعات

Promise<ArrayBuffer>

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

يحصل على محتويات ملف في مستودع التعليمات البرمجية المصدر المحدد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

serviceEndpointId: string

إذا تم تحديده، معرف نقطة نهاية الخدمة للاستعلام. يمكن حذفه فقط للموفرين الذين لا يستخدمون نقاط نهاية الخدمة، على سبيل المثال TFVC أو TFGit.

repository: string

إذا تم تحديده، المعرف الخاص بالمورد أو اسم المستودع للحصول على الفروع. يمكن حذفه فقط للموفرين الذين لا يدعمون مستودعات متعددة.

commitOrBranch: string

معرف التثبيت أو الفرع الذي يتم استرداد محتويات الملف منه.

path: string

المسار إلى الملف المراد استرداده، بالنسبة إلى جذر المستودع.

المرتجعات

Promise<string>

getFolders(string, string, FolderQueryOrder)

الحصول على قائمة بمجلدات تعريف البناء.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

path: string

المسار الذي يجب البدء به.

queryOrder: FolderQueryOrder

الترتيب الذي يجب إرجاع المجلدات به.

المرتجعات

Promise<Folder[]>

getLatestBuild(string, string, string)

الحصول على أحدث إصدار لتعريف، يتم تحديد نطاقه اختياريا إلى فرع معين.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definition: string

اسم التعريف مع مسار مجلد بادئة اختياري، أو معرف التعريف

branchName: string

المعلمة الاختيارية التي تشير إلى الفرع المحدد المراد استخدامه. إذا لم يتم تحديده، يتم استخدام الفرع الافتراضي.

المرتجعات

Promise<Build>

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

يحصل على محتويات دليل في مستودع التعليمات البرمجية المصدر المحدد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

serviceEndpointId: string

repository: string

commitOrBranch: string

معرف التثبيت أو الفرع الذي يتم استرداد محتويات الملف منه.

path: string

محتويات المسار إلى القائمة، بالنسبة إلى جذر المستودع.

المرتجعات

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

يحصل على مقاييس البناء لمشروع.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

metricAggregationType: string

نوع التجميع المراد استخدامه (كل ساعة، يوميا).

minMetricsTime: Date

التاريخ الذي يتم من خلاله حساب المقاييس.

المرتجعات

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

type: string

id: string

المرتجعات

Promise<DefinitionResourceReference[]>

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

يحصل على كائن طلب سحب من موفر المصدر.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

pullRequestId: string

معرف خاص بالمورد لطلب السحب.

repositoryId: string

المعرف الخاص بالمورد أو اسم المستودع الذي يحتوي على طلب السحب.

serviceEndpointId: string

المرتجعات

Promise<PullRequest>

getResourceUsage()

الحصول على معلومات حول إنشاء الموارد في النظام.

function getResourceUsage(): Promise<BuildResourceUsage>

المرتجعات

Promise<BuildResourceUsage>

getRetentionHistory(number)

إرجاع محفوظات الاستبقاء لمجموعة المشاريع. يتضمن ذلك البنية الأساسية لبرنامج ربط العمليات التجارية التي تحتوي على قواعد استبقاء مخصصة قد تمنع مهمة الاستبقاء من تنظيفها، وتشغيلها لكل مسار بنوع استبقاء، والملفات المرتبطة بالبنية الأساسية لبرنامج ربط العمليات التجارية المملوكة للمجموعة بنوع الاستبقاء، وعدد الملفات لكل مسار.

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

المعلمات

daysToLookback: number

المرتجعات

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

إرجاع تفاصيل عقد إيجار الاستبقاء نظرا لمعرف التأجير.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

leaseId: number

المرتجعات

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

إرجاع أي عقود إيجار مطابقة ل MinimalRetentionLeases المحددة

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

leasesToFetch: MinimalRetentionLease[]

قائمة ب MinimalRetentionLeases المتسلسلة بواسطة JSON مفصولة ب '|'

المرتجعات

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

إرجاع أي عقود إيجار مملوكة للكيان المحدد، والتي تم تحديد نطاقها اختياريا لتعريف مسار واحد وتشغيلها.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

ownerId: string

definitionId: number

معلمة اختيارية للحد من البحث إلى تعريف مسار معين.

runId: number

معلمة اختيارية للحد من البحث إلى تشغيل مسار واحد. يتطلب معرف التعريف.

المرتجعات

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

إرجاع أي عقود إيجار مملوكة للمستخدم المحدد، والتي تم تحديد نطاقها اختياريا لتعريف مسار واحد وتشغيلها.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

userOwnerId: string

معرف المستخدم للبحث عن.

definitionId: number

معلمة اختيارية للحد من البحث إلى تعريف مسار معين.

runId: number

معلمة اختيارية للحد من البحث إلى تشغيل مسار واحد. يتطلب معرف التعريف.

المرتجعات

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

يحصل على جميع عقود إيجار الاستبقاء التي تنطبق على إصدار معين.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البناء.

المرتجعات

Promise<RetentionLease[]>

getRetentionSettings(string)

يحصل على إعدادات استبقاء المشروع.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<ProjectRetentionSetting>

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

<p>يحصل على حالة الإنشاء لتعريف، يتم تحديد نطاقه اختياريا إلى فرع ومرحلة ووظيفة وتكوين معين.< /p><p>إذا كان هناك أكثر من واحد، فمن المطلوب تمرير قيمة stageName عند تحديد jobName، وتنطبق نفس القاعدة على كليهما في حالة تمرير معلمة تكوين.< /ف>

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definition: string

إما اسم التعريف مع مسار مجلد بادئة اختياري، أو معرف التعريف.

branchName: string

ضع في اعتبارك أحدث إصدار لهذا الفرع فقط. إذا لم يتم تحديده، يتم استخدام الفرع الافتراضي.

stageName: string

استخدم هذه المرحلة داخل البنية الأساسية لبرنامج ربط العمليات التجارية لعرض الحالة.

jobName: string

استخدم هذه المهمة ضمن مرحلة من البنية الأساسية لبرنامج ربط العمليات التجارية لعرض الحالة.

configuration: string

استخدم تكوين الوظيفة هذا لعرض الحالة

label: string

يستبدل النص الافتراضي على الجانب الأيسر من الشارة.

المرتجعات

Promise<string>

getTags(string)

الحصول على قائمة بجميع علامات الإنشاء في المشروع.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<string[]>

getTemplate(string, string)

الحصول على قالب تعريف بناء معين.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

templateId: string

معرف القالب المطلوب.

المرتجعات

Promise<BuildDefinitionTemplate>

getTemplates(string)

يحصل على جميع قوالب التعريف.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

يحصل على جميع عناصر العمل بين بناءين.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

fromBuildId: number

معرف الإصدار الأول.

toBuildId: number

معرف الإصدار الأخير.

top: number

الحد الأقصى لعدد عناصر العمل المراد إرجاعها.

المرتجعات

Promise<ResourceRef[]>

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

يحصل على قائمة بالفروع لمستودع التعليمات البرمجية المصدر المحدد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

serviceEndpointId: string

repository: string

المعرف الخاص بالمورد أو اسم المستودع للحصول على الفروع. يمكن حذفه فقط للموفرين الذين لا يدعمون مستودعات متعددة.

branchName: string

إذا تم توفيره، اسم الفرع الذي يجب التحقق من وجوده على وجه التحديد.

المرتجعات

Promise<string[]>

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

يحصل على قائمة بمستودعات التعليمات البرمجية المصدر.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

serviceEndpointId: string

repository: string

إذا تم تحديده، المعرف الخاص بالمورد أو اسم مستودع واحد للحصول عليه.

resultSet: ResultSet

"أعلى" للمستودعات الأكثر صلة بنقطة النهاية. إذا لم يتم تعيينها، يتم إرجاع جميع المستودعات. يتم تجاهل إذا تم تعيين "المستودع".

pageResults: boolean

إذا تم تعيينه إلى true، فسيحد هذا من مجموعة النتائج وسيعيد رمزا مميزا للمتابعة لمتابعة الاستعلام.

continuationToken: string

عند ترحيل النتائج، يكون هذا رمزا مميزا للمتابعة، يتم إرجاعه بواسطة استدعاء سابق لهذا الأسلوب، يمكن استخدامه لإرجاع المجموعة التالية من المستودعات.

المرتجعات

Promise<SourceRepositories>

listSourceProviders(string)

احصل على قائمة بموفري المصادر وقدراتهم.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

يحصل على قائمة خطافات الويب المثبتة في مستودع التعليمات البرمجية المصدر المحدد.

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

serviceEndpointId: string

repository: string

إذا تم تحديده، فإن المعرف الخاص بالمورد أو اسم المستودع للحصول على إخطارات على الويب. يمكن حذفه فقط للموفرين الذين لا يدعمون مستودعات متعددة.

المرتجعات

Promise<RepositoryWebhook[]>

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

قوائم انتظار بنية

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

المعلمات

build: Build

project: string

معرف المشروع أو اسم المشروع

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

معرف التعريف الاختياري لقائمة انتظار بنية بدون نص. يتم تجاهله إذا كان هناك نص صالح

المرتجعات

Promise<Build>

restoreDefinition(string, number, boolean)

استعادة تعريف محذوف

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

المعلمات

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف المراد استعادته.

deleted: boolean

عند الخطأ، يستعيد تعريفا محذوفا.

المرتجعات

Promise<BuildDefinition>

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

إعادة إنشاء خطافات الويب للمشغلات المحددة في مستودع التعليمات البرمجية المصدر المحدد.

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

المعلمات

triggerTypes: DefinitionTriggerType[]

أنواع المشغلات لاستعادة خطافات الويب لها.

project: string

معرف المشروع أو اسم المشروع

providerName: string

اسم موفر المصدر.

serviceEndpointId: string

repository: string

المرتجعات

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

التحديثات قالب تعريف بناء موجود.

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

المعلمات

template: BuildDefinitionTemplate

الإصدار الجديد من القالب.

project: string

معرف المشروع أو اسم المشروع

templateId: string

معرف القالب.

المرتجعات

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

التحديثات بناء.

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

المعلمات

build: Build

البنية.

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البناء.

retry: boolean

المرتجعات

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

التحديثات الإعدادات العامة للبنية الأساسية لبرنامج ربط العمليات التجارية.

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

المعلمات

newSettings: PipelineGeneralSettings

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

التحديثات خصائص للبنية.

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

المعلمات

document: JsonPatchDocument

مستند json-patch يصف الخصائص المراد تحديثها.

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البناء.

المرتجعات

Promise<any>

updateBuilds(Build[], string)

التحديثات بنيات متعددة.

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

المعلمات

builds: Build[]

الإصدارات المراد تحديثها.

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

التحديثات إعدادات البناء.

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

المعلمات

settings: BuildSettings

الإعدادات الجديدة.

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

إضافة/إزالة العلامات من بنية.

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

المعلمات

updateParameters: UpdateTagParameters

العلامات المراد إضافتها/إزالتها.

project: string

معرف المشروع أو اسم المشروع

buildId: number

معرف البناء.

المرتجعات

Promise<string[]>

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

التحديثات تعريف بناء موجود. لكي تنجح هذه العملية، يجب أن تتطابق قيمة الخاصية "Revision" لنص الطلب مع تعريف البناء الموجود. يوصى بالحصول على تعريف البناء الموجود باستخدام GET، وتعديل تعريف البناء حسب الضرورة، ثم إرسال التعريف المعدل باستخدام PUT.

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

المعلمات

definition: BuildDefinition

الإصدار الجديد من التعريف. يجب أن تتطابق الخاصية "Revision" الخاصة بها مع التعريف الحالي للتحديث ليتم قبوله.

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

المرتجعات

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

التحديثات خصائص لتعريف.

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

المعلمات

document: JsonPatchDocument

مستند json-patch يصف الخصائص المراد تحديثها.

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

المرتجعات

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

إضافة/إزالة العلامات من تعريف.

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

المعلمات

updateParameters: UpdateTagParameters

العلامات المراد إضافتها/إزالتها.

project: string

معرف المشروع أو اسم المشروع

definitionId: number

معرف التعريف.

المرتجعات

Promise<string[]>

updateFolder(Folder, string, string)

التحديثات مجلد موجود في مسار موجود معين

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

المعلمات

folder: Folder

الإصدار الجديد من المجلد.

project: string

معرف المشروع أو اسم المشروع

path: string

المسار الكامل إلى المجلد.

المرتجعات

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

التحديثات مدة عقد إيجار الاستبقاء أو حالة حماية البنية الأساسية لبرنامج ربط العمليات التجارية.

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

المعلمات

leaseUpdate: RetentionLeaseUpdate

البيانات الجديدة لإيجار الاستبقاء.

project: string

معرف المشروع أو اسم المشروع

leaseId: number

معرف عقد الإيجار المراد تحديثه.

المرتجعات

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

التحديثات إعدادات استبقاء المشروع.

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

المعلمات

updateModel: UpdateProjectRetentionSettingModel

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

تحديث مرحلة الإنشاء

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

المعلمات

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<void>

مهرجان مهارات الذكاء الاصطناعي

مشاركة عبر

BuildRestClient class

المنشئون

الخصائص

الأساليب

تفاصيل المنشئ

BuildRestClient(IVssRestClientOptions)

المعلمات

تفاصيل الخاصية

RESOURCE_AREA_ID

قيمة الخاصية

تفاصيل الأسلوب

addBuildTag(string, number, string)

المعلمات

المرتجعات

addBuildTags(string[], string, number)

المعلمات

المرتجعات

addDefinitionTag(string, number, string)

المعلمات

المرتجعات

addDefinitionTags(string[], string, number)

المعلمات

المرتجعات

addRetentionLeases(NewRetentionLease[], string)

المعلمات

المرتجعات

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

المعلمات

المرتجعات

authorizeProjectResources(DefinitionResourceReference[], string)

المعلمات

المرتجعات

createArtifact(BuildArtifact, string, number)

المعلمات

المرتجعات

createDefinition(BuildDefinition, string, number, number)

المعلمات

المرتجعات

createFolder(Folder, string, string)

المعلمات

المرتجعات

deleteBuild(string, number)

المعلمات

المرتجعات

deleteBuildTag(string, number, string)

المعلمات

المرتجعات

deleteDefinition(string, number)

المعلمات

المرتجعات

deleteDefinitionTag(string, number, string)

المعلمات

المرتجعات

deleteFolder(string, string)

المعلمات

المرتجعات

deleteRetentionLeasesById(string, number[])

المعلمات

المرتجعات

deleteTag(string, string)

المعلمات

المرتجعات

deleteTemplate(string, string)

المعلمات

المرتجعات

getArtifact(string, number, string)

المعلمات

المرتجعات

getArtifactContentZip(string, number, string)

المعلمات

المرتجعات

getArtifacts(string, number)

المعلمات

المرتجعات

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

المعلمات

المرتجعات

getAttachments(string, number, string)