CoreRestClient class

الحزمة:

azure-devops-extension-api

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

Extends

RestClientBase

المنشئون

CoreRestClient(IVssRestClientOptions)

الخصائص

RESOURCE_AREA_ID

الأساليب

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	إنشاء فريق في مشروع فريق.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	حذف فريق.
getAllTeams(boolean, number, number, boolean)	احصل على قائمة بجميع الفرق.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	احصل على عملية حسب المعرف.
getProcesses()	احصل على قائمة بالعمليات.
getProject(string, boolean, boolean)	احصل على المشروع بالمعرف أو الاسم المحدد، بما في ذلك الإمكانات اختياريا.
getProjectCollection(string)	احصل على مجموعة مشاريع بالمعرف أو الاسم المحددين.
getProjectCollections(number, number)	احصل على مراجع مجموعة المشاريع لهذا التطبيق.
getProjectHistoryEntries(number)	الحصول على محفوظات التغييرات على المشروع.
getProjectProperties(string, string[])	احصل على مجموعة من خصائص مشروع الفريق.
getProjects(any, number, number, number, boolean)	احصل على جميع المشاريع في المؤسسة التي يمكن للمستخدم المصادق عليه الوصول إليها.
getProjectsProperties(string[], string[])	احصل على مجموعة من خصائص مشروع الفريق لمشاريع متعددة.
getProjectTeamsByCategory(string, boolean, number, number)	يحصل على قائمة الفرق القابلة للقراءة للمستخدم في مشروع ومستخدم teams عضو في (مستبعد من قائمة قابلة للقراءة).
getProxies(string)
getTeam(string, string, boolean)	الحصول على فريق معين.
getTeamMembersWithExtendedProperties(string, string, number, number)	احصل على قائمة بالأعضاء لفريق معين.
getTeams(string, boolean, number, number, boolean)	احصل على قائمة بالفرق.
queueCreateProject(TeamProject)	قوائم انتظار مشروع ليتم إنشاؤه. استخدم GetOperation للتحقق بشكل دوري من حالة إنشاء المشروع.
queueDeleteProject(string)	قوائم انتظار مشروع ليتم حذفه. استخدم GetOperation للتحقق بشكل دوري من حذف حالة المشروع.
removeProjectAvatar(string)	يزيل الأفاتار للمشروع.
setProjectAvatar(ProjectAvatar, string)	تعيين الأفاتار للمشروع.
setProjectProperties(string, JsonPatchDocument)	إنشاء خصائص مشروع الفريق وتحديثها وحذفها.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	قم بتحديث اسم مشروع موجود أو اختصاره أو وصفه أو استعادته.
updateTeam(WebApiTeam, string, string)	تحديث اسم الفريق و/أو وصفه.

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

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

المعلمات

options

IVssRestClientOptions

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

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

createConnectedService(WebApiConnectedServiceDetails, string)

function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>

المعلمات

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

المرتجعات

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

المعلمات

mruData

IdentityData

mruName

string

المرتجعات

Promise<void>

createOrUpdateProxy(Proxy)

function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>

المعلمات

proxy

Proxy

المرتجعات

Promise<Proxy>

createTeam(WebApiTeam, string)

إنشاء فريق في مشروع فريق.

function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>

المعلمات

team

WebApiTeam

بيانات الفريق المستخدمة لإنشاء الفريق.

projectId

string

اسم أو معرف (GUID) لمشروع الفريق الذي سيتم إنشاء الفريق فيه.

المرتجعات

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

المعلمات

mruData

IdentityData

mruName

string

المرتجعات

Promise<void>

deleteProxy(string, string)

function deleteProxy(proxyUrl: string, site?: string): Promise<void>

المعلمات

proxyUrl

string

site

string

المرتجعات

Promise<void>

deleteTeam(string, string)

حذف فريق.

function deleteTeam(projectId: string, teamId: string): Promise<void>

المعلمات

projectId

string

اسم أو معرف (GUID) لمشروع الفريق الذي يحتوي على الفريق المراد حذفه.

teamId

string

اسم أو معرف الفريق المراد حذفه.

المرتجعات

Promise<void>

getAllTeams(boolean, number, number, boolean)

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

function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

المعلمات

mine

boolean

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

top

number

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

skip

number

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

expandIdentity

boolean

قيمة تشير إلى ما إذا كان يجب توسيع معلومات الهوية في كائن WebApiTeam الناتج أم لا.

المرتجعات

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>

المعلمات

projectId

string

name

string

المرتجعات

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>

المعلمات

projectId

string

kind

ConnectedServiceKind

المرتجعات

Promise<WebApiConnectedService[]>

getIdentityMru(string)

function getIdentityMru(mruName: string): Promise<IdentityRef[]>

المعلمات

mruName

string

المرتجعات

Promise<IdentityRef[]>

getProcessById(string)

احصل على عملية حسب المعرف.

function getProcessById(processId: string): Promise<Process>

المعلمات

processId

string

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

المرتجعات

Promise<Process>

getProcesses()

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

function getProcesses(): Promise<Process[]>

المرتجعات

Promise<Process[]>

getProject(string, boolean, boolean)

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

function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>

المعلمات

projectId

string

includeCapabilities

boolean

قم بتضمين الإمكانات (مثل التحكم بالمصادر) في نتيجة مشروع الفريق (افتراضي: خطأ).

includeHistory

boolean

ابحث داخل المشاريع التي تمت إعادة تسميتها (التي كان لها مثل هذا الاسم في الماضي).

المرتجعات

Promise<TeamProject>

getProjectCollection(string)

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

function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>

المعلمات

collectionId

string

المرتجعات

Promise<TeamProjectCollection>

getProjectCollections(number, number)

احصل على مراجع مجموعة المشاريع لهذا التطبيق.

function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>

المعلمات

top

number

skip

number

المرتجعات

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

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

function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>

المعلمات

minRevision

number

الحد الأدنى لعدد المراجعة المراد إرجاعه في المحفوظات.

المرتجعات

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

احصل على مجموعة من خصائص مشروع الفريق.

function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>

المعلمات

projectId

string

معرف مشروع الفريق.

keys

string[]

سلسلة محددة بفاصلة من أسماء خصائص مشروع الفريق. يتم دعم أحرف البدل ("؟" و"*"). إذا لم يتم تحديد مفتاح، فسيتم إرجاع جميع الخصائص.

المرتجعات

Promise<ProjectProperty[]>

getProjects(any, number, number, number, boolean)

احصل على جميع المشاريع في المؤسسة التي يمكن للمستخدم المصادق عليه الوصول إليها.

function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>

المعلمات

stateFilter

any

تصفية مشاريع الفريق في حالة مشروع فريق معينة (افتراضي: WellFormed).

top

number

skip

number

continuationToken

number

مؤشر يوضح عدد المشاريع التي تم جلبها بالفعل.

getDefaultTeamImageUrl

boolean

المرتجعات

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

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

function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>

المعلمات

projectIds

string[]

سلسلة محددة بفاصلة من معرفات مشروع الفريق

properties

string[]

المرتجعات

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

يحصل على قائمة الفرق القابلة للقراءة للمستخدم في مشروع ومستخدم teams عضو في (مستبعد من قائمة قابلة للقراءة).

function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>

المعلمات

projectId

string

اسم أو معرف (GUID) لمشروع الفريق الذي يحتوي على الفرق المراد استردادها.

expandIdentity

boolean

قيمة تشير إلى ما إذا كان يجب توسيع معلومات الهوية في كائن WebApiTeam الناتج أم لا.

top

number

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

skip

number

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

المرتجعات

Promise<CategorizedWebApiTeams>

getProxies(string)

function getProxies(proxyUrl?: string): Promise<Proxy[]>

المعلمات

proxyUrl

string

المرتجعات

Promise<Proxy[]>

getTeam(string, string, boolean)

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

function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>

المعلمات

projectId

string

اسم أو معرف (GUID) لمشروع الفريق الذي يحتوي على الفريق.

teamId

string

اسم الفريق أو معرفه (GUID).

expandIdentity

boolean

قيمة تشير إلى ما إذا كان يجب توسيع معلومات الهوية في كائن WebApiTeam الناتج أم لا.

المرتجعات

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

احصل على قائمة بالأعضاء لفريق معين.

function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>

المعلمات

projectId

string

اسم أو معرف (GUID) لمشروع الفريق الذي ينتمي إليه الفريق.

teamId

string

اسم أو معرف (GUID) للفريق .

top

number

skip

number

المرتجعات

Promise<TeamMember[]>

getTeams(string, boolean, number, number, boolean)

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

function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

المعلمات

projectId

string

mine

boolean

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

top

number

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

skip

number

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

expandIdentity

boolean

قيمة تشير إلى ما إذا كان يجب توسيع معلومات الهوية في كائن WebApiTeam الناتج أم لا.

المرتجعات

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

قوائم انتظار مشروع ليتم إنشاؤه. استخدم GetOperation للتحقق بشكل دوري من حالة إنشاء المشروع.

function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>

المعلمات

projectToCreate

TeamProject

المشروع المراد إنشاؤه.

المرتجعات

Promise<OperationReference>

queueDeleteProject(string)

قوائم انتظار مشروع ليتم حذفه. استخدم GetOperation للتحقق بشكل دوري من حذف حالة المشروع.

function queueDeleteProject(projectId: string): Promise<OperationReference>

المعلمات

projectId

string

معرف المشروع للمشروع المراد حذفه.

المرتجعات

Promise<OperationReference>

removeProjectAvatar(string)

يزيل الأفاتار للمشروع.

function removeProjectAvatar(projectId: string): Promise<void>

المعلمات

projectId

string

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

المرتجعات

Promise<void>

setProjectAvatar(ProjectAvatar, string)

تعيين الأفاتار للمشروع.

function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>

المعلمات

avatarBlob

ProjectAvatar

كائن بيانات الكائن الثنائي كبير الحجم الأفاتار المراد تحميله.

projectId

string

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

المرتجعات

Promise<void>

setProjectProperties(string, JsonPatchDocument)

إنشاء خصائص مشروع الفريق وتحديثها وحذفها.

function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>

المعلمات

projectId

string

معرف مشروع الفريق.

patchDocument

JsonPatchDocument

مستند JSON Patch الذي يمثل صفيفا من عمليات الخصائص. راجع RFC 6902 لمزيد من التفاصيل حول JSON Patch. أفعال العملية المقبولة هي إضافة وإزالة، حيث يتم استخدام إضافة لإنشاء وتحديث الخصائص على حد سواء. يتكون المسار من شرطة مائلة للأمام واسم خاصية.

المرتجعات

Promise<void>

updateIdentityMru(IdentityData, string)

function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

المعلمات

mruData

IdentityData

mruName

string

المرتجعات

Promise<void>

updateProject(TeamProject, string)

قم بتحديث اسم مشروع موجود أو اختصاره أو وصفه أو استعادته.

function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>

المعلمات

projectUpdate

TeamProject

تحديثات المشروع. يجب تعيين الحالة إلى wellFormed لاستعادة المشروع.

projectId

string

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

المرتجعات

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

تحديث اسم الفريق و/أو وصفه.

function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>

المعلمات

teamData

WebApiTeam

projectId

string

اسم أو معرف (GUID) لمشروع الفريق الذي يحتوي على الفريق للتحديث.

teamId

string

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

المرتجعات

Promise<WebApiTeam>