GitRestClient class

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

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

يمتد: RestClientBase

المنشئون

الخصائص

الأساليب

createAnnotatedTag(GitAnnotatedTag, string, string)	إنشاء علامة ذات تعليقات توضيحية.
createAttachment(any, string, string, number, string)	إرفاق ملف جديد بطلب سحب.
createCherryPick(GitAsyncRefOperationParameters, string, string)	اختر Cherry تثبيتا معينا أو تثبيتات مرتبطة بطلب سحب إلى فرع جديد.
createComment(Comment, string, number, number, string)	إنشاء تعليق على مؤشر ترابط معين في طلب سحب (يمكن إنشاء ما يصل إلى 500 تعليق لكل مؤشر ترابط).
createCommitStatus(GitStatus, string, string, string)	إنشاء حالة تثبيت Git.
createFavorite(GitRefFavorite, string)	إنشاء مرجع مفضل
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	اطلب إحضار refs الخاصة بمستودع آخر في هذا المستودع. يقوم بمزامنة اثنين من الشعبات الموجودة. لإنشاء تفرع، يرجى مراجعة <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" > المستودعات endpoint</a>
createImportRequest(GitImportRequest, string, string)	إنشاء طلب استيراد.
createLike(string, number, number, number, string)	أضف مثل في تعليق.
createMergeRequest(GitMergeParameters, string, string, boolean)	طلب عملية دمج git. حاليا نحن ندعم دمج التزامين فقط.
createPullRequest(GitPullRequest, string, string, boolean)	إنشاء طلب سحب.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	إنشاء حالة طلب سحب على التكرار. سيكون لهذه العملية نفس النتيجة مثل إنشاء حالة عند طلب السحب بمعرف تكرار محدد في نص الطلب.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	أنشئ علامة (إذا لم يكن موجودا بعد) وأضفها كتسمية (علامة) لطلب سحب محدد. الحقل المطلوب الوحيد هو اسم التسمية الجديدة (العلامة).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	إضافة مراجع إلى طلب سحب أو التصويت.
createPullRequestReviewers(IdentityRef[], string, number, string)	إضافة مراجعين إلى طلب سحب.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	إنشاء حالة طلب سحب.
createPush(GitPush, string, string)	دفع التغييرات إلى المستودع.
createRepository(GitRepositoryCreateOptions, string, string)	أنشئ مستودع git في project فريق.
createRevert(GitAsyncRefOperationParameters, string, string)	يبدأ العملية لإنشاء فرع جديد يعيد التغييرات التي أدخلتها إما تثبيت معين أو عمليات تثبيت مقترنة بطلب سحب.
createThread(GitPullRequestCommentThread, string, number, string)	إنشاء مؤشر ترابط في طلب سحب.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	أضف هوية غير ذات تطابق إلى مراجعي طلب السحب.
deleteAttachment(string, string, number, string)	حذف مرفق طلب سحب.
deleteComment(string, number, number, number, string)	احذف تعليقا مقترنا بمترابط معين في طلب سحب.
deleteEnablementStatus(boolean, boolean, string[])	DELETE يحذف حالة التمكين وبيانات BillableCommitters من DB. سيؤدي حذف بيانات التمكين إلى تعطيلها بشكل فعال للمستودعات المتأثرة.
deleteLike(string, number, number, number, string)	حذف مثل في تعليق.
deletePullRequestIterationStatus(string, number, number, number, string)	حذف حالة تكرار طلب السحب.
deletePullRequestLabels(string, number, string, string, string)	إزالة تسمية (علامة) من مجموعة تلك المعينة لطلب السحب. لن يتم حذف العلامة نفسها.
deletePullRequestReviewer(string, number, string, string)	إزالة مراجع من طلب سحب.
deletePullRequestStatus(string, number, number, string)	حذف حالة طلب السحب.
deleteRefFavorite(string, number)	حذف المفضلة refs المحددة
deleteRepository(string, string)	حذف مستودع git
deleteRepositoryFromRecycleBin(string, string)	قم بإتلاف (حذف ثابت) مستودع Git محذوف مبدئيا.
getAccessibleRepositories(GetAccessibleRepositoriesRequest)	طلب POST للحصول على مستودعات قابلة للوصول بناء على الإذن (عملية دفعية).
getAnnotatedTag(string, string, string)	الحصول على علامة ذات تعليقات توضيحية.
getAttachmentContent(string, string, number, string)	احصل على محتوى ملف مرفق طلب سحب.
getAttachments(string, number, string)	احصل على قائمة بالملفات المرفقة بطلب سحب معين.
getAttachmentZip(string, string, number, string)	احصل على محتوى ملف مرفق طلب سحب.
getBillableCommitters(string, Date, number, number)	استرداد الملتزمين الفعليين القابلين للفوترة لخدمة الأمان المتقدمة لتاريخ معين.
getBillableCommittersDetail(string, string, Date)	استرداد الملتزمين الفعليين المفصلين القابلين للفوترة لخدمة الأمان المتقدمة لتاريخ معين. لا تقوم النتائج التفصيلية عمدا بتصفية المشاريع والمستودعات المحذوفة مبدئيا للمساعدة في تشخيص مشكلات الفوترة.
getBlob(string, string, string, boolean, string, boolean)	الحصول على كائن ثنائي كبير الحجم واحد.
getBlobContent(string, string, string, boolean, string, boolean)	الحصول على كائن ثنائي كبير الحجم واحد.
getBlobsZip(string[], string, string, string)	الحصول على كائن ثنائي كبير الحجم واحد أو أكثر في تنزيل ملف مضغوط.
getBlobZip(string, string, string, boolean, string, boolean)	الحصول على كائن ثنائي كبير الحجم واحد.
getBranch(string, string, string, GitVersionDescriptor)	استرداد إحصائيات حول فرع واحد.
getBranches(string, string, GitVersionDescriptor)	استرداد إحصائيات حول جميع الفروع داخل المستودع.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	استرداد الإحصائيات للتثبيتات المتعددة
getChanges(string, string, string, number, number)	استرداد التغييرات لتثبيت معين.
getCherryPick(string, number, string)	استرداد معلومات حول عملية اختيار الكرز بواسطة معرف اختيار الكرز.
getCherryPickConflict(string, number, number, string)	استرداد تعارض واحد لاختيار الكرز بواسطة المعرف
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	استرداد جميع التعارضات لاختيار الكرز
getCherryPickForRefName(string, string, string)	استرداد معلومات حول عملية اختيار الكرز لفرع معين. هذه العملية مكلفة بسبب بنية الكائن الأساسي، لذلك تنظر واجهة برمجة التطبيقات هذه فقط إلى أحدث عمليات اختيار الكرز 1000.
getCherryPickRelationships(string, string, string, boolean)	بالنظر إلى commitId، ترجع قائمة التثبيتات الموجودة في نفس عائلة cherry-pick.
getComment(string, number, number, number, string)	استرداد تعليق مقترن بمترابط معين في طلب سحب.
getComments(string, number, number, string)	استرداد كافة التعليقات المقترنة بمترابط معين في طلب سحب.
getCommit(string, string, string, number)	استرداد تثبيت معين.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	ابحث عن أقرب تثبيت شائع (قاعدة الدمج) بين التثبيتات الأساسية والهدف، والحصول على الفرق بين التثبيتات الأساسية والهدف أو التثبيتات الشائعة والهدف.
getCommits(string, GitQueryCommitsCriteria, string)	استرجاع git commits لمشروع project
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	استرجاع git commits لمشروع project يطابق معايير البحث
getDeletedRepositories(string)	استرداد مستودعات git المحذوفة.
getEnablementStatus(string[], Date, number, number)	احصل على حالة تمكين مستودعات project.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	احصل على الالتزامات المقدرة القابلة للفوترة لمستودع لآخر 90 يوما.
getEstimatedBillablePushersOrg()	احصل على دفعات مقدرة قابلة للفوترة لمؤسسة لآخر 90 يوما.
getEstimatedBillablePushersProject(string)	احصل على تقديرات الموظفين القابلين للفوترة لمشروع project لآخر 90 يوما.
getFileDiffs(FileDiffsCriteria, string, string)	الحصول على ملفات diffs لكل ملف من الملفات المحددة
getForks(string, string, string, boolean)	استرداد جميع نسخ المستودع في المجموعة.
getForkSyncRequest(string, number, string, boolean)	احصل على تفاصيل عملية مزامنة نسخة المستودع المحددة.
getForkSyncRequests(string, string, boolean, boolean)	استرداد جميع عمليات مزامنة التشعب المطلوبة على هذا المستودع.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لمجموعة من العناصر. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getImportRequest(string, string, number)	استرداد طلب استيراد معين.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لمجموعة من العناصر. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل.
getItemsBatch(GitItemRequestData, string, string)	يسترجع دفعة من العناصر في مستودع / project لقائمة مسارات معينة أو مسار طويل
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط، الذي يتم إرجاعه دائما كتنزيل.
getLikes(string, number, number, number, string)	احصل على الإعجابات بالتعليق.
getMergeBases(string, string, string, string, string, string)	ابحث عن قواعد دمج تثبيتين، اختياريا عبر التشعبات. إذا لم يتم تحديد otherRepositoryId، حساب قواعد الدمج فقط في سياق المستودع المحليNameOrId.
getMergeRequest(string, string, number, boolean)	احصل على تفاصيل عملية دمج معينة.
getPermission(string, string, string)	الحصول على حالة إذن الأمان المتقدم.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	استرداد طلب سحب.
getPullRequestById(number, string)	استرداد طلب سحب.
getPullRequestCommits(string, number, string)	احصل على التثبيتات لطلب السحب المحدد.
getPullRequestConflict(string, number, number, string)	استرداد تعارض واحد لطلب سحب بواسطة المعرف
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	استرداد كافة التعارضات لطلب سحب
getPullRequestIteration(string, number, number, string)	احصل على التكرار المحدد لطلب سحب.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	استرداد التغييرات التي تم إجراؤها في طلب سحب بين تكرارين.
getPullRequestIterationCommits(string, number, number, string, number, number)	احصل على التثبيتات للتكرار المحدد لطلب السحب.
getPullRequestIterations(string, number, string, boolean)	احصل على قائمة التكرارات لطلب السحب المحدد.
getPullRequestIterationStatus(string, number, number, number, string)	احصل على حالة تكرار طلب السحب المحددة حسب المعرف. معرف الحالة فريد داخل طلب السحب عبر جميع التكرارات.
getPullRequestIterationStatuses(string, number, number, string)	احصل على جميع الحالات المقترنة بتكرار طلب السحب.
getPullRequestLabel(string, number, string, string, string)	استرداد تسمية واحدة (علامة) تم تعيينها لطلب سحب.
getPullRequestLabels(string, number, string, string)	احصل على جميع التسميات (العلامات) المعينة لطلب سحب.
getPullRequestProperties(string, number, string)	الحصول على خصائص خارجية لطلب السحب.
getPullRequestQuery(GitPullRequestQuery, string, string)	يتم استخدام واجهة برمجة التطبيقات هذه للعثور على طلبات السحب المتعلقة بتثبيت معين. يمكن استخدامه إما للبحث عن طلب السحب الذي أنشأ تثبيت دمج معين أو يمكن استخدامه للعثور على جميع طلبات السحب التي دمجت تثبيتا معينا. الإدخال هو قائمة بالاستعلامات التي تحتوي كل منها على قائمة التثبيتات. لكل التزام تبحث عنه ، ستحصل على قاموس لطلبات السحب - التزم .
getPullRequestReviewer(string, number, string, string)	استرداد معلومات حول مراجع معين على طلب سحب
getPullRequestReviewers(string, number, string)	استرداد المراجعين لطلب سحب
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	استرداد كافة طلبات السحب المطابقة لمعايير محددة.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	استرداد كافة طلبات السحب المطابقة لمعايير محددة.
getPullRequestStatus(string, number, number, string)	احصل على حالة طلب السحب المحددة حسب المعرف. معرف الحالة فريد داخل طلب السحب عبر جميع التكرارات.
getPullRequestStatuses(string, number, string)	احصل على جميع الحالات المقترنة بطلب سحب.
getPullRequestThread(string, number, number, string, number, number)	استرداد مؤشر ترابط في طلب سحب.
getPullRequestWorkItemRefs(string, number, string)	استرداد قائمة بعناصر العمل المقترنة بطلب سحب.
getPush(string, number, string, number, boolean)	استرداد دفعة معينة.
getPushCommits(string, number, string, number, number, boolean)	استرداد قائمة بالتثبيتات المقترنة بدفعة معينة.
getPushes(string, string, number, number, GitPushSearchCriteria)	استرداد الدفعات المقترنة بالمستودع المحدد.
getRecycleBinRepositories(string)	استرداد مستودعات git المحذوفة مبدئيا من سلة المحذوفات.
getRefFavorite(string, number)	الحصول على المفضلة refs لمعرف مفضل.
getRefFavorites(string, string, string)	يحصل على المفضلة refs لمرجع وهوية.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string, boolean)	الاستعلام عن المستودع المقدم ل refs الخاصة به وإرجاعها.
getRepositories(string, boolean, boolean, boolean)	استرداد مستودعات git.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	استرداد مستودعات git باستخدام عامل التصفية حسب الاسم وفصل الصفحات.
getRepository(string, string)	استرداد مستودع git.
getRepositoryWithParent(string, boolean, string)	استرداد مستودع git.
getRevert(string, number, string)	استرداد معلومات حول عملية العودة عن طريق معرف العودة.
getRevertConflict(string, number, number, string)	استرداد تعارض واحد للرجوع حسب المعرف
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	استرداد كافة التعارضات للرجوع
getRevertForRefName(string, string, string)	استرداد معلومات حول عملية إرجاع لفرع معين.
getStatuses(string, string, string, number, number, boolean)	الحصول على الحالات المقترنة بتثبيت Git.
getSuggestions(string, string, boolean)	استرجع اقتراح طلب سحب لمستودع معين أو project فريق.
getThreads(string, number, string, number, number)	استرداد كافة مؤشرات الترابط في طلب سحب.
getTree(string, string, string, string, boolean, string)	ترجع نقطة نهاية الشجرة مجموعة الكائنات أسفل الشجرة المحددة. الأشجار هي مجلدات في مستودع Git.
getTreeZip(string, string, string, string, boolean, string)	ترجع نقطة نهاية الشجرة مجموعة الكائنات أسفل الشجرة المحددة. الأشجار هي مجلدات في مستودع Git.
queryImportRequests(string, string, boolean)	استرداد طلبات الاستيراد لمستودع.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	استرداد مستودع Git المحذوف مبدئيا. تنتقل المستودعات المحذوفة مؤخرا إلى حالة الحذف المبدئي لفترة من الوقت قبل حذفها بشكل ثابت وتصبح غير قابلة للاسترداد.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	إرسال إعلام بالبريد الإلكتروني حول طلب سحب معين إلى مجموعة من المستلمين
updateCherryPickConflict(GitConflict, string, number, number, string)	تحديث حل تعارض دمج
updateCherryPickConflicts(GitConflict[], string, number, string)	تحديث حلول تعارض دمج متعددة
updateComment(Comment, string, number, number, number, string)	تحديث تعليق مقترن بمترابط معين في طلب سحب.
updateEnablementStatus(AdvSecEnablementUpdate[])	حالة تمكين POST للمستودعات.
updateImportRequest(GitImportRequest, string, string, number)	أعد محاولة طلب استيراد فاشل أو تخلى عنه.
updatePullRequest(GitPullRequest, string, number, string)	تحديث طلب سحب
updatePullRequestConflict(GitConflict, string, number, number, string)	تحديث حل تعارض دمج
updatePullRequestConflicts(GitConflict[], string, number, string)	تحديث حلول تعارض دمج متعددة
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	تحديث مجموعة حالات تكرار طلب السحب. نوع العملية الوحيد المدعوم هو .
updatePullRequestProperties(JsonPatchDocument, string, number, string)	إنشاء خصائص خارجية لطلب السحب أو تحديثها. يمكن أن تكون عملية التصحيح ، أو . للتشغيل ، يمكن أن يكون المسار فارغا. إذا كان المسار فارغا، يجب أن تكون القيمة قائمة أزواج قيم المفاتيح. للتشغيل ، لا يمكن أن يكون المسار فارغا. إذا لم يكن المسار موجودا، فستتم إضافة الخاصية إلى المجموعة. للتشغيل ، لا يمكن أن يكون المسار فارغا. إذا لم يكن المسار موجودا، فلن يتم تنفيذ أي إجراء.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	تحرير إدخال مراجع. هذه الحقول قابلة للتصحيح: isFlagged، hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	إعادة تعيين أصوات مراجعين متعددين على طلب سحب. ملاحظة: تدعم نقطة النهاية هذه تحديث الأصوات فقط، ولكنها لا تدعم تحديث المراجعين المطلوبين (استخدام النهج) أو أسماء العرض.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	تحديث مجموعة حالات طلب السحب. نوع العملية الوحيد المدعوم هو .
updateRef(GitRefUpdate, string, string, string, string)	تأمين فرع أو إلغاء تأمينه.
updateRefs(GitRefUpdate[], string, string, string)	إنشاء refs (الفروع) أو تحديثها أو حذفها.
updateRepository(GitRepository, string, string)	يحدث مستودع Git إما باسم مستودع جديد أو فرع افتراضي جديد.
updateRevertConflict(GitConflict, string, number, number, string)	تحديث حل تعارض دمج
updateRevertConflicts(GitConflict[], string, number, string)	تحديث حلول تعارض دمج متعددة
updateThread(GitPullRequestCommentThread, string, number, number, string)	تحديث مؤشر ترابط في طلب سحب.

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

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

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

createAnnotatedTag(GitAnnotatedTag, string, string)

إنشاء علامة ذات تعليقات توضيحية.

function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>

المعلمات

tagObject: GitAnnotatedTag

كائن يحتوي على تفاصيل العلامة التي سيتم إنشاؤها.

project: string

معرف Project ID أو اسم project

repositoryId: string

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

المرتجعات

Promise<GitAnnotatedTag>

createAttachment(any, string, string, number, string)

إرفاق ملف جديد بطلب سحب.

function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>

المعلمات

content: any

المحتوى المطلوب تحميله

fileName: string

اسم الملف.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

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

function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>

المعلمات

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

معرف Project ID أو اسم project

repositoryId: string

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

المرتجعات

Promise<GitCherryPick>

createComment(Comment, string, number, number, string)

إنشاء تعليق على مؤشر ترابط معين في طلب سحب (يمكن إنشاء ما يصل إلى 500 تعليق لكل مؤشر ترابط).

function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>

المعلمات

comment: Comment

التعليق المراد إنشاؤه. يمكن أن يصل عدد التعليقات إلى 150,000 حرف.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يوجد فيه التعليق المطلوب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

إنشاء حالة تثبيت Git.

function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>

المعلمات

gitCommitStatusToCreate: GitStatus

كائن حالة تثبيت Git لإنشائه.

commitId: string

معرف تثبيت Git.

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

إنشاء مرجع مفضل

function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>

المعلمات

favorite: GitRefFavorite

المفضلة لإنشائها.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

اطلب إحضار refs الخاصة بمستودع آخر في هذا المستودع. يقوم بمزامنة اثنين من الشعبات الموجودة. لإنشاء تفرع، يرجى مراجعة <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" > المستودعات endpoint</a>

function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

المعلمات

syncParams: GitForkSyncRequestParameters

مستودع المصدر وتعيين ref.

repositoryNameOrId: string

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

project: string

معرف Project ID أو اسم project

includeLinks: boolean

صحيح لتضمين الارتباطات

المرتجعات

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

إنشاء طلب استيراد.

function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>

المعلمات

importRequest: GitImportRequest

طلب الاستيراد المراد إنشاؤه.

project: string

معرف Project ID أو اسم project

repositoryId: string

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

المرتجعات

Promise<GitImportRequest>

createLike(string, number, number, number, string)

أضف مثل في تعليق.

function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يحتوي على التعليق.

commentId: number

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

طلب عملية دمج git. حاليا نحن ندعم دمج التزامين فقط.

function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>

المعلمات

mergeParameters: GitMergeParameters

الآباء commitIds ودمج commit messsage.

project: string

معرف Project ID أو اسم project

repositoryNameOrId: string

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

includeLinks: boolean

صحيح لتضمين الارتباطات

المرتجعات

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

إنشاء طلب سحب.

function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>

المعلمات

gitPullRequestToCreate: GitPullRequest

طلب السحب المراد إنشاؤه.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

project: string

معرف Project ID أو اسم project

supportsIterations: boolean

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

المرتجعات

Promise<GitPullRequest>

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

إنشاء حالة طلب سحب على التكرار. سيكون لهذه العملية نفس النتيجة مثل إنشاء حالة عند طلب السحب بمعرف تكرار محدد في نص الطلب.

function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>

المعلمات

status: GitPullRequestStatus

حالة طلب السحب المراد إنشاؤها.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestStatus>

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

أنشئ علامة (إذا لم يكن موجودا بعد) وأضفها كتسمية (علامة) لطلب سحب محدد. الحقل المطلوب الوحيد هو اسم التسمية الجديدة (العلامة).

function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>

المعلمات

label: WebApiCreateTagRequestData

تسمية لتعيينها إلى طلب السحب.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

projectId: string

معرف Project أو اسم project.

المرتجعات

Promise<WebApiTagDefinition>

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

إضافة مراجع إلى طلب سحب أو التصويت.

function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

المعلمات

reviewer: IdentityRefWithVote

تصويت المراجع.br /إذا تم تضمين معرف المراجع هنا، فيجب أن يتطابق مع المعلمة reviewerID.br / يمكن للمراجعين تعيين تصويتهم الخاص بهذه الطريقة. عند إضافة مراجعين آخرين، يجب تعيين التصويت إلى صفر.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

reviewerId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRefWithVote>

createPullRequestReviewers(IdentityRef[], string, number, string)

إضافة مراجعين إلى طلب سحب.

function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

المعلمات

reviewers: IdentityRef[]

المراجعون المراد إضافتهم إلى طلب السحب.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

إنشاء حالة طلب سحب.

function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>

المعلمات

status: GitPullRequestStatus

حالة طلب السحب المراد إنشاؤها.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

دفع التغييرات إلى المستودع.

function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>

المعلمات

push: GitPush

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

أنشئ مستودع git في project فريق.

function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>

المعلمات

gitRepositoryToCreate: GitRepositoryCreateOptions

حدد اسم المستودع، أو project الفريق، أو المستودع الرئيسي. يمكن حذف معلومات project الفريق من gitRepositoryToCreate إذا كان الطلب ضمن نطاق project (أي يشمل معرف project).

project: string

معرف Project ID أو اسم project

sourceRef: string

[اختياري] حدد مرجعات المصدر لاستخدامها أثناء إنشاء مستودع نسخة المستودع

المرتجعات

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

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

function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>

المعلمات

revertToCreate: GitAsyncRefOperationParameters

project: string

معرف Project ID أو اسم project

repositoryId: string

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

المرتجعات

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

إنشاء مؤشر ترابط في طلب سحب.

function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>

المعلمات

commentThread: GitPullRequestCommentThread

مؤشر الترابط المراد إنشاؤه. يجب أن يحتوي مؤشر الترابط على تعليق واحد على الأقل.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

أضف هوية غير ذات تطابق إلى مراجعي طلب السحب.

function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>

المعلمات

reviewer: IdentityRefWithVote

مراجع لإضافته إلى طلب السحب.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

حذف مرفق طلب سحب.

function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

المعلمات

fileName: string

اسم المرفق المراد حذفه.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deleteComment(string, number, number, number, string)

احذف تعليقا مقترنا بمترابط معين في طلب سحب.

function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يوجد فيه التعليق المطلوب.

commentId: number

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE يحذف حالة التمكين وبيانات BillableCommitters من DB. سيؤدي حذف بيانات التمكين إلى تعطيلها بشكل فعال للمستودعات المتأثرة.

function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>

المعلمات

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

المرتجعات

Promise<void>

deleteLike(string, number, number, number, string)

حذف مثل في تعليق.

function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يحتوي على التعليق.

commentId: number

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deletePullRequestIterationStatus(string, number, number, number, string)

حذف حالة تكرار طلب السحب.

function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب.

statusId: number

معرف حالة طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deletePullRequestLabels(string, number, string, string, string)

إزالة تسمية (علامة) من مجموعة تلك المعينة لطلب السحب. لن يتم حذف العلامة نفسها.

function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

labelIdOrName: string

اسم أو معرف التسمية المطلوبة.

project: string

معرف Project ID أو اسم project

projectId: string

معرف Project أو اسم project.

المرتجعات

Promise<void>

deletePullRequestReviewer(string, number, string, string)

إزالة مراجع من طلب سحب.

function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

reviewerId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deletePullRequestStatus(string, number, number, string)

حذف حالة طلب السحب.

function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

statusId: number

معرف حالة طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deleteRefFavorite(string, number)

حذف المفضلة refs المحددة

function deleteRefFavorite(project: string, favoriteId: number): Promise<void>

المعلمات

project: string

معرف Project ID أو اسم project

favoriteId: number

معرف المفضلة للمرجع المراد حذفها.

المرتجعات

Promise<void>

deleteRepository(string, string)

حذف مستودع git

function deleteRepository(repositoryId: string, project?: string): Promise<void>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

قم بإتلاف (حذف ثابت) مستودع Git محذوف مبدئيا.

function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

المرتجعات

Promise<void>

getAccessibleRepositories(GetAccessibleRepositoriesRequest)

طلب POST للحصول على مستودعات قابلة للوصول بناء على الإذن (عملية دفعية).

function getAccessibleRepositories(request: GetAccessibleRepositoriesRequest): Promise<GetAccessibleRepositoriesResponse>

المعلمات

request: GetAccessibleRepositoriesRequest

طلب يحتوي على الإذن ومعرفات المستودع للتحقق

المرتجعات

Promise<GetAccessibleRepositoriesResponse>

getAnnotatedTag(string, string, string)

الحصول على علامة ذات تعليقات توضيحية.

function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

objectId: string

ObjectId (Sha1Id) للعلامة التي يجب الحصول عليها.

المرتجعات

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

احصل على محتوى ملف مرفق طلب سحب.

function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

المعلمات

fileName: string

اسم المرفق.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<ArrayBuffer>

getAttachments(string, number, string)

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

function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

احصل على محتوى ملف مرفق طلب سحب.

function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

المعلمات

fileName: string

اسم المرفق.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

استرداد الملتزمين الفعليين القابلين للفوترة لخدمة الأمان المتقدمة لتاريخ معين.

function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>

المعلمات

project: string

معرف Project ID أو اسم project

billingDate: Date

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

skip: number

تخطي X صفوف من مجموعة النتائج لمحاكاة الترحيل.

take: number

إرجاع صفوف ص من مجموعة النتائج لمحاكاة الترحيل.

المرتجعات

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

استرداد الملتزمين الفعليين المفصلين القابلين للفوترة لخدمة الأمان المتقدمة لتاريخ معين. لا تقوم النتائج التفصيلية عمدا بتصفية المشاريع والمستودعات المحذوفة مبدئيا للمساعدة في تشخيص مشكلات الفوترة.

function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>

المعلمات

project: string

معرف Project ID أو اسم project

includeDetails: string

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

billingDate: Date

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

المرتجعات

Promise<BillableCommitterDetail[]>

getBlob(string, string, string, boolean, string, boolean)

الحصول على كائن ثنائي كبير الحجم واحد.

function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>

المعلمات

repositoryId: string

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

sha1: string

تجزئة SHA1 للملف. يمكنك الحصول على SHA1 لملف باستخدام نقطة نهاية "Git/Items/Get Item".

project: string

معرف Project ID أو اسم project

download: boolean

إذا كان صحيحا، فاطلب تنزيلا بدلا من العرض في مستعرض. ملاحظة: هذه القيمة افتراضية إلى true إذا كان $format zip

fileName: string

قم بتوفير fileName لاستخدامه للتنزيل.

resolveLfs: boolean

إذا كان صحيحا، فحاول حل كائن ثنائي كبير الحجم إلى محتويات LFS الخاصة به، إذا كان ملف مؤشر LFS. متوافق فقط مع عناوين قبول البث الثماني أو أنواع $format

المرتجعات

Promise<GitBlobRef>

getBlobContent(string, string, string, boolean, string, boolean)

الحصول على كائن ثنائي كبير الحجم واحد.

function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

sha1: string

تجزئة SHA1 للملف. يمكنك الحصول على SHA1 لملف باستخدام نقطة نهاية "Git/Items/Get Item".

project: string

معرف Project ID أو اسم project

download: boolean

إذا كان صحيحا، فاطلب تنزيلا بدلا من العرض في مستعرض. ملاحظة: هذه القيمة افتراضية إلى true إذا كان $format zip

fileName: string

قم بتوفير fileName لاستخدامه للتنزيل.

resolveLfs: boolean

المرتجعات

Promise<ArrayBuffer>

getBlobsZip(string[], string, string, string)

الحصول على كائن ثنائي كبير الحجم واحد أو أكثر في تنزيل ملف مضغوط.

function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>

المعلمات

blobIds: string[]

يتم إرجاع معرفات Blob (تجزئات SHA1) في الملف المضغوط.

repositoryId: string

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

project: string

معرف Project ID أو اسم project

filename: string

المرتجعات

Promise<ArrayBuffer>

getBlobZip(string, string, string, boolean, string, boolean)

الحصول على كائن ثنائي كبير الحجم واحد.

function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

sha1: string

تجزئة SHA1 للملف. يمكنك الحصول على SHA1 لملف باستخدام نقطة نهاية "Git/Items/Get Item".

project: string

معرف Project ID أو اسم project

download: boolean

إذا كان صحيحا، فاطلب تنزيلا بدلا من العرض في مستعرض. ملاحظة: هذه القيمة افتراضية إلى true إذا كان $format zip

fileName: string

قم بتوفير fileName لاستخدامه للتنزيل.

resolveLfs: boolean

المرتجعات

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

استرداد إحصائيات حول فرع واحد.

function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>

المعلمات

repositoryId: string

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

name: string

اسم الفرع.

project: string

معرف Project ID أو اسم project

baseVersionDescriptor: GitVersionDescriptor

تعريف التثبيت أو الفرع لاستخدامه كأساس.

المرتجعات

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

استرداد إحصائيات حول جميع الفروع داخل المستودع.

function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

baseVersionDescriptor: GitVersionDescriptor

تعريف التثبيت أو الفرع لاستخدامه كأساس.

المرتجعات

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

استرداد الإحصائيات للتثبيتات المتعددة

function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>

المعلمات

searchCriteria: GitQueryBranchStatsCriteria

التثبيت الأساسي وقائمة الالتزامات الهدف المراد مقارنتها.

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitBranchStats[]>

getChanges(string, string, string, number, number)

استرداد التغييرات لتثبيت معين.

function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>

المعلمات

commitId: string

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

repositoryId: string

المعرف أو الاسم المألوف للمستودع. لاستخدام الاسم المألوف، يجب أيضا تحديد projectId.

project: string

معرف Project ID أو اسم project

top: number

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

skip: number

عدد التغييرات التي يجب تخطيها.

المرتجعات

Promise<GitCommitChanges>

getCherryPick(string, number, string)

استرداد معلومات حول عملية اختيار الكرز بواسطة معرف اختيار الكرز.

function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>

المعلمات

project: string

معرف Project ID أو اسم project

cherryPickId: number

معرف من اختيار الكرز.

repositoryId: string

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

المرتجعات

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

استرداد تعارض واحد لاختيار الكرز بواسطة المعرف

function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

المعلمات

repositoryId: string

cherryPickId: number

conflictId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflict>

getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)

استرداد جميع التعارضات لاختيار الكرز

function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

المعلمات

repositoryId: string

cherryPickId: number

project: string

معرف Project ID أو اسم project

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

المرتجعات

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

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

function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

refName: string

GitAsyncRefOperationParameters التي تم إنشاؤهاRefName المستخدمة لعملية اختيار الكرز.

المرتجعات

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

بالنظر إلى commitId، ترجع قائمة التثبيتات الموجودة في نفس عائلة cherry-pick.

function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>

المعلمات

repositoryNameOrId: string

commitId: string

project: string

معرف Project ID أو اسم project

includeLinks: boolean

المرتجعات

Promise<GitCommitRef[]>

getComment(string, number, number, number, string)

استرداد تعليق مقترن بمترابط معين في طلب سحب.

function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يوجد فيه التعليق المطلوب.

commentId: number

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<Comment>

getComments(string, number, number, string)

استرداد كافة التعليقات المقترنة بمترابط معين في طلب سحب.

function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<Comment[]>

getCommit(string, string, string, number)

استرداد تثبيت معين.

function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>

المعلمات

commitId: string

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

repositoryId: string

المعرف أو الاسم المألوف للمستودع. لاستخدام الاسم المألوف، يجب أيضا تحديد projectId.

project: string

معرف Project ID أو اسم project

changeCount: number

عدد التغييرات التي يجب تضمينها في النتيجة.

المرتجعات

Promise<GitCommit>

getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)

ابحث عن أقرب تثبيت شائع (قاعدة الدمج) بين التثبيتات الأساسية والهدف، والحصول على الفرق بين التثبيتات الأساسية والهدف أو التثبيتات الشائعة والهدف.

function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

diffCommonCommit: boolean

إذا كان صحيحا، فحدد بين التثبيتات الشائعة والهدف. إذا كانت خاطئة، فحدد بين التثبيتات الأساسية والهدف.

top: number

الحد الأقصى لعدد التغييرات التي سيتم إرجاعها. الافتراضيات إلى 100.

skip: number

عدد التغييرات التي يجب تخطيها

baseVersionDescriptor: GitBaseVersionDescriptor

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

targetVersionDescriptor: GitTargetVersionDescriptor

واصف للتثبيت الهدف.

المرتجعات

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

استرجاع git commits لمشروع project

function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>

المعلمات

repositoryId: string

المعرف أو الاسم المألوف للمستودع. لاستخدام الاسم المألوف، يجب أيضا تحديد projectId.

searchCriteria: GitQueryCommitsCriteria

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitCommitRef[]>

getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)

استرجاع git commits لمشروع project يطابق معايير البحث

function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>

المعلمات

searchCriteria: GitQueryCommitsCriteria

خيارات البحث

repositoryId: string

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

project: string

معرف Project ID أو اسم project

skip: number

عدد التثبيتات التي يجب تخطيها. لا يمكن أن تتجاوز القيمة 3000000.

top: number

الحد الأقصى لعدد التثبيتات التي يجب إرجاعها. لا يمكن أن تتجاوز القيمة 50,000.

includeStatuses: boolean

صواب لتضمين معلومات حالة التثبيت الإضافية.

المرتجعات

Promise<GitCommitRef[]>

getDeletedRepositories(string)

استرداد مستودعات git المحذوفة.

function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>

المعلمات

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitDeletedRepository[]>

getEnablementStatus(string[], Date, number, number)

احصل على حالة تمكين مستودعات project.

function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>

المعلمات

projectIds: string[]

Null يحدد افتراضيا جميع المشاريع في المضيف، وقائمة حالة repos الخاصة ب project تعود

billingDate: Date

UTC المتوقع، يمكن توفير الإعدادات الافتراضية Null إلى UtcNow()، لنقطة زمنية

skip: number

تخطي X صفوف من مجموعة النتائج لمحاكاة الترحيل.

take: number

إرجاع صفوف ص من مجموعة النتائج لمحاكاة الترحيل.

المرتجعات

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>

المعلمات

enableOnCreateHost: boolean

المرتجعات

Promise<boolean>

getEnableOnCreateProject(string)

function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>

المعلمات

enableOnCreateProjectId: string

المرتجعات

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

احصل على الالتزامات المقدرة القابلة للفوترة لمستودع لآخر 90 يوما.

function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

المرتجعات

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

احصل على دفعات مقدرة قابلة للفوترة لمؤسسة لآخر 90 يوما.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

المرتجعات

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

احصل على تقديرات الموظفين القابلين للفوترة لمشروع project لآخر 90 يوما.

function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>

المعلمات

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

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

function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>

المعلمات

fileDiffsCriteria: FileDiffsCriteria

قائمة كائنات معلمات الملف

project: string

معرف Project ID أو اسم project

repositoryId: string

اسم المستودع أو معرفه

المرتجعات

Promise<FileDiff[]>

getForks(string, string, string, boolean)

استرداد جميع نسخ المستودع في المجموعة.

function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>

المعلمات

repositoryNameOrId: string

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

collectionId: string

معرف مجموعة فريق project.

project: string

معرف Project ID أو اسم project

includeLinks: boolean

صحيح لتضمين الارتباطات.

المرتجعات

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

احصل على تفاصيل عملية مزامنة نسخة المستودع المحددة.

function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

المعلمات

repositoryNameOrId: string

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

forkSyncOperationId: number

معرف العملية لطلب المزامنة.

project: string

معرف Project ID أو اسم project

includeLinks: boolean

صحيح لتضمين الارتباطات.

المرتجعات

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

استرداد جميع عمليات مزامنة التشعب المطلوبة على هذا المستودع.

function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>

المعلمات

repositoryNameOrId: string

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

project: string

معرف Project ID أو اسم project

includeAbandoned: boolean

صواب في تضمين الطلبات المهجورة.

includeLinks: boolean

صحيح لتضمين الارتباطات.

المرتجعات

Promise<GitForkSyncRequest[]>

getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

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

function getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<GitItem>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveHfs: boolean

تعيين إلى صحيح لحل ملفات مؤشر Git HFS لإرجاع المحتوى الفعلي من Git HFS. الافتراضي صحيح.

sanitize: boolean

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

المرتجعات

Promise<GitItem>

getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveHfs: boolean

تعيين إلى صحيح لحل ملفات مؤشر Git HFS لإرجاع المحتوى الفعلي من Git HFS. الافتراضي صحيح.

sanitize: boolean

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

المرتجعات

Promise<ArrayBuffer>

getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

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

function getHfsItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

includeLinks: boolean

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

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

zipForUnix: boolean

تعيين إلى "صحيح" للاحتفاظ بأذونات الملف لأنظمة unix (وPOSIX) مثل الملفات التنفيذية والارتباطات النظامية

المرتجعات

Promise<GitItem[]>

getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveHfs: boolean

تعيين إلى صحيح لحل ملفات مؤشر Git HFS لإرجاع المحتوى الفعلي من Git HFS. الافتراضي صحيح.

sanitize: boolean

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

المرتجعات

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveHfs: boolean

تعيين إلى صحيح لحل ملفات مؤشر Git HFS لإرجاع المحتوى الفعلي من Git HFS. الافتراضي صحيح.

sanitize: boolean

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

المرتجعات

Promise<ArrayBuffer>

getImportRequest(string, string, number)

استرداد طلب استيراد معين.

function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

importRequestId: number

المعرف الفريد لطلب الاستيراد.

المرتجعات

Promise<GitImportRequest>

getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<GitItem>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveLfs: boolean

قم بتعيين إلى true لحل ملفات مؤشر Git LFS لإرجاع المحتوى الفعلي من Git LFS. الافتراضي هو خطأ.

sanitize: boolean

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

المرتجعات

Promise<GitItem>

getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveLfs: boolean

قم بتعيين إلى true لحل ملفات مؤشر Git LFS لإرجاع المحتوى الفعلي من Git LFS. الافتراضي هو خطأ.

sanitize: boolean

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

المرتجعات

Promise<ArrayBuffer>

getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

includeLinks: boolean

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

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

zipForUnix: boolean

تعيين إلى "صحيح" للاحتفاظ بأذونات الملف لأنظمة unix (وPOSIX) مثل الملفات التنفيذية والارتباطات النظامية

المرتجعات

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

يسترجع دفعة من العناصر في مستودع / project لقائمة مسارات معينة أو مسار طويل

function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>

المعلمات

requestData: GitItemRequestData

سمات بيانات الطلب: ItemDescriptors، IncludeContentMetadata، LatestProcessedChange، IncludeLinks. ItemDescriptors: مجموعة من العناصر لجلبها، بما في ذلك المسار والإصدار ومستوى الإعادة. IncludeContentMetadata: ما إذا كان سيتم تضمين بيانات التعريف لجميع العناصر LatestProcessedChange: ما إذا كان يجب تضمين المرجع الضحل للالتزام الذي قام بتغيير كل عنصر آخر. IncludeLinks: ما إذا كان يجب تضمين الحقل _links على المراجع الضحلة.

repositoryId: string

اسم المستودع أو معرفه

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitItem[][]>

getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<string>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveLfs: boolean

قم بتعيين إلى true لحل ملفات مؤشر Git LFS لإرجاع المحتوى الفعلي من Git LFS. الافتراضي هو خطأ.

sanitize: boolean

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

المرتجعات

Promise<string>

getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

path: string

مسار العنصر.

project: string

معرف Project ID أو اسم project

scopePath: string

نطاق المسار. القيمة الافتراضية خالية.

recursionLevel: VersionControlRecursionType

مستوى الإعادة لهذا الطلب. الإعداد الافتراضي هو "none"، لا يوجد تكرار.

includeContentMetadata: boolean

تعيين إلى صحيح لتضمين بيانات تعريف المحتوى. الافتراضي هو خطأ.

latestProcessedChange: boolean

قم بتعيين إلى true لتضمين أحدث التغييرات. الافتراضي هو خطأ.

download: boolean

قم بتعيين إلى true لتنزيل الاستجابة كملف. الافتراضي هو خطأ.

versionDescriptor: GitVersionDescriptor

واصف الإصدار. الافتراضي هو الفرع الافتراضي للمستودع.

includeContent: boolean

قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.

resolveLfs: boolean

قم بتعيين إلى true لحل ملفات مؤشر Git LFS لإرجاع المحتوى الفعلي من Git LFS. الافتراضي هو خطأ.

sanitize: boolean

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

المرتجعات

Promise<ArrayBuffer>

getLikes(string, number, number, number, string)

احصل على الإعجابات بالتعليق.

function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يحتوي على التعليق.

commentId: number

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRef[]>

getMergeBases(string, string, string, string, string, string)

ابحث عن قواعد دمج تثبيتين، اختياريا عبر التشعبات. إذا لم يتم تحديد otherRepositoryId، حساب قواعد الدمج فقط في سياق المستودع المحليNameOrId.

function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>

المعلمات

repositoryNameOrId: string

معرف أو اسم المستودع المحلي.

commitId: string

التثبيت الأول، عادة ما يكون تلميح الفرع الهدف للدمج المحتمل.

otherCommitId: string

تثبيت آخر، عادة ما يكون تلميح الفرع المصدر للدمج المحتمل.

project: string

معرف Project ID أو اسم project

otherCollectionId: string

معرف المجموعة حيث يعيش otherCommitId.

otherRepositoryId: string

معرف المستودع حيث يعيش otherCommitId.

المرتجعات

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

احصل على تفاصيل عملية دمج معينة.

function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryNameOrId: string

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

mergeOperationId: number

معرف العملية لطلب الدمج.

includeLinks: boolean

صحيح لتضمين الارتباطات

المرتجعات

Promise<GitMerge>

getPermission(string, string, string)

الحصول على حالة إذن الأمان المتقدم.

function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>

المعلمات

projectName: string

repositoryId: string

مستخدم المستودع يحاول الوصول إلى access

permission: string

يجب أن يكون الإذن المطلوب هو "viewAlert" "dismissAlert" "manage" "viewEnablement" أو "repoRead"

المرتجعات

Promise<boolean>

getPullRequest(string, number, string, number, number, number, boolean, boolean)

استرداد طلب سحب.

function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب المراد استرداده.

project: string

معرف Project ID أو اسم project

maxCommentLength: number

غير مستخدم.

skip: number

غير مستخدم.

top: number

غير مستخدم.

includeCommits: boolean

إذا كان صحيحا، إرجاع طلب السحب مع التثبيتات المقترنة.

includeWorkItemRefs: boolean

إذا كان صحيحا، إرجاع طلب السحب مع مراجع عنصر العمل المقترنة.

المرتجعات

Promise<GitPullRequest>

getPullRequestById(number, string)

استرداد طلب سحب.

function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>

المعلمات

pullRequestId: number

معرف طلب السحب المراد استرداده.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

احصل على التثبيتات لطلب السحب المحدد.

function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>

المعلمات

repositoryId: string

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

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

استرداد تعارض واحد لطلب سحب بواسطة المعرف

function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

المعلمات

repositoryId: string

pullRequestId: number

conflictId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflict>

getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)

استرداد كافة التعارضات لطلب سحب

function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>

المعلمات

repositoryId: string

مستودع طلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

skip: number

التعارضات التي يجب تخطيها.

top: number

التعارضات التي يجب إرجاعها بعد التخطي.

includeObsolete: boolean

يتضمن تعارضات قديمة.

excludeResolved: boolean

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

onlyResolved: boolean

إرجاع التعارضات التي تم حلها فقط.

المرتجعات

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

احصل على التكرار المحدد لطلب سحب.

function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>

المعلمات

repositoryId: string

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

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب لإرجاعه.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestIteration>

getPullRequestIterationChanges(string, number, number, string, number, number, number)

استرداد التغييرات التي تم إجراؤها في طلب سحب بين تكرارين.

function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب. br / التكرار الأول هو رأس الفرع المصدر في الوقت الذي يتم فيه إنشاء طلب السحب ويتم إنشاء التكرارات اللاحقة عند وجود دفعات إلى الفرع المصدر. تتراوح القيم المسموح بها بين 1 والحد الأقصى للتكرار في طلب السحب هذا.

project: string

معرف Project ID أو اسم project

top: number

اختياري. عدد التغييرات التي يجب استردادها. القيمة الافتراضية هي 100 والقيمة القصوى هي 2000.

skip: number

اختياري. عدد التغييرات التي يجب تجاهلها. على سبيل المثال، لاسترداد التغييرات 101-150، قم بتعيين أعلى 50 وتخطي إلى 100.

compareTo: number

معرف تكرار طلب السحب للمقارنة مقابله. القيمة الافتراضية هي صفر مما يشير إلى إجراء المقارنة مقابل التثبيت المشترك بين الفرعين المصدر والهدف

المرتجعات

Promise<GitPullRequestIterationChanges>

getPullRequestIterationCommits(string, number, number, string, number, number)

احصل على التثبيتات للتكرار المحدد لطلب السحب.

function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>

المعلمات

repositoryId: string

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

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف التكرار الذي يتم منه الحصول على التثبيتات.

project: string

معرف Project ID أو اسم project

top: number

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

skip: number

عدد التثبيتات التي يجب تخطيها.

المرتجعات

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

احصل على قائمة التكرارات لطلب السحب المحدد.

function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>

المعلمات

repositoryId: string

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

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

includeCommits: boolean

إذا كان صحيحا، فبادر بتضمين التثبيتات المقترنة بكل تكرار في الاستجابة.

المرتجعات

Promise<GitPullRequestIteration[]>

getPullRequestIterationStatus(string, number, number, number, string)

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

function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب.

statusId: number

معرف حالة طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

احصل على جميع الحالات المقترنة بتكرار طلب السحب.

function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestStatus[]>

getPullRequestLabel(string, number, string, string, string)

استرداد تسمية واحدة (علامة) تم تعيينها لطلب سحب.

function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

labelIdOrName: string

اسم أو معرف التسمية المطلوبة.

project: string

معرف Project ID أو اسم project

projectId: string

معرف Project أو اسم project.

المرتجعات

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

احصل على جميع التسميات (العلامات) المعينة لطلب سحب.

function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

projectId: string

معرف Project أو اسم project.

المرتجعات

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

الحصول على خصائص خارجية لطلب السحب.

function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

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

function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>

المعلمات

queries: GitPullRequestQuery

قائمة الاستعلامات التي يجب تنفيذها.

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

استرداد معلومات حول مراجع معين على طلب سحب

function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

reviewerId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

استرداد المراجعين لطلب سحب

function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRefWithVote[]>

getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)

استرداد كافة طلبات السحب المطابقة لمعايير محددة.

function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

searchCriteria: GitPullRequestSearchCriteria

سيتم إرجاع طلبات السحب التي تطابق معايير البحث هذه.

project: string

معرف Project ID أو اسم project

maxCommentLength: number

غير مستخدم.

skip: number

عدد طلبات السحب التي يجب تجاهلها. على سبيل المثال، لاسترداد النتائج 101-150، قم بتعيين أعلى إلى 50 وتخطي إلى 100.

top: number

عدد طلبات السحب لاستردادها.

المرتجعات

Promise<GitPullRequest[]>

getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)

استرداد كافة طلبات السحب المطابقة لمعايير محددة.

function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

المعلمات

project: string

معرف Project ID أو اسم project

searchCriteria: GitPullRequestSearchCriteria

سيتم إرجاع طلبات السحب التي تطابق معايير البحث هذه.

maxCommentLength: number

غير مستخدم.

skip: number

عدد طلبات السحب التي يجب تجاهلها. على سبيل المثال، لاسترداد النتائج 101-150، قم بتعيين أعلى إلى 50 وتخطي إلى 100.

top: number

عدد طلبات السحب لاستردادها.

المرتجعات

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

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

function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

statusId: number

معرف حالة طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

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

function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestStatus[]>

getPullRequestThread(string, number, number, string, number, number)

استرداد مؤشر ترابط في طلب سحب.

function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط.

project: string

معرف Project ID أو اسم project

iteration: number

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

baseIteration: number

إذا تم تحديده، سيتم تعقب موضع مؤشر الترابط باستخدام هذا التكرار كجانب أيسر من diff.

المرتجعات

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

استرداد قائمة بعناصر العمل المقترنة بطلب سحب.

function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>

المعلمات

repositoryId: string

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

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<ResourceRef[]>

getPush(string, number, string, number, boolean)

استرداد دفعة معينة.

function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>

المعلمات

repositoryId: string

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

pushId: number

معرف الدفع.

project: string

معرف Project ID أو اسم project

includeCommits: number

عدد التثبيتات المراد تضمينها في النتيجة.

includeRefUpdates: boolean

إذا كان صحيحا، فقم بتضمين قائمة refs التي تم تحديثها بواسطة الدفع.

المرتجعات

Promise<GitPush>

getPushCommits(string, number, string, number, number, boolean)

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

function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>

المعلمات

repositoryId: string

المعرف أو الاسم المألوف للمستودع. لاستخدام الاسم المألوف، يجب أيضا تحديد projectId.

pushId: number

معرف الدفع.

project: string

معرف Project ID أو اسم project

top: number

الحد الأقصى لعدد التثبيتات التي يجب إرجاعها ("الحصول على أعلى x commits").

skip: number

عدد التثبيتات التي يجب تخطيها.

includeLinks: boolean

قم بتعيين إلى false لتجنب تضمين ارتباطات REST Url للموارد. الإعدادات الافتراضية إلى true.

المرتجعات

Promise<GitCommitRef[]>

getPushes(string, string, number, number, GitPushSearchCriteria)

استرداد الدفعات المقترنة بالمستودع المحدد.

function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

skip: number

عدد الدفعات التي يجب تخطيها.

top: number

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

searchCriteria: GitPushSearchCriteria

سمات معايير البحث: fromDate أو toDate أو pusherId أو refName أو includeRefUpdates أو includeLinks. fromDate: تاريخ البدء للبحث منه. toDate: تاريخ الانتهاء للبحث فيه. pusherId: هوية الشخص الذي أرسل الدفع. refName: اسم الفرع الذي يجب مراعاته. includeRefUpdates: إذا كان صحيحا، فقم بتضمين قائمة المراجع التي تم تحديثها بواسطة الدفع. includeLinks: ما إذا كان يجب تضمين حقل _links على المراجع الضحلة.

المرتجعات

Promise<GitPush[]>

getRecycleBinRepositories(string)

استرداد مستودعات git المحذوفة مبدئيا من سلة المحذوفات.

function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>

المعلمات

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

الحصول على المفضلة refs لمعرف مفضل.

function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>

المعلمات

project: string

معرف Project ID أو اسم project

favoriteId: number

معرف المفضلة المطلوبة.

المرتجعات

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

يحصل على المفضلة refs لمرجع وهوية.

function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

identityId: string

معرف الهوية التي سيتم استرداد المفضلة الخاصة بها. إذا كانت فارغة، يتم استخدام الهوية المطلوبة.

المرتجعات

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>

المعلمات

project: string

معرف Project ID أو اسم project

identityId: string

المرتجعات

Promise<GitRefFavorite[]>

getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string, boolean)

الاستعلام عن المستودع المقدم ل refs الخاصة به وإرجاعها.

function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string, includeTargetBranches?: boolean): Promise<PagedList<GitRef>>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

filter: string

[اختياري] عامل تصفية لتطبيقه على refs (يبدأ ب).

includeLinks: boolean

[اختياري] يحدد ما إذا كان يجب تضمين referenceLinks في النتيجة. الافتراضي هو خطأ.

includeStatuses: boolean

[اختياري] يتضمن ما يصل إلى أول 1000 حالة تثبيت لكل ref. القيمة الافتراضية خاطئة.

includeMyBranches: boolean

[اختياري] يتضمن فقط الفروع التي يمتلكها المستخدم، والفروع المفضلة للمستخدم، والفرع الافتراضي. القيمة الافتراضية خاطئة. لا يمكن دمجها مع معلمة عامل التصفية.

latestStatusesOnly: boolean

[اختياري] صحيح لتضمين حالة التزام الإلماح فقط لكل مرجع. يتطلب هذا الخيار أن يكون صحيحا. القيمة الافتراضية خاطئة.

peelTags: boolean

[اختياري] ستقوم العلامات ذات التعليقات التوضيحية بملء الخاصية PeeledObjectId. الافتراضي هو خطأ.

filterContains: string

[اختياري] عامل تصفية لتطبيقه على refs (contains).

includeTargetBranches: boolean

[اختياري] يشمل الفروع المستهدفة التي تحددها أنماط في pull_request_targets.yml.

المرتجعات

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

استرداد مستودعات git.

function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>

المعلمات

project: string

معرف Project ID أو اسم project

includeLinks: boolean

[اختياري] صحيح لتضمين ارتباطات مرجعية. القيمة الافتراضية خاطئة.

includeAllUrls: boolean

[اختياري] صحيح لتضمين جميع عناوين URL البعيدة. القيمة الافتراضية خاطئة.

includeHidden: boolean

[اختياري] صحيح لتضمين المستودعات المخفية. القيمة الافتراضية خاطئة.

المرتجعات

Promise<GitRepository[]>

getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)

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

function getRepositoriesPaged(projectId: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean, filterContains?: string, top?: number, continuationToken?: string): Promise<PagedList<GitRepository>>

المعلمات

projectId: string

معرف أو اسم project الفريق.

includeLinks: boolean

[اختياري] صحيح لتضمين ارتباطات مرجعية. القيمة الافتراضية خاطئة.

includeAllUrls: boolean

[اختياري] صحيح لتضمين جميع عناوين URL البعيدة. القيمة الافتراضية خاطئة.

includeHidden: boolean

[اختياري] صحيح لتضمين المستودعات المخفية. القيمة الافتراضية خاطئة.

filterContains: string

[اختياري] عامل تصفية لتطبيقه على refs (contains).

top: number

[اختياري] الحد الأقصى لعدد المستودعات التي يجب إرجاعها. لا يمكن أن يكون أكبر من 500. إذا لم يتم توفيره ولكن continuationToken هو، تعيين أعلى افتراضيا إلى 100.

continuationToken: string

رمز المتابعة المستخدم لفصل الصفحات.

المرتجعات

Promise<PagedList<GitRepository>>

getRepository(string, string)

استرداد مستودع git.

function getRepository(repositoryId: string, project?: string): Promise<GitRepository>

المعلمات

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

استرداد مستودع git.

function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>

المعلمات

repositoryId: string

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

includeParent: boolean

صواب لتضمين المستودع الأصل. متوفر فقط في المكالمات المصادق عليها.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitRepository>

getRevert(string, number, string)

استرداد معلومات حول عملية العودة عن طريق معرف العودة.

function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>

المعلمات

project: string

معرف Project ID أو اسم project

revertId: number

معرف عملية العودة.

repositoryId: string

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

المرتجعات

Promise<GitRevert>

getRevertConflict(string, number, number, string)

استرداد تعارض واحد للرجوع حسب المعرف

function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

المعلمات

repositoryId: string

revertId: number

conflictId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflict>

getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)

استرداد كافة التعارضات للرجوع

function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

المعلمات

repositoryId: string

revertId: number

project: string

معرف Project ID أو اسم project

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

المرتجعات

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

استرداد معلومات حول عملية إرجاع لفرع معين.

function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

refName: string

GitAsyncRefOperationParameters التي تم إنشاؤهاRefName المستخدمة لعملية العودة.

المرتجعات

Promise<GitRevert>

getStatuses(string, string, string, number, number, boolean)

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

function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>

المعلمات

commitId: string

معرف تثبيت Git.

repositoryId: string

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

project: string

معرف Project ID أو اسم project

top: number

اختياري. عدد الحالات المراد استردادها. الافتراضي هو 1000.

skip: number

اختياري. عدد الحالات التي يجب تجاهلها. الافتراضي هو 0. على سبيل المثال، لاسترداد النتائج 101-150، قم بتعيين أعلى إلى 50 وتخطي إلى 100.

latestOnly: boolean

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

المرتجعات

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

استرجع اقتراح طلب سحب لمستودع معين أو project فريق.

function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>

المعلمات

repositoryId: string

معرف مستودع git.

project: string

معرف Project ID أو اسم project

preferCompareBranch: boolean

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

المرتجعات

Promise<GitSuggestion[]>

getThreads(string, number, string, number, number)

استرداد كافة مؤشرات الترابط في طلب سحب.

function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>

المعلمات

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

iteration: number

إذا تم تحديدها، سيتم تعقب مواضع مؤشر الترابط باستخدام هذا التكرار كجانب أيسر من diff.

baseIteration: number

إذا تم تحديدها، سيتم تعقب مواضع مؤشر الترابط باستخدام هذا التكرار كجانب أيسر من diff.

المرتجعات

Promise<GitPullRequestCommentThread[]>

getTree(string, string, string, string, boolean, string)

ترجع نقطة نهاية الشجرة مجموعة الكائنات أسفل الشجرة المحددة. الأشجار هي مجلدات في مستودع Git.

function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>

المعلمات

repositoryId: string

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

sha1: string

تجزئة SHA1 لكائن الشجرة.

project: string

معرف Project ID أو اسم project

projectId: string

معرف Project.

recursive: boolean

البحث بشكل متكرر. قم بتضمين الأشجار أسفل هذه الشجرة. الافتراضي هو خطأ.

fileName: string

الاسم المراد استخدامه في حالة إرجاع ملف .zip. الافتراضي هو معرف الكائن.

المرتجعات

Promise<GitTreeRef>

getTreeZip(string, string, string, string, boolean, string)

ترجع نقطة نهاية الشجرة مجموعة الكائنات أسفل الشجرة المحددة. الأشجار هي مجلدات في مستودع Git.

function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>

المعلمات

repositoryId: string

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

sha1: string

تجزئة SHA1 لكائن الشجرة.

project: string

معرف Project ID أو اسم project

projectId: string

معرف Project.

recursive: boolean

البحث بشكل متكرر. قم بتضمين الأشجار أسفل هذه الشجرة. الافتراضي هو خطأ.

fileName: string

الاسم المراد استخدامه في حالة إرجاع ملف .zip. الافتراضي هو معرف الكائن.

المرتجعات

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

استرداد طلبات الاستيراد لمستودع.

function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>

المعلمات

project: string

معرف Project ID أو اسم project

repositoryId: string

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

includeAbandoned: boolean

صحيح لتضمين طلبات الاستيراد المهجورة في النتائج.

المرتجعات

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

استرداد مستودع Git المحذوف مبدئيا. تنتقل المستودعات المحذوفة مؤخرا إلى حالة الحذف المبدئي لفترة من الوقت قبل حذفها بشكل ثابت وتصبح غير قابلة للاسترداد.

function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>

المعلمات

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

معرف Project ID أو اسم project

repositoryId: string

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

المرتجعات

Promise<GitRepository>

setEnableOnCreateHost(boolean)

function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>

المعلمات

enableOnCreateHost: boolean

المرتجعات

Promise<void>

setEnableOnCreateProject(string, boolean)

function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>

المعلمات

enableOnCreateProjectId: string

enableOnStatus: boolean

المرتجعات

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

إرسال إعلام بالبريد الإلكتروني حول طلب سحب معين إلى مجموعة من المستلمين

function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

المعلمات

userMessage: ShareNotificationContext

repositoryId: string

معرف مستودع git.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

updateCherryPickConflict(GitConflict, string, number, number, string)

تحديث حل تعارض دمج

function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

المعلمات

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflict>

updateCherryPickConflicts(GitConflict[], string, number, string)

تحديث حلول تعارض دمج متعددة

function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>

المعلمات

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflictUpdateResult[]>

updateComment(Comment, string, number, number, number, string)

تحديث تعليق مقترن بمترابط معين في طلب سحب.

function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

المعلمات

comment: Comment

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

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط الذي يوجد فيه التعليق المطلوب.

commentId: number

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

حالة تمكين POST للمستودعات.

function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>

المعلمات

enablementUpdates: AdvSecEnablementUpdate[]

المرتجعات

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

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

function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

المعلمات

importRequestToUpdate: GitImportRequest

الإصدار المحدث من طلب الاستيراد. حاليا، التغيير الوحيد المسموح به هو تعيين Status إلى Queued أو Abandoned.

project: string

معرف Project ID أو اسم project

repositoryId: string

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

importRequestId: number

المعرف الفريد لطلب الاستيراد المراد تحديثه.

المرتجعات

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

تحديث طلب سحب

function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>

المعلمات

gitPullRequestToUpdate: GitPullRequest

محتوى طلب السحب الذي يجب تحديثه.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب المراد تحديثه.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequest>

updatePullRequestConflict(GitConflict, string, number, number, string)

تحديث حل تعارض دمج

function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

المعلمات

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflict>

updatePullRequestConflicts(GitConflict[], string, number, string)

تحديث حلول تعارض دمج متعددة

function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>

المعلمات

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflictUpdateResult[]>

updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)

تحديث مجموعة حالات تكرار طلب السحب. نوع العملية الوحيد المدعوم هو .

function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>

المعلمات

patchDocument: JsonPatchDocument

العمليات التي يجب تطبيقها على حالات طلب السحب بتنسيق JSON Patch.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

iterationId: number

معرف تكرار طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

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

function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>

المعلمات

patchDocument: JsonPatchDocument

الخصائص المراد إضافتها أو استبدالها أو إزالتها بتنسيق JSON Patch.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<any>

updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)

تحرير إدخال مراجع. هذه الحقول قابلة للتصحيح: isFlagged، hasDeclined

function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

المعلمات

reviewer: IdentityRefWithVote

بيانات المراجع.br /إذا تم تضمين معرف المراجع هنا، فيجب أن يتطابق مع المعلمة reviewerID.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

reviewerId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<IdentityRefWithVote>

updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)

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

function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>

المعلمات

patchVotes: IdentityRefWithVote[]

معرفات المراجعين الذين سيتم إعادة تعيين أصواتهم إلى الصفر

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

تحديث مجموعة حالات طلب السحب. نوع العملية الوحيد المدعوم هو .

function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

المعلمات

patchDocument: JsonPatchDocument

العمليات التي يجب تطبيقها على حالات طلب السحب بتنسيق JSON Patch.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<void>

updateRef(GitRefUpdate, string, string, string, string)

تأمين فرع أو إلغاء تأمينه.

function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>

المعلمات

newRefInfo: GitRefUpdate

إجراء تحديث ref (تأمين/إلغاء تأمين) لتنفيذه

repositoryId: string

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

filter: string

اسم الفرع المراد تأمينه/إلغاء تأمينه

project: string

معرف Project ID أو اسم project

projectId: string

معرف أو اسم project الفريق. اختياري إذا كان تحديد معرف للمستودع.

المرتجعات

Promise<GitRef>

updateRefs(GitRefUpdate[], string, string, string)

إنشاء refs (الفروع) أو تحديثها أو حذفها.

function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>

المعلمات

refUpdates: GitRefUpdate[]

قائمة تحديثات ref التي يجب محاولة تنفيذها

repositoryId: string

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

project: string

معرف Project ID أو اسم project

projectId: string

معرف أو اسم project الفريق. اختياري إذا كان تحديد معرف للمستودع.

المرتجعات

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

يحدث مستودع Git إما باسم مستودع جديد أو فرع افتراضي جديد.

function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>

المعلمات

newRepositoryInfo: GitRepository

تحديد اسم مستودع جديد أو فرع افتراضي جديد للمستودع

repositoryId: string

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

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitRepository>

updateRevertConflict(GitConflict, string, number, number, string)

تحديث حل تعارض دمج

function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

المعلمات

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflict>

updateRevertConflicts(GitConflict[], string, number, string)

تحديث حلول تعارض دمج متعددة

function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>

المعلمات

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitConflictUpdateResult[]>

updateThread(GitPullRequestCommentThread, string, number, number, string)

تحديث مؤشر ترابط في طلب سحب.

function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>

المعلمات

commentThread: GitPullRequestCommentThread

محتوى مؤشر الترابط الذي يجب تحديثه.

repositoryId: string

معرف المستودع للفرع الهدف لطلب السحب.

pullRequestId: number

معرف طلب السحب.

threadId: number

معرف مؤشر الترابط المراد تحديثه.

project: string

معرف Project ID أو اسم project

المرتجعات

Promise<GitPullRequestCommentThread>

الملاحظات

هل كانت هذه الصفحة مفيدة؟

مشاركة عبر

GitRestClient class

المنشئون

الخصائص

الأساليب

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

GitRestClient(IVssRestClientOptions)

المعلمات

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

RESOURCE_AREA_ID

قيمة الخاصية

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

createAnnotatedTag(GitAnnotatedTag, string, string)

المعلمات

المرتجعات

createAttachment(any, string, string, number, string)

المعلمات

المرتجعات

createCherryPick(GitAsyncRefOperationParameters, string, string)

المعلمات

المرتجعات

createComment(Comment, string, number, number, string)

المعلمات

المرتجعات

createCommitStatus(GitStatus, string, string, string)

المعلمات

المرتجعات

createFavorite(GitRefFavorite, string)

المعلمات

المرتجعات

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

المعلمات

المرتجعات

createImportRequest(GitImportRequest, string, string)

المعلمات

المرتجعات

createLike(string, number, number, number, string)

المعلمات

المرتجعات

createMergeRequest(GitMergeParameters, string, string, boolean)

المعلمات

المرتجعات

createPullRequest(GitPullRequest, string, string, boolean)

المعلمات

المرتجعات

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

المعلمات

المرتجعات

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

المعلمات

المرتجعات

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

المعلمات

المرتجعات

createPullRequestReviewers(IdentityRef[], string, number, string)

المعلمات

المرتجعات

createPullRequestStatus(GitPullRequestStatus, string, number, string)

المعلمات

المرتجعات

createPush(GitPush, string, string)

المعلمات

المرتجعات

createRepository(GitRepositoryCreateOptions, string, string)

المعلمات

المرتجعات

createRevert(GitAsyncRefOperationParameters, string, string)

المعلمات

المرتجعات

createThread(GitPullRequestCommentThread, string, number, string)

المعلمات

المرتجعات

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

المعلمات

المرتجعات

deleteAttachment(string, string, number, string)

المعلمات

المرتجعات

deleteComment(string, number, number, number, string)

المعلمات