GraphRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

GraphRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addMembership(string, string)	Vytvořte nové členství mezi kontejnerem a předmětem.
checkMembershipExistence(string, string)	Zkontrolujte, jestli existuje vztah členství mezi kontejnerem a předmětem.
createGroup(GraphGroupCreationContext, string, string[])	Vytvořte novou skupinu Azure DevOps nebo materializujte existující skupinu AAD.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materializace existujícího instančního objektu AAD do účtu ADO
createUser(GraphUserCreationContext, string[])	Materializujte existujícího uživatele AAD nebo MSA do účtu ADO.
deleteAvatar(string)
deleteGroup(string)	Odebere skupinu Azure DevOps ze všech jejích nadřazených skupin.
deleteScope(string)
deleteServicePrincipal(string)	Zakáže instanční objekt.
deleteUser(string)	Zakáže uživatele.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Řešení klíče úložiště na popisovač
getFederatedProviderData(string, string, number)	Získá úplnou sadu ověřovacích dat federovaného zprostředkovatele, která jsou k dispozici pro daný subjekt grafu a název zprostředkovatele.
getGroup(string)	Získejte skupinu podle popisovače.
getMemberByDescriptor(string)	Tento koncový bod vrátí výsledek pro každého člena, který byl v systému někdy platný, i když byl od té doby odstraněn nebo má všechna jeho členství odstraněna. Aktuální platnost člena je uvedena prostřednictvím zakázané vlastnosti, která je vynechána při false.
getMembership(string, string)	Získejte vztah členství mezi kontejnerem a předmětem.
getMembershipState(string)	Zkontrolujte, jestli je předmět aktivní nebo neaktivní.
getProviderInfo(string)
getScope(string)	Získání oboru identifikovaného jeho popisovačem
getServicePrincipal(string)	Získejte instanční objekt jeho popisovačem.
getStorageKey(string)	Vyřešte popisovač na klíč úložiště.
getSubject(string)	Vyřešte popisovač na uživatele, skupinu nebo obor.
getUser(string)	Získejte uživatele jeho popisovačem.
listMemberships(string, GraphTraversalDirection, number)	Získejte všechna členství, ve kterých je tento popisovač členem relace.
lookupMembers(GraphSubjectLookup)	Získá všechny požadované členy v aktuálním rozsahu (obvykle organizace nebo účet).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Projít členství v daných popisovačích předmětu.
lookupSubjects(GraphSubjectLookup)	Řešení popisovačů pro uživatele, skupiny nebo obory (předměty) v dávce
querySubjects(GraphSubjectQuery)	Vyhledejte uživatele Azure DevOps nebo skupiny. Výsledky budou vráceny v dávce bez více než 100 subjektů grafu.
removeMembership(string, string)	Odstraní členství mezi kontejnerem a předmětem.
requestAccess(any)
resolve(IdentityMappings)	Batch mapovat seznam uživatelů na nové uživatele
setAvatar(Avatar, string)
translate(string, string)	Překlad identity – Koncový bod překladu identity by měl používat akce ženevy.
traverseMemberships(string, GraphTraversalDirection, number)	Projít členství daného popisovače předmětu.
updateGroup(string, JsonPatchDocument)	Aktualizujte vlastnosti skupiny Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Namapovat existující instanční objekt na jiný instanční objekt.
updateUser(GraphUserUpdateContext, string)	Namapuje existujícího uživatele na jiného uživatele.

Podrobnosti konstruktoru

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addMembership(string, string)

Vytvořte nové členství mezi kontejnerem a předmětem.

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

Parametry

subjectDescriptor

string

Popisovač pro skupinu nebo uživatele, který může být podřízeným předmětem relace.

containerDescriptor

string

Popisovač skupiny, která může být kontejnerem v relaci.

Návraty

Promise<GraphMembership>

checkMembershipExistence(string, string)

Zkontrolujte, jestli existuje vztah členství mezi kontejnerem a předmětem.

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

Parametry

subjectDescriptor

string

Skupina nebo uživatel, který je podřízeným předmětem relace.

containerDescriptor

string

Skupina, která je kontejnerem v relaci.

Návraty

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Vytvořte novou skupinu Azure DevOps nebo materializujte existující skupinu AAD.

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

Parametry

creationContext

GraphGroupCreationContext

Podmnožina celé skupiny grafů sloužící k jedinečnému vyhledání předmětu grafu v externím poskytovateli.

scopeDescriptor

string

Popisovač odkazující na obor (kolekce, projekt), ve kterém má být skupina vytvořena. Pokud tento parametr vynecháte, vytvoří se v rozsahu ohraničujícího účtu nebo organizace. Platné pouze pro skupiny VSTS.

groupDescriptors

string[]

Čárkami oddělený seznam popisovačů odkazujících na skupiny, ke které se má skupina grafů připojit

Návraty

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parametry

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Návraty

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materializace existujícího instančního objektu AAD do účtu ADO

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

Parametry

creationContext

GraphServicePrincipalCreationContext

Podmnožina celého instančního objektu grafu sloužícího k jedinečnému vyhledání předmětu grafu v externím poskytovateli.

groupDescriptors

string[]

Čárkami oddělený seznam popisovačů skupin, ke které se má instanční objekt grafu připojit

Návraty

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materializujte existujícího uživatele AAD nebo MSA do účtu ADO.

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

Parametry

creationContext

GraphUserCreationContext

Podmnožina celého uživatele grafu použitá k jedinečnému vyhledání předmětu grafu v externím poskytovateli.

groupDescriptors

string[]

Čárkami oddělený seznam popisovačů skupin, ke které se má uživatel grafu připojit

Návraty

Promise<GraphUser>

deleteAvatar(string)

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

Parametry

subjectDescriptor

string

Návraty

Promise<void>

deleteGroup(string)

Odebere skupinu Azure DevOps ze všech jejích nadřazených skupin.

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

Parametry

groupDescriptor

string

Popisovač skupiny, který chcete odstranit.

Návraty

Promise<void>

deleteScope(string)

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

Parametry

scopeDescriptor

string

Návraty

Promise<void>

deleteServicePrincipal(string)

Zakáže instanční objekt.

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

Parametry

servicePrincipalDescriptor

string

Popisovač instančního objektu, který se má odstranit.

Návraty

Promise<void>

deleteUser(string)

Zakáže uživatele.

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

Parametry

userDescriptor

string

Popisovač uživatele, který chcete odstranit.

Návraty

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parametry

subjectDescriptor

string

size

AvatarSize

format

string

Návraty

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Návraty

Promise<GraphCachePolicies>

getDescriptor(string)

Řešení klíče úložiště na popisovač

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

Parametry

storageKey

string

Klíč úložiště předmětu (uživatel, skupina, rozsah atd.) k vyřešení

Návraty

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Získá úplnou sadu ověřovacích dat federovaného zprostředkovatele, která jsou k dispozici pro daný subjekt grafu a název zprostředkovatele.

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

Parametry

subjectDescriptor

string

popisovač předmětu grafu, pro který bychom měli získat data pro

providerName

string

název poskytovatele, pro který má získat data, například "github.com"

versionHint

number

nápovědu k verzi, kterou lze použít pro optimistickou souběžnost mezipaměti a podporovat opakování při selhání přístupového tokenu; upozorňujeme, že jde pouze o nápovědu a nezaručuje konkrétní verzi odpovědi.

Návraty

Promise<GraphFederatedProviderData>

getGroup(string)

Získejte skupinu podle popisovače.

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

Parametry

groupDescriptor

string

Popisovač požadované skupiny grafů.

Návraty

Promise<GraphGroup>

getMemberByDescriptor(string)

Tento koncový bod vrátí výsledek pro každého člena, který byl v systému někdy platný, i když byl od té doby odstraněn nebo má všechna jeho členství odstraněna. Aktuální platnost člena je uvedena prostřednictvím zakázané vlastnosti, která je vynechána při false.

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

Parametry

memberDescriptor

string

Popisovač požadovaného členu.

Návraty

Promise<GraphMember>

getMembership(string, string)

Získejte vztah členství mezi kontejnerem a předmětem.

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

Parametry

subjectDescriptor

string

Popisovač podřízeného předmětu v relaci.

containerDescriptor

string

Popisovač kontejneru v relaci.

Návraty

Promise<GraphMembership>

getMembershipState(string)

Zkontrolujte, jestli je předmět aktivní nebo neaktivní.

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

Parametry

subjectDescriptor

string

Popisovač předmětu (uživatel, skupina, rozsah atd.) ke kontrole stavu

Návraty

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parametry

userDescriptor

string

Návraty

Promise<GraphProviderInfo>

getScope(string)

Získání oboru identifikovaného jeho popisovačem

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

Parametry

scopeDescriptor

string

Popisovač, který jednoznačně identifikuje obor.

Návraty

Promise<GraphScope>

getServicePrincipal(string)

Získejte instanční objekt jeho popisovačem.

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

Parametry

servicePrincipalDescriptor

string

Popisovač požadovaného instančního objektu.

Návraty

Promise<GraphServicePrincipal>

getStorageKey(string)

Vyřešte popisovač na klíč úložiště.

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

Parametry

subjectDescriptor

string

Návraty

Promise<GraphStorageKeyResult>

getSubject(string)

Vyřešte popisovač na uživatele, skupinu nebo obor.

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

Parametry

subjectDescriptor

string

Popisovač požadovaného předmětu.

Návraty

Promise<GraphSubject>

getUser(string)

Získejte uživatele jeho popisovačem.

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

Parametry

userDescriptor

string

Popisovač požadovaného uživatele

Návraty

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Získejte všechna členství, ve kterých je tento popisovač členem relace.

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

Parametry

subjectDescriptor

string

Načtěte všechna přímá členství tohoto popisovače.

direction

GraphTraversalDirection

Výchozí hodnota je Až.

depth

number

Maximální počet hran, které se mají procházet nahoru nebo dolů ve stromu členství. V současné době je jediná podporovaná hodnota 1.

Návraty

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Získá všechny požadované členy v aktuálním rozsahu (obvykle organizace nebo účet).

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

Parametry

memberLookup

GraphSubjectLookup

Návraty

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Projít členství v daných popisovačích předmětu.

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

Parametry

membershipTraversalLookup

GraphSubjectLookup

Načtěte potomky/předky seznamu popisovačů v závislosti na směru.

direction

GraphTraversalDirection

Výchozí hodnota je Neznámá.

depth

number

Výchozí hodnota je 1.

Návraty

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

lookupSubjects(GraphSubjectLookup)

Řešení popisovačů pro uživatele, skupiny nebo obory (předměty) v dávce

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

Parametry

subjectLookup

GraphSubjectLookup

Seznam popisovačů, které určují podmnožinu subjektů, které se mají načíst. Každý popisovač jednoznačně identifikuje předmět ve všech oborech instancí, ale pouze v jednom okamžiku v čase.

Návraty

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

querySubjects(GraphSubjectQuery)

Vyhledejte uživatele Azure DevOps nebo skupiny. Výsledky budou vráceny v dávce bez více než 100 subjektů grafu.

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

Parametry

subjectQuery

GraphSubjectQuery

Dotaz, který použijeme k hledání, obsahuje následující: Dotaz: hledaný termín. Hledání bude odpovídat pouze předponě. SubjectKind: "User" nebo "Group" lze zadat, obě nebo buď ScopeDescriptor: Lze zadat jiný než výchozí obor, tj. popisovač oboru projektu.

Návraty

Promise<GraphSubject[]>

removeMembership(string, string)

Odstraní členství mezi kontejnerem a předmětem.

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

Parametry

subjectDescriptor

string

Popisovač skupině nebo uživateli, který je podřízeným předmětem relace.

containerDescriptor

string

Popisovač skupiny, která je kontejnerem v relaci.

Návraty

Promise<void>

requestAccess(any)

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

Parametry

jsondocument

any

Návraty

Promise<void>

resolve(IdentityMappings)

Batch mapovat seznam uživatelů na nové uživatele

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

Parametry

mappings

IdentityMappings

Seznammapováníchch

Návraty

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parametry

avatar

Avatar

subjectDescriptor

string

Návraty

Promise<void>

translate(string, string)

Překlad identity – Koncový bod překladu identity by měl používat akce ženevy.

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

Parametry

masterId

string

localId

string

Návraty

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Projít členství daného popisovače předmětu.

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

Parametry

subjectDescriptor

string

Načtěte potomky/předky tohoto popisovače v závislosti na směru.

direction

GraphTraversalDirection

Výchozí hodnota je Neznámá.

depth

number

Výchozí hodnota je 1.

Návraty

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Aktualizujte vlastnosti skupiny Azure DevOps.

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

Parametry

groupDescriptor

string

Popisovač skupiny, který chcete upravit.

patchDocument

JsonPatchDocument

Dokument JSON+Patch obsahující pole, která chcete změnit.

Návraty

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parametry

scopeDescriptor

string

patchDocument

JsonPatchDocument

Návraty

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Namapovat existující instanční objekt na jiný instanční objekt.

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

Parametry

updateContext

GraphServicePrincipalUpdateContext

Podmnožina celého instančního objektu grafu sloužícího k jedinečnému vyhledání předmětu grafu v externím poskytovateli.

servicePrincipalDescriptor

string

Popisovač instančního objektu, který se má aktualizovat

Návraty

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Namapuje existujícího uživatele na jiného uživatele.

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

Parametry

updateContext

GraphUserUpdateContext

Podmnožina celého uživatele grafu použitá k jedinečnému vyhledání předmětu grafu v externím poskytovateli.

userDescriptor

string

Popisovač uživatele, který se má aktualizovat

Návraty

Promise<GraphUser>