GraphRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

GraphRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

addMembership(string, string)	Hozzon létre egy új tagságot egy tároló és egy tárgy között.
checkMembershipExistence(string, string)	Ellenőrizze, hogy létezik-e tagsági kapcsolat egy tároló és egy tulajdonos között.
createGroup(GraphGroupCreationContext, string, string[])	Hozzon létre egy új Azure DevOps-csoportot, vagy hozzon létre egy meglévő AAD-csoportot.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Meglévő AAD-szolgáltatásnév létrehozása az ADO-fiókba.
createUser(GraphUserCreationContext, string[])	Meglévő AAD- vagy MSA-felhasználó létrehozása az ADO-fiókba.
deleteAvatar(string)
deleteGroup(string)	Eltávolít egy Azure DevOps-csoportot az összes szülőcsoportjából.
deleteScope(string)
deleteServicePrincipal(string)	Letiltja a szolgáltatásnevet.
deleteUser(string)	Letilt egy felhasználót.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Tárkulcs feloldása leíróként
getFederatedProviderData(string, string, number)	Beolvasja az összevont szolgáltató hitelesítési adatainak teljes készletét a megadott gráf tárgyához és szolgáltató nevéhez.
getGroup(string)	Csoport lekérése a leíró alapján.
getMemberByDescriptor(string)	Ez a végpont olyan eredményt ad vissza minden olyan tagnak, aki valaha is érvényes volt a rendszerben, még akkor is, ha a tagot azóta törölték, vagy az összes tagságukat törölték. A tag aktuális érvényessége a letiltott tulajdonságán keresztül jelenik meg, amely hamis érték esetén nem jelenik meg.
getMembership(string, string)	Tagsági kapcsolat lekérése egy tároló és egy tárgy között.
getMembershipState(string)	Ellenőrizze, hogy egy tárgy aktív vagy inaktív-e.
getProviderInfo(string)
getScope(string)	A leíró által azonosított hatókör lekérése
getServicePrincipal(string)	Szerezze be a szolgáltatásnevet a leírója alapján.
getStorageKey(string)	Leíró feloldása egy tárkulcsra.
getSubject(string)	Leíró feloldása egy felhasználó, csoport vagy hatókör számára.
getUser(string)	Felhasználó lekérése a leíró alapján.
listMemberships(string, GraphTraversalDirection, number)	Szerezze be azokat a tagságokat, ahol ez a leíró tagja a kapcsolatnak.
lookupMembers(GraphSubjectLookup)	Lekéri az összes kért tagot az aktuális hatókörben (általában szervezet vagy fiók).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Az adott tárgyleírók traverse tagsága.
lookupSubjects(GraphSubjectLookup)	A kötegben lévő felhasználók, csoportok vagy hatókörök (témák) leíróinak feloldása.
querySubjects(GraphSubjectQuery)	Keresse meg az Azure Devops felhasználóit vagy/és csoportjait. Az eredmények legfeljebb 100 gráftárgyat tartalmazó kötegben lesznek visszaadva.
removeMembership(string, string)	Törli a tároló és a tárgy közötti tagságot.
requestAccess(any)
resolve(IdentityMappings)	A Batch leképozza a felhasználók listáját az új felhasználókra.
setAvatar(Avatar, string)
translate(string, string)	Identitásfordítás – A fordítási végpontot genfi műveletnek kell használnia.
traverseMemberships(string, GraphTraversalDirection, number)	Az adott tárgyleíróhoz tartozó Traverse tagságok.
updateGroup(string, JsonPatchDocument)	Egy Azure DevOps-csoport tulajdonságainak frissítése.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Meglévő szolgáltatásnév leképezése másik szolgáltatásnévre.
updateUser(GraphUserUpdateContext, string)	Meglévő felhasználó leképezése másik felhasználóhoz.

Konstruktor adatai

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

addMembership(string, string)

Hozzon létre egy új tagságot egy tároló és egy tárgy között.

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

Paraméterek

subjectDescriptor

string

Egy csoport vagy felhasználó leírója, amely lehet a kapcsolat gyermek alanya.

containerDescriptor

string

Egy csoport leírója, amely lehet a kapcsolat tárolója.

Válaszok

Promise<GraphMembership>

checkMembershipExistence(string, string)

Ellenőrizze, hogy létezik-e tagsági kapcsolat egy tároló és egy tulajdonos között.

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

Paraméterek

subjectDescriptor

string

Az a csoport vagy felhasználó, amely a kapcsolat gyermek alanya.

containerDescriptor

string

A kapcsolatban lévő tárolónak számító csoport.

Válaszok

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Hozzon létre egy új Azure DevOps-csoportot, vagy hozzon létre egy meglévő AAD-csoportot.

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

Paraméterek

creationContext

GraphGroupCreationContext

A gráf tárgyának külső szolgáltatóban való egyedi megkereséséhez használt teljes gráfcsoport részhalmaza.

scopeDescriptor

string

Egy leíró, amely arra a hatókörre (gyűjteményre, projektre) hivatkozik, amelyben a csoportot létre kell hozni. Ha nincs megadva, a rendszer a beágyazó fiók vagy szervezet hatókörében jön létre. Csak VSTS-csoportokra érvényes.

groupDescriptors

string[]

A gráfcsoporthoz csatlakozni kívánt leírók vesszővel tagolt listája

Válaszok

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Paraméterek

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Válaszok

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Meglévő AAD-szolgáltatásnév létrehozása az ADO-fiókba.

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

Paraméterek

creationContext

GraphServicePrincipalCreationContext

A teljes gráfszolgáltatásnév részhalmaza, amellyel a gráf tárgya egyedileg megtalálható egy külső szolgáltatóban.

groupDescriptors

string[]

Vesszővel tagolt lista azon csoportok leíróiról, amelyekhez a gráfszolgáltatás tagját csatlakoztatni szeretné

Válaszok

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Meglévő AAD- vagy MSA-felhasználó létrehozása az ADO-fiókba.

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

Paraméterek

creationContext

GraphUserCreationContext

A teljes gráffelhasználó részhalmaza, amellyel a gráf tárgya egyedileg megtalálható egy külső szolgáltatóban.

groupDescriptors

string[]

A gráffelhasználónak csatlakozni kívánt csoportok leíróinak vesszővel tagolt listája

Válaszok

Promise<GraphUser>

deleteAvatar(string)

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

Paraméterek

subjectDescriptor

string

Válaszok

Promise<void>

deleteGroup(string)

Eltávolít egy Azure DevOps-csoportot az összes szülőcsoportjából.

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

Paraméterek

groupDescriptor

string

A törölni kívánt csoport leírója.

Válaszok

Promise<void>

deleteScope(string)

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

Paraméterek

scopeDescriptor

string

Válaszok

Promise<void>

deleteServicePrincipal(string)

Letiltja a szolgáltatásnevet.

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

Paraméterek

servicePrincipalDescriptor

string

A törölni kívánt szolgáltatásnév leírója.

Válaszok

Promise<void>

deleteUser(string)

Letilt egy felhasználót.

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

Paraméterek

userDescriptor

string

A törölni kívánt felhasználó leírója.

Válaszok

Promise<void>

getAvatar(string, AvatarSize, string)

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

Paraméterek

subjectDescriptor

string

size

AvatarSize

format

string

Válaszok

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Válaszok

Promise<GraphCachePolicies>

getDescriptor(string)

Tárkulcs feloldása leíróként

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

Paraméterek

storageKey

string

A probléma megoldásához használandó tárgy (felhasználó, csoport, hatókör stb.) tárkulcsa

Válaszok

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Beolvasja az összevont szolgáltató hitelesítési adatainak teljes készletét a megadott gráf tárgyához és szolgáltató nevéhez.

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

Paraméterek

subjectDescriptor

string

a gráf tárgyának leíróját, amelyre vonatkozóan adatokat kell szereznünk

providerName

string

annak a szolgáltatónak a neve, aki adatokat kér le például a "github.com"

versionHint

number

egy verzióra vonatkozó tipp, amely használható az optimista gyorsítótár egyidejűségére és a hozzáférési jogkivonatok hibáival kapcsolatos újrapróbálkozások támogatására; vegye figyelembe, hogy ez csak egy tipp, és nem garantálja a válasz egy adott verzióját

Válaszok

Promise<GraphFederatedProviderData>

getGroup(string)

Csoport lekérése a leíró alapján.

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

Paraméterek

groupDescriptor

string

A kívánt gráfcsoport leírója.

Válaszok

Promise<GraphGroup>

getMemberByDescriptor(string)

Ez a végpont olyan eredményt ad vissza minden olyan tagnak, aki valaha is érvényes volt a rendszerben, még akkor is, ha a tagot azóta törölték, vagy az összes tagságukat törölték. A tag aktuális érvényessége a letiltott tulajdonságán keresztül jelenik meg, amely hamis érték esetén nem jelenik meg.

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

Paraméterek

memberDescriptor

string

A kívánt tag leírója.

Válaszok

Promise<GraphMember>

getMembership(string, string)

Tagsági kapcsolat lekérése egy tároló és egy tárgy között.

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

Paraméterek

subjectDescriptor

string

A gyermek tárgyának leírója a kapcsolatban.

containerDescriptor

string

A kapcsolat tárolójának leírója.

Válaszok

Promise<GraphMembership>

getMembershipState(string)

Ellenőrizze, hogy egy tárgy aktív vagy inaktív-e.

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

Paraméterek

subjectDescriptor

string

A tárgy leírója (felhasználó, csoport, hatókör stb.) az állapot ellenőrzéséhez

Válaszok

Promise<GraphMembershipState>

getProviderInfo(string)

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

Paraméterek

userDescriptor

string

Válaszok

Promise<GraphProviderInfo>

getScope(string)

A leíró által azonosított hatókör lekérése

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

Paraméterek

scopeDescriptor

string

Egy hatókört egyedileg azonosító leíró.

Válaszok

Promise<GraphScope>

getServicePrincipal(string)

Szerezze be a szolgáltatásnevet a leírója alapján.

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

Paraméterek

servicePrincipalDescriptor

string

A kívánt szolgáltatásnév leírója.

Válaszok

Promise<GraphServicePrincipal>

getStorageKey(string)

Leíró feloldása egy tárkulcsra.

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

Paraméterek

subjectDescriptor

string

Válaszok

Promise<GraphStorageKeyResult>

getSubject(string)

Leíró feloldása egy felhasználó, csoport vagy hatókör számára.

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

Paraméterek

subjectDescriptor

string

A kívánt tárgy leírója.

Válaszok

Promise<GraphSubject>

getUser(string)

Felhasználó lekérése a leíró alapján.

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

Paraméterek

userDescriptor

string

A kívánt felhasználó leírója.

Válaszok

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Szerezze be azokat a tagságokat, ahol ez a leíró tagja a kapcsolatnak.

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

Paraméterek

subjectDescriptor

string

A leíró összes közvetlen tagságának lekérése.

direction

GraphTraversalDirection

Alapértelmezés szerint felfelé.

depth

number

A tagsági fán felfelé vagy lefelé haladni kívánt élek maximális száma. Jelenleg az egyetlen támogatott érték az "1".

Válaszok

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Lekéri az összes kért tagot az aktuális hatókörben (általában szervezet vagy fiók).

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

Paraméterek

memberLookup

GraphSubjectLookup

Válaszok

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Az adott tárgyleírók traverse tagsága.

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

Paraméterek

membershipTraversalLookup

GraphSubjectLookup

Az iránytól függően lekérheti a leírók listájának leszármazottait/elődeit.

direction

GraphTraversalDirection

Az alapértelmezett érték Ismeretlen.

depth

number

Az alapértelmezett érték az "1".

Válaszok

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

lookupSubjects(GraphSubjectLookup)

A kötegben lévő felhasználók, csoportok vagy hatókörök (témák) leíróinak feloldása.

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

Paraméterek

subjectLookup

GraphSubjectLookup

A lekérendő tantárgyak egy részhalmazát meghatározó leírók listája. Minden leíró egyedileg azonosítja a tárgyat az összes példány hatókörében, de csak egyetlen időpontban.

Válaszok

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

querySubjects(GraphSubjectQuery)

Keresse meg az Azure Devops felhasználóit vagy/és csoportjait. Az eredmények legfeljebb 100 gráftárgyat tartalmazó kötegben lesznek visszaadva.

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

Paraméterek

subjectQuery

GraphSubjectQuery

A kereséshez használt lekérdezés a következőket tartalmazza: Lekérdezés: a keresési kifejezés. A keresés csak egyező előtag lesz. SubjectKind: "User" vagy "Group" (Felhasználó) vagy "Group" (Felhasználó) is megadható, vagy a ScopeDescriptor is megadható: Nem alapértelmezett hatókör adható meg, azaz projekthatókör-leíró

Válaszok

Promise<GraphSubject[]>

removeMembership(string, string)

Törli a tároló és a tárgy közötti tagságot.

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

Paraméterek

subjectDescriptor

string

Egy olyan csoport vagy felhasználó leírója, amely a kapcsolat gyermek alanya.

containerDescriptor

string

Egy olyan csoport leírója, amely a kapcsolat tárolója.

Válaszok

Promise<void>

requestAccess(any)

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

Paraméterek

jsondocument

any

Válaszok

Promise<void>

resolve(IdentityMappings)

A Batch leképozza a felhasználók listáját az új felhasználókra.

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

Paraméterek

mappings

IdentityMappings

A leképezések listája.

Válaszok

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Paraméterek

avatar

Avatar

subjectDescriptor

string

Válaszok

Promise<void>

translate(string, string)

Identitásfordítás – A fordítási végpontot genfi műveletnek kell használnia.

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

Paraméterek

masterId

string

localId

string

Válaszok

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Az adott tárgyleíróhoz tartozó Traverse tagságok.

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

Paraméterek

subjectDescriptor

string

Az iránytól függően kérje le a leíró leszármazottait/őseit.

direction

GraphTraversalDirection

Az alapértelmezett érték Ismeretlen.

depth

number

Az alapértelmezett érték az "1".

Válaszok

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Egy Azure DevOps-csoport tulajdonságainak frissítése.

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

Paraméterek

groupDescriptor

string

A módosítani kívánt csoport leírója.

patchDocument

JsonPatchDocument

A módosítandó mezőket tartalmazó JSON+Patch dokumentum.

Válaszok

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Paraméterek

scopeDescriptor

string

patchDocument

JsonPatchDocument

Válaszok

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Meglévő szolgáltatásnév leképezése másik szolgáltatásnévre.

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

Paraméterek

updateContext

GraphServicePrincipalUpdateContext

A teljes gráfszolgáltatásnév részhalmaza, amellyel a gráf tárgya egyedileg megtalálható egy külső szolgáltatóban.

servicePrincipalDescriptor

string

A frissíteni kívánt szolgáltatásnév leírója

Válaszok

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Meglévő felhasználó leképezése másik felhasználóhoz.

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

Paraméterek

updateContext

GraphUserUpdateContext

A teljes gráffelhasználó részhalmaza, amellyel a gráf tárgya egyedileg megtalálható egy külső szolgáltatóban.

userDescriptor

string

A frissíteni kívánt felhasználó leírója

Válaszok

Promise<GraphUser>