GraphRestClient class

Paket:

azure-devops-extension-api

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

Extends

RestClientBase

Oluşturucular

GraphRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

addMembership(string, string)	Kapsayıcı ve konu arasında yeni bir üyelik oluşturun.
checkMembershipExistence(string, string)	Kapsayıcı ile konu arasında bir üyelik ilişkisi olup olmadığını denetleyin.
createGroup(GraphGroupCreationContext, string, string[])	Yeni bir Azure DevOps grubu oluşturun veya mevcut bir AAD grubunu gerçekleştirin.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Mevcut bir AAD hizmet sorumlusunu ADO hesabına ekleyin.
createUser(GraphUserCreationContext, string[])	Mevcut bir AAD veya MSA kullanıcısını ADO hesabına ekleyin.
deleteAvatar(string)
deleteGroup(string)	Bir Azure DevOps grubunu tüm üst gruplarından kaldırır.
deleteScope(string)
deleteServicePrincipal(string)	Hizmet sorumlusunu devre dışı bırakır.
deleteUser(string)	Bir kullanıcıyı devre dışı bırakır.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Depolama anahtarını bir tanımlayıcıya çözümleme
getFederatedProviderData(string, string, number)	Verilen grafik konusu ve sağlayıcı adı için kullanılabilen federasyon sağlayıcı kimlik doğrulama verilerinin tam kümesini alır.
getGroup(string)	Tanımlayıcısına göre bir grup alın.
getMemberByDescriptor(string)	Bu uç nokta, üye o zamandan beri silinmiş veya tüm üyelikleri silinmiş olsa bile, sistemde şimdiye kadar geçerli olan herhangi bir üye için bir sonuç döndürür. Üyenin geçerli geçerliliği, false olduğunda atlanan devre dışı bırakılmış özelliği aracılığıyla belirtilir.
getMembership(string, string)	Kapsayıcı ve konu arasında üyelik ilişkisi alın.
getMembershipState(string)	Bir konunun etkin mi yoksa etkin değil mi olduğunu kontrol edin.
getProviderInfo(string)
getScope(string)	Tanımlayıcısı tarafından tanımlanan bir kapsam alma
getServicePrincipal(string)	Tanımlayıcısına göre bir hizmet sorumlusu alın.
getStorageKey(string)	Bir tanımlayıcıyı bir depolama anahtarına çözümleyin.
getSubject(string)	Bir tanımlayıcıyı bir kullanıcı, grup veya kapsam için çözümleyin.
getUser(string)	Bir kullanıcıyı tanımlayıcısına göre alın.
listMemberships(string, GraphTraversalDirection, number)	Bu tanımlayıcının ilişkide üyesi olduğu tüm üyelikleri alın.
lookupMembers(GraphSubjectLookup)	Geçerli kapsamda (genellikle kuruluş veya hesap) istenen tüm üyeleri alır.
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Verilen konu tanımlayıcılarının üyeliklerini geçin.
lookupSubjects(GraphSubjectLookup)	Kullanıcılara, gruplara veya kapsamlara (Konular) yönelik tanımlayıcıları toplu olarak çözümleyin.
querySubjects(GraphSubjectQuery)	Azure DevOps kullanıcılarını ve/veya gruplarını arayın. Sonuçlar, 100'den fazla grafik konusu içermeyen bir toplu iş olarak döndürülür.
removeMembership(string, string)	Kapsayıcı ile konu arasındaki üyeliği siler.
requestAccess(any)
resolve(IdentityMappings)	Bir kullanıcı listesini yeni kullanıcılarla toplu olarak eşleyin.
setAvatar(Avatar, string)
translate(string, string)	Kimlik Çevirisi - Çeviri uç noktasının cenevre eylemi tarafından kullanılması gerekiyor.
traverseMemberships(string, GraphTraversalDirection, number)	Verilen konu tanımlayıcısının üyeliklerini çaprazlayın.
updateGroup(string, JsonPatchDocument)	Azure DevOps grubunun özelliklerini güncelleştirin.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Mevcut bir hizmet sorumlusunu farklı bir hizmet sorumlusuyla eşleyin.
updateUser(GraphUserUpdateContext, string)	Mevcut bir kullanıcıyı farklı bir kullanıcıyla eşleyin.

Oluşturucu Ayrıntıları

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

addMembership(string, string)

Kapsayıcı ve konu arasında yeni bir üyelik oluşturun.

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

Parametreler

subjectDescriptor

string

İlişkinin alt öznesi olabilecek bir grup veya kullanıcı için tanımlayıcı.

containerDescriptor

string

İlişkideki kapsayıcı olabilecek bir grubun tanımlayıcısı.

Döndürülenler

Promise<GraphMembership>

checkMembershipExistence(string, string)

Kapsayıcı ile konu arasında bir üyelik ilişkisi olup olmadığını denetleyin.

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

Parametreler

subjectDescriptor

string

İlişkinin alt öznesi olan grup veya kullanıcı.

containerDescriptor

string

İlişkideki kapsayıcı olan grup.

Döndürülenler

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Yeni bir Azure DevOps grubu oluşturun veya mevcut bir AAD grubunu gerçekleştirin.

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

Parametreler

creationContext

GraphGroupCreationContext

Grafik konusunu harici bir sağlayıcıda benzersiz bir şekilde bulmak için kullanılan tam grafik grubunun alt kümesi.

scopeDescriptor

string

Grubun oluşturulması gereken kapsama (koleksiyon, proje) başvuran bir tanımlayıcı. Atlanırsa, çevreleyen hesap veya kuruluş kapsamında oluşturulur. Yalnızca VSTS grupları için geçerlidir.

groupDescriptors

string[]

Grafik grubunun katılmasını istediğiniz gruplara başvuran tanımlayıcıların virgülle ayrılmış listesi

Döndürülenler

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parametreler

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Döndürülenler

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Mevcut bir AAD hizmet sorumlusunu ADO hesabına ekleyin.

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

Parametreler

creationContext

GraphServicePrincipalCreationContext

Bir dış sağlayıcıda grafik konusunu benzersiz bir şekilde bulmak için kullanılan tam grafik hizmet sorumlusunun alt kümesi.

groupDescriptors

string[]

Grafik hizmet sorumlusunun katılmasını istediğiniz grupların tanımlayıcılarının virgülle ayrılmış listesi

Döndürülenler

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Mevcut bir AAD veya MSA kullanıcısını ADO hesabına ekleyin.

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

Parametreler

creationContext

GraphUserCreationContext

Tam grafik kullanıcısının alt kümesi, grafik konusunu harici bir sağlayıcıda benzersiz bir şekilde bulmak için kullanılır.

groupDescriptors

string[]

Grafik kullanıcısının katılmasını istediğiniz grupların tanımlayıcılarının virgülle ayrılmış listesi

Döndürülenler

Promise<GraphUser>

deleteAvatar(string)

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

Parametreler

subjectDescriptor

string

Döndürülenler

Promise<void>

deleteGroup(string)

Bir Azure DevOps grubunu tüm üst gruplarından kaldırır.

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

Parametreler

groupDescriptor

string

Silinecek grubun tanımlayıcısı.

Döndürülenler

Promise<void>

deleteScope(string)

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

Parametreler

scopeDescriptor

string

Döndürülenler

Promise<void>

deleteServicePrincipal(string)

Hizmet sorumlusunu devre dışı bırakır.

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

Parametreler

servicePrincipalDescriptor

string

Silinecek hizmet sorumlusunun tanımlayıcısı.

Döndürülenler

Promise<void>

deleteUser(string)

Bir kullanıcıyı devre dışı bırakır.

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

Parametreler

userDescriptor

string

Silinecek kullanıcının tanımlayıcısı.

Döndürülenler

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parametreler

subjectDescriptor

string

size

AvatarSize

format

string

Döndürülenler

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Döndürülenler

Promise<GraphCachePolicies>

getDescriptor(string)

Depolama anahtarını bir tanımlayıcıya çözümleme

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

Parametreler

storageKey

string

Çözümlemek için konunun (kullanıcı, grup, kapsam vb.) depolama anahtarı

Döndürülenler

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Verilen grafik konusu ve sağlayıcı adı için kullanılabilen federasyon sağlayıcı kimlik doğrulama verilerinin tam kümesini alır.

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

Parametreler

subjectDescriptor

string

Veri elde etmemiz gereken grafik konusunun tanımlayıcısı

providerName

string

Veri alınacak sağlayıcının adı, örneğin "github.com"

versionHint

number

İyimser önbellek eşzamanlılığı için ve erişim belirteci hatalarında yeniden denemeleri desteklemek için kullanılabilecek bir sürüm ipucu; Bunun yalnızca bir ipucu olduğunu ve yanıtta belirli bir sürümü garanti etmediğini unutmayın

Döndürülenler

Promise<GraphFederatedProviderData>

getGroup(string)

Tanımlayıcısına göre bir grup alın.

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

Parametreler

groupDescriptor

string

İstenen grafik grubunun tanımlayıcısı.

Döndürülenler

Promise<GraphGroup>

getMemberByDescriptor(string)

Bu uç nokta, üye o zamandan beri silinmiş veya tüm üyelikleri silinmiş olsa bile, sistemde şimdiye kadar geçerli olan herhangi bir üye için bir sonuç döndürür. Üyenin geçerli geçerliliği, false olduğunda atlanan devre dışı bırakılmış özelliği aracılığıyla belirtilir.

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

Parametreler

memberDescriptor

string

İstenen üyenin tanımlayıcısı.

Döndürülenler

Promise<GraphMember>

getMembership(string, string)

Kapsayıcı ve konu arasında üyelik ilişkisi alın.

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

Parametreler

subjectDescriptor

string

İlişkideki alt özne için bir tanımlayıcı.

containerDescriptor

string

İlişkideki kapsayıcı için bir tanımlayıcı.

Döndürülenler

Promise<GraphMembership>

getMembershipState(string)

Bir konunun etkin mi yoksa etkin değil mi olduğunu kontrol edin.

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

Parametreler

subjectDescriptor

string

Durumunu kontrol etmek için konunun tanımlayıcısı (kullanıcı, grup, kapsam vb.)

Döndürülenler

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parametreler

userDescriptor

string

Döndürülenler

Promise<GraphProviderInfo>

getScope(string)

Tanımlayıcısı tarafından tanımlanan bir kapsam alma

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

Parametreler

scopeDescriptor

string

Bir kapsamı benzersiz olarak tanımlayan bir tanımlayıcı.

Döndürülenler

Promise<GraphScope>

getServicePrincipal(string)

Tanımlayıcısına göre bir hizmet sorumlusu alın.

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

Parametreler

servicePrincipalDescriptor

string

İstenen hizmet sorumlusunun tanımlayıcısı.

Döndürülenler

Promise<GraphServicePrincipal>

getStorageKey(string)

Bir tanımlayıcıyı bir depolama anahtarına çözümleyin.

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

Parametreler

subjectDescriptor

string

Döndürülenler

Promise<GraphStorageKeyResult>

getSubject(string)

Bir tanımlayıcıyı bir kullanıcı, grup veya kapsam için çözümleyin.

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

Parametreler

subjectDescriptor

string

İstenen konunun tanımlayıcısı.

Döndürülenler

Promise<GraphSubject>

getUser(string)

Bir kullanıcıyı tanımlayıcısına göre alın.

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

Parametreler

userDescriptor

string

İstenen kullanıcının tanımlayıcısı.

Döndürülenler

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Bu tanımlayıcının ilişkide üyesi olduğu tüm üyelikleri alın.

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

Parametreler

subjectDescriptor

string

Bu tanımlayıcının tüm doğrudan üyeliklerini getirin.

direction

GraphTraversalDirection

Varsayılan olarak Yukarı'dır.

depth

number

Üyelik ağacında yukarı veya aşağı geçilecek en fazla kenar sayısı. Şu anda desteklenen tek değer '1'dir.

Döndürülenler

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Geçerli kapsamda (genellikle kuruluş veya hesap) istenen tüm üyeleri alır.

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

Parametreler

memberLookup

GraphSubjectLookup

Döndürülenler

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Verilen konu tanımlayıcılarının üyeliklerini geçin.

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

Parametreler

membershipTraversalLookup

GraphSubjectLookup

Yöne bağlı olarak tanımlayıcılar listesinin torunlarını/atalarını getirin.

direction

GraphTraversalDirection

Varsayılan değer Bilinmiyor'dur.

depth

number

Varsayılan değer '1'dir.

Döndürülenler

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

lookupSubjects(GraphSubjectLookup)

Kullanıcılara, gruplara veya kapsamlara (Konular) yönelik tanımlayıcıları toplu olarak çözümleyin.

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

Parametreler

subjectLookup

GraphSubjectLookup

Alınacak konuların bir alt kümesini belirten tanımlayıcıların listesi. Her tanımlayıcı, konuyu tüm örnek kapsamlarında benzersiz bir şekilde tanımlar, ancak yalnızca tek bir zaman noktasında.

Döndürülenler

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

querySubjects(GraphSubjectQuery)

Azure DevOps kullanıcılarını ve/veya gruplarını arayın. Sonuçlar, 100'den fazla grafik konusu içermeyen bir toplu iş olarak döndürülür.

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

Parametreler

subjectQuery

GraphSubjectQuery

Arama yapmak için kullanacağımız sorgu aşağıdakileri içerir: Sorgu: arama terimi. Arama yalnızca önek eşleşmesi olacaktır. SubjectKind: "Kullanıcı" veya "Grup" belirtilebilir, her ikisi de veya her ikisi de ScopeDescriptor: Varsayılan olmayan kapsam belirtilebilir, yani proje kapsamı tanımlayıcısı

Döndürülenler

Promise<GraphSubject[]>

removeMembership(string, string)

Kapsayıcı ile konu arasındaki üyeliği siler.

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

Parametreler

subjectDescriptor

string

İlişkinin alt öznesi olan bir grup veya kullanıcı için tanımlayıcı.

containerDescriptor

string

İlişkideki kapsayıcı olan bir grubun tanımlayıcısı.

Döndürülenler

Promise<void>

requestAccess(any)

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

Parametreler

jsondocument

any

Döndürülenler

Promise<void>

resolve(IdentityMappings)

Bir kullanıcı listesini yeni kullanıcılarla toplu olarak eşleyin.

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

Parametreler

mappings

IdentityMappings

Eşlemelerin listesi.

Döndürülenler

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parametreler

avatar

Avatar

subjectDescriptor

string

Döndürülenler

Promise<void>

translate(string, string)

Kimlik Çevirisi - Çeviri uç noktasının cenevre eylemi tarafından kullanılması gerekiyor.

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

Parametreler

masterId

string

localId

string

Döndürülenler

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Verilen konu tanımlayıcısının üyeliklerini çaprazlayın.

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

Parametreler

subjectDescriptor

string

Yöne bağlı olarak bu tanımlayıcının torunlarını/atalarını getirin.

direction

GraphTraversalDirection

Varsayılan değer Bilinmiyor'dur.

depth

number

Varsayılan değer '1'dir.

Döndürülenler

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Azure DevOps grubunun özelliklerini güncelleştirin.

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

Parametreler

groupDescriptor

string

Değiştirilecek grubun tanımlayıcısı.

patchDocument

JsonPatchDocument

Değiştirilecek alanları içeren JSON+Patch belgesi.

Döndürülenler

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parametreler

scopeDescriptor

string

patchDocument

JsonPatchDocument

Döndürülenler

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Mevcut bir hizmet sorumlusunu farklı bir hizmet sorumlusuyla eşleyin.

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

Parametreler

updateContext

GraphServicePrincipalUpdateContext

Bir dış sağlayıcıda grafik konusunu benzersiz bir şekilde bulmak için kullanılan tam grafik hizmet sorumlusunun alt kümesi.

servicePrincipalDescriptor

string

Güncelleştirilecek hizmet sorumlusunun tanımlayıcısı

Döndürülenler

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Mevcut bir kullanıcıyı farklı bir kullanıcıyla eşleyin.

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

Parametreler

updateContext

GraphUserUpdateContext

Tam grafik kullanıcısının alt kümesi, grafik konusunu harici bir sağlayıcıda benzersiz bir şekilde bulmak için kullanılır.

userDescriptor

string

Güncellenecek kullanıcının tanımlayıcısı

Döndürülenler

Promise<GraphUser>