GraphRestClient class

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

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

يمتد: RestClientBase

المنشئون

الخصائص

الأساليب

addMembership(string, string)	إنشاء عضوية جديدة بين حاوية وموضوع.
checkMembershipExistence(string, string)	تحقق لمعرفة ما إذا كانت هناك علاقة عضوية بين حاوية وموضوع.
createGroup(GraphGroupCreationContext, string, string[])	إنشاء مجموعة Azure DevOps جديدة أو تحقيق مجموعة AAD موجودة.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	تحقيق كيان خدمة AAD موجود في حساب ADO.
createUser(GraphUserCreationContext, string[])	تجسيد مستخدم AAD أو MSA موجود في حساب ADO.
deleteAvatar(string)
deleteGroup(string)	إزالة مجموعة Azure DevOps من جميع مجموعاتها الأصلية.
deleteScope(string)
deleteServicePrincipal(string)	تعطيل كيان الخدمة.
deleteUser(string)	تعطيل مستخدم.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	حل مفتاح تخزين إلى واصف
getFederatedProviderData(string, string, number)	يكتسب المجموعة الكاملة من بيانات مصادقة الموفر الموحد المتوفرة لموضوع الرسم البياني المحدد واسم الموفر.
getGroup(string)	احصل على مجموعة بواسطة واصفها.
getMemberByDescriptor(string)	تقوم نقطة النهاية هذه بإرجاع نتيجة لأي عضو كان صالحا في النظام، حتى إذا تم حذف العضو منذ ذلك الحين أو تم حذف جميع عضوياته. تتم الإشارة إلى الصلاحية الحالية للعضو من خلال الخاصية المعطلة الخاصة به، والتي يتم حذفها عندما تكون خاطئة.
getMembership(string, string)	الحصول على علاقة عضوية بين الحاوية والموضوع.
getMembershipState(string)	تحقق مما إذا كان الموضوع نشطا أو غير نشط.
getProviderInfo(string)
getScope(string)	الحصول على نطاق محدد بواسطة واصفه
getServicePrincipal(string)	احصل على كيان خدمة بواسطة واصفه.
getStorageKey(string)	حل واصف إلى مفتاح تخزين.
getSubject(string)	حل واصف لمستخدم أو مجموعة أو نطاق.
getUser(string)	الحصول على مستخدم بواسطة واصفه.
listMemberships(string, GraphTraversalDirection, number)	احصل على جميع العضويات حيث يكون هذا الواصف عضوا في العلاقة.
lookupMembers(GraphSubjectLookup)	يحصل على جميع الأعضاء المطلوبين في النطاق الحالي (عادة المؤسسة أو الحساب).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	اجتياز عضويات واصفات الموضوع المحدد.
lookupSubjects(GraphSubjectLookup)	حل الواصفات للمستخدمين أو المجموعات أو النطاقات (الموضوعات) على دفعة واحدة.
querySubjects(GraphSubjectQuery)	ابحث عن مستخدمي Azure Devops أو/أو المجموعات. سيتم إرجاع النتائج في دفعة مع ما لا يزيد عن 100 موضوع رسم بياني.
removeMembership(string, string)	حذف عضوية بين حاوية وموضوع.
requestAccess(any)
resolve(IdentityMappings)	خريطة مجمعة لقائمة المستخدمين للمستخدمين الجدد.
setAvatar(Avatar, string)
translate(string, string)	ترجمة الهوية - من المفترض أن تستخدم نقطة نهاية الترجمة بواسطة إجراء جنيف.
traverseMemberships(string, GraphTraversalDirection, number)	اجتياز عضويات واصف الموضوع المحدد.
updateGroup(string, JsonPatchDocument)	تحديث خصائص مجموعة Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	تعيين كيان خدمة موجود إلى كيان خدمة مختلف.
updateUser(GraphUserUpdateContext, string)	تعيين مستخدم موجود لمستخدم مختلف.

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

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

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

addMembership(string, string)

إنشاء عضوية جديدة بين حاوية وموضوع.

function addMembership(subjectDescriptor: string, containerDescriptor: string): Promise<GraphMembership>

المعلمات

subjectDescriptor: string

واصف لمجموعة أو مستخدم يمكن أن يكون موضوعا تابعا في العلاقة.

containerDescriptor: string

واصف لمجموعة يمكن أن تكون الحاوية في العلاقة.

المرتجعات

Promise<GraphMembership>

checkMembershipExistence(string, string)

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

function checkMembershipExistence(subjectDescriptor: string, containerDescriptor: string): Promise<boolean>

المعلمات

subjectDescriptor: string

المجموعة أو المستخدم الذي هو موضوع تابع للعلاقة.

containerDescriptor: string

المجموعة التي هي الحاوية في العلاقة.

المرتجعات

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

إنشاء مجموعة Azure DevOps جديدة أو تحقيق مجموعة AAD موجودة.

function createGroup(creationContext: GraphGroupCreationContext, scopeDescriptor?: string, groupDescriptors?: string[]): Promise<GraphGroup>

المعلمات

creationContext: GraphGroupCreationContext

المجموعة الفرعية لمجموعة الرسم البياني الكامل المستخدمة للعثور على موضوع الرسم البياني بشكل فريد في موفر خارجي.

scopeDescriptor: string

واصف يشير إلى النطاق (المجموعة، المشروع) الذي يجب إنشاء المجموعة فيه. إذا تم حذفها، إنشاؤها في نطاق الحساب المرفق أو المؤسسة. صالح فقط لمجموعات VSTS.

groupDescriptors: string[]

قائمة مفصولة بفاصلة من الواصفات التي تشير إلى المجموعات التي تريد أن تنضم إليها مجموعة الرسم البياني

المرتجعات

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

function createScope(creationContext: GraphScopeCreationContext, scopeDescriptor?: string): Promise<GraphScope>

المعلمات

creationContext: GraphScopeCreationContext

scopeDescriptor: string

المرتجعات

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

تحقيق كيان خدمة AAD موجود في حساب ADO.

function createServicePrincipal(creationContext: GraphServicePrincipalCreationContext, groupDescriptors?: string[]): Promise<GraphServicePrincipal>

المعلمات

creationContext: GraphServicePrincipalCreationContext

المجموعة الفرعية لمدير خدمة الرسم البياني الكامل المستخدم للعثور على موضوع الرسم البياني بشكل فريد في موفر خارجي.

groupDescriptors: string[]

قائمة مفصولة بفواصل من واصفات المجموعات التي تريد أن ينضم إليها كيان خدمة الرسم البياني

المرتجعات

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

تجسيد مستخدم AAD أو MSA موجود في حساب ADO.

function createUser(creationContext: GraphUserCreationContext, groupDescriptors?: string[]): Promise<GraphUser>

المعلمات

creationContext: GraphUserCreationContext

المجموعة الفرعية لمستخدم الرسم البياني الكامل المستخدم للعثور على موضوع الرسم البياني بشكل فريد في موفر خارجي.

groupDescriptors: string[]

قائمة مفصولة بفواصل من واصفات المجموعات التي تريد أن ينضم إليها مستخدم الرسم البياني

المرتجعات

Promise<GraphUser>

deleteAvatar(string)

function deleteAvatar(subjectDescriptor: string): Promise<void>

المعلمات

subjectDescriptor: string

المرتجعات

Promise<void>

deleteGroup(string)

إزالة مجموعة Azure DevOps من جميع مجموعاتها الأصلية.

function deleteGroup(groupDescriptor: string): Promise<void>

المعلمات

groupDescriptor: string

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

المرتجعات

Promise<void>

deleteScope(string)

function deleteScope(scopeDescriptor: string): Promise<void>

المعلمات

scopeDescriptor: string

المرتجعات

Promise<void>

deleteServicePrincipal(string)

تعطيل كيان الخدمة.

function deleteServicePrincipal(servicePrincipalDescriptor: string): Promise<void>

المعلمات

servicePrincipalDescriptor: string

واصف كيان الخدمة المراد حذفه.

المرتجعات

Promise<void>

deleteUser(string)

تعطيل مستخدم.

function deleteUser(userDescriptor: string): Promise<void>

المعلمات

userDescriptor: string

واصف المستخدم المراد حذفه.

المرتجعات

Promise<void>

getAvatar(string, AvatarSize, string)

function getAvatar(subjectDescriptor: string, size?: AvatarSize, format?: string): Promise<Avatar>

المعلمات

subjectDescriptor: string

size: AvatarSize

format: string

المرتجعات

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

المرتجعات

Promise<GraphCachePolicies>

getDescriptor(string)

حل مفتاح تخزين إلى واصف

function getDescriptor(storageKey: string): Promise<GraphDescriptorResult>

المعلمات

storageKey: string

مفتاح تخزين الموضوع (المستخدم والمجموعة والنطاق وما إلى ذلك) لحله

المرتجعات

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

يكتسب المجموعة الكاملة من بيانات مصادقة الموفر الموحد المتوفرة لموضوع الرسم البياني المحدد واسم الموفر.

function getFederatedProviderData(subjectDescriptor: string, providerName: string, versionHint?: number): Promise<GraphFederatedProviderData>

المعلمات

subjectDescriptor: string

واصف موضوع الرسم البياني الذي يجب أن نحصل على بيانات له

providerName: string

اسم الموفر الذي يجب الحصول على بيانات له، على سبيل المثال "github.com"

versionHint: number

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

المرتجعات

Promise<GraphFederatedProviderData>

getGroup(string)

احصل على مجموعة بواسطة واصفها.

function getGroup(groupDescriptor: string): Promise<GraphGroup>

المعلمات

groupDescriptor: string

واصف مجموعة الرسم البياني المطلوبة.

المرتجعات

Promise<GraphGroup>

getMemberByDescriptor(string)

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

function getMemberByDescriptor(memberDescriptor: string): Promise<GraphMember>

المعلمات

memberDescriptor: string

واصف العضو المطلوب.

المرتجعات

Promise<GraphMember>

getMembership(string, string)

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

function getMembership(subjectDescriptor: string, containerDescriptor: string): Promise<GraphMembership>

المعلمات

subjectDescriptor: string

واصف للموضوع التابع في العلاقة.

containerDescriptor: string

واصف للحاوية في العلاقة.

المرتجعات

Promise<GraphMembership>

getMembershipState(string)

تحقق مما إذا كان الموضوع نشطا أو غير نشط.

function getMembershipState(subjectDescriptor: string): Promise<GraphMembershipState>

المعلمات

subjectDescriptor: string

واصف الموضوع (المستخدم والمجموعة والنطاق وما إلى ذلك) للتحقق من حالة

المرتجعات

Promise<GraphMembershipState>

getProviderInfo(string)

function getProviderInfo(userDescriptor: string): Promise<GraphProviderInfo>

المعلمات

userDescriptor: string

المرتجعات

Promise<GraphProviderInfo>

getScope(string)

الحصول على نطاق محدد بواسطة واصفه

function getScope(scopeDescriptor: string): Promise<GraphScope>

المعلمات

scopeDescriptor: string

واصف يعرف النطاق بشكل فريد.

المرتجعات

Promise<GraphScope>

getServicePrincipal(string)

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

function getServicePrincipal(servicePrincipalDescriptor: string): Promise<GraphServicePrincipal>

المعلمات

servicePrincipalDescriptor: string

واصف كيان الخدمة المطلوب.

المرتجعات

Promise<GraphServicePrincipal>

getStorageKey(string)

حل واصف إلى مفتاح تخزين.

function getStorageKey(subjectDescriptor: string): Promise<GraphStorageKeyResult>

المعلمات

subjectDescriptor: string

المرتجعات

Promise<GraphStorageKeyResult>

getSubject(string)

حل واصف لمستخدم أو مجموعة أو نطاق.

function getSubject(subjectDescriptor: string): Promise<GraphSubject>

المعلمات

subjectDescriptor: string

واصف الموضوع المطلوب.

المرتجعات

Promise<GraphSubject>

getUser(string)

الحصول على مستخدم بواسطة واصفه.

function getUser(userDescriptor: string): Promise<GraphUser>

المعلمات

userDescriptor: string

واصف المستخدم المطلوب.

المرتجعات

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

احصل على جميع العضويات حيث يكون هذا الواصف عضوا في العلاقة.

function listMemberships(subjectDescriptor: string, direction?: GraphTraversalDirection, depth?: number): Promise<GraphMembership[]>

المعلمات

subjectDescriptor: string

جلب جميع العضويات المباشرة لهذا الواصف.

direction: GraphTraversalDirection

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

depth: number

الحد الأقصى لعدد الحواف لاجتياز شجرة العضوية لأعلى أو لأسفل. القيمة الوحيدة المدعومة حاليا هي "1".

المرتجعات

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

يحصل على جميع الأعضاء المطلوبين في النطاق الحالي (عادة المؤسسة أو الحساب).

function lookupMembers(memberLookup: GraphSubjectLookup): Promise<{[key: string]: Graph.GraphMember}>

المعلمات

memberLookup: GraphSubjectLookup

المرتجعات

Promise<{[key: string]: GraphMember}>

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

اجتياز عضويات واصفات الموضوع المحدد.

function lookupMembershipTraversals(membershipTraversalLookup: GraphSubjectLookup, direction?: GraphTraversalDirection, depth?: number): Promise<{[key: string]: Graph.GraphMembershipTraversal}>

المعلمات

membershipTraversalLookup: GraphSubjectLookup

إحضار التوابع/أسلاف قائمة الواصفات اعتمادا على الاتجاه.

direction: GraphTraversalDirection

القيمة الافتراضية غير معروفة.

depth: number

القيمة الافتراضية هي "1".

المرتجعات

Promise<{[key: string]: GraphMembershipTraversal}>

lookupSubjects(GraphSubjectLookup)

حل الواصفات للمستخدمين أو المجموعات أو النطاقات (الموضوعات) على دفعة واحدة.

function lookupSubjects(subjectLookup: GraphSubjectLookup): Promise<{[key: string]: Graph.GraphSubject}>

المعلمات

subjectLookup: GraphSubjectLookup

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

المرتجعات

Promise<{[key: string]: GraphSubject}>

querySubjects(GraphSubjectQuery)

ابحث عن مستخدمي Azure Devops أو/أو المجموعات. سيتم إرجاع النتائج في دفعة مع ما لا يزيد عن 100 موضوع رسم بياني.

function querySubjects(subjectQuery: GraphSubjectQuery): Promise<GraphSubject[]>

المعلمات

subjectQuery: GraphSubjectQuery

يتضمن الاستعلام الذي سنستخدمه للبحث ما يلي: الاستعلام: مصطلح البحث. سيكون البحث مطابقا للبادئة فقط. SubjectKind: يمكن تحديد "المستخدم" أو "المجموعة"، أو إما ScopeDescriptor: يمكن تحديد نطاق غير افتراضي، أي واصف نطاق المشروع

المرتجعات

Promise<GraphSubject[]>

removeMembership(string, string)

حذف عضوية بين حاوية وموضوع.

function removeMembership(subjectDescriptor: string, containerDescriptor: string): Promise<void>

المعلمات

subjectDescriptor: string

واصف لمجموعة أو مستخدم هو الموضوع التابع في العلاقة.

containerDescriptor: string

واصف لمجموعة هي الحاوية في العلاقة.

المرتجعات

Promise<void>

requestAccess(any)

function requestAccess(jsondocument: any): Promise<void>

المعلمات

jsondocument: any

المرتجعات

Promise<void>

resolve(IdentityMappings)

خريطة مجمعة لقائمة المستخدمين للمستخدمين الجدد.

function resolve(mappings: IdentityMappings): Promise<ResolveDisconnectedUsersResponse>

المعلمات

mappings: IdentityMappings

قائمة التعيينات.

المرتجعات

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

function setAvatar(avatar: Avatar, subjectDescriptor: string): Promise<void>

المعلمات

avatar: Avatar

subjectDescriptor: string

المرتجعات

Promise<void>

translate(string, string)

ترجمة الهوية - من المفترض أن تستخدم نقطة نهاية الترجمة بواسطة إجراء جنيف.

function translate(masterId?: string, localId?: string): Promise<string>

المعلمات

masterId: string

localId: string

المرتجعات

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

اجتياز عضويات واصف الموضوع المحدد.

function traverseMemberships(subjectDescriptor: string, direction?: GraphTraversalDirection, depth?: number): Promise<GraphMembershipTraversal>

المعلمات

subjectDescriptor: string

جلب التوابع/ أسلاف هذا الواصف اعتمادا على الاتجاه.

direction: GraphTraversalDirection

القيمة الافتراضية غير معروفة.

depth: number

القيمة الافتراضية هي "1".

المرتجعات

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

تحديث خصائص مجموعة Azure DevOps.

function updateGroup(groupDescriptor: string, patchDocument: JsonPatchDocument): Promise<GraphGroup>

المعلمات

groupDescriptor: string

واصف المجموعة المراد تعديله.

patchDocument: JsonPatchDocument

مستند JSON+Patch الذي يحتوي على الحقول المراد تغييرها.

المرتجعات

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

function updateScope(scopeDescriptor: string, patchDocument: JsonPatchDocument): Promise<void>

المعلمات

scopeDescriptor: string

patchDocument: JsonPatchDocument

المرتجعات

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

تعيين كيان خدمة موجود إلى كيان خدمة مختلف.

function updateServicePrincipal(updateContext: GraphServicePrincipalUpdateContext, servicePrincipalDescriptor: string): Promise<GraphServicePrincipal>

المعلمات

updateContext: GraphServicePrincipalUpdateContext

servicePrincipalDescriptor: string

واصف كيان الخدمة المراد تحديثه

المرتجعات

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

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

function updateUser(updateContext: GraphUserUpdateContext, userDescriptor: string): Promise<GraphUser>

المعلمات

updateContext: GraphUserUpdateContext

userDescriptor: string

واصف المستخدم المراد تحديثه

المرتجعات

Promise<GraphUser>

الملاحظات

هل كانت هذه الصفحة مفيدة؟

مشاركة عبر

GraphRestClient class

المنشئون

الخصائص

الأساليب

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

GraphRestClient(IVssRestClientOptions)

المعلمات

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

RESOURCE_AREA_ID

قيمة الخاصية

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

addMembership(string, string)

المعلمات

المرتجعات

checkMembershipExistence(string, string)

المعلمات

المرتجعات

createGroup(GraphGroupCreationContext, string, string[])

المعلمات

المرتجعات

createScope(GraphScopeCreationContext, string)

المعلمات

المرتجعات

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

المعلمات

المرتجعات

createUser(GraphUserCreationContext, string[])

المعلمات

المرتجعات

deleteAvatar(string)

المعلمات

المرتجعات

deleteGroup(string)

المعلمات

المرتجعات

deleteScope(string)

المعلمات

المرتجعات

deleteServicePrincipal(string)

المعلمات

المرتجعات

deleteUser(string)

المعلمات

المرتجعات

getAvatar(string, AvatarSize, string)

المعلمات

المرتجعات

getCachePolicies()

المرتجعات

getDescriptor(string)

المعلمات

المرتجعات

getFederatedProviderData(string, string, number)

المعلمات

المرتجعات

getGroup(string)

المعلمات

المرتجعات

getMemberByDescriptor(string)

المعلمات

المرتجعات

getMembership(string, string)

المعلمات

المرتجعات

getMembershipState(string)

المعلمات

المرتجعات

getProviderInfo(string)

المعلمات

المرتجعات

getScope(string)

المعلمات

المرتجعات

getServicePrincipal(string)

المعلمات

المرتجعات

getStorageKey(string)

المعلمات

المرتجعات