GraphRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends

RestClientBase

Konstruktorer

GraphRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addMembership(string, string)	Skapa ett nytt medlemskap mellan en container och ett ämne.
checkMembershipExistence(string, string)	Kontrollera om det finns en medlemskapsrelation mellan en container och ett ämne.
createGroup(GraphGroupCreationContext, string, string[])	Skapa en ny Azure DevOps-grupp eller materialisera en befintlig AAD-grupp.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialisera ett befintligt AAD-tjänsthuvudnamn till ADO-kontot.
createUser(GraphUserCreationContext, string[])	Materialisera en befintlig AAD- eller MSA-användare till ADO-kontot.
deleteAvatar(string)
deleteGroup(string)	Tar bort en Azure DevOps-grupp från alla dess överordnade grupper.
deleteScope(string)
deleteServicePrincipal(string)	Inaktiverar ett huvudnamn för tjänsten.
deleteUser(string)	Inaktiverar en användare.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Lösa en lagringsnyckel till en beskrivning
getFederatedProviderData(string, string, number)	Hämtar den fullständiga uppsättningen federerade autentiseringsdata för providern som är tillgängliga för det angivna grafämnet och providernamnet.
getGroup(string)	Hämta en grupp med dess beskrivning.
getMemberByDescriptor(string)	Den här slutpunkten returnerar ett resultat för alla medlemmar som någonsin har varit giltiga i systemet, även om medlemmen sedan dess har tagits bort eller om alla deras medlemskap har tagits bort. Medlemmens aktuella giltighet anges via dess inaktiverade egenskap, som utelämnas när den är falsk.
getMembership(string, string)	Hämta en medlemskapsrelation mellan en container och ett ämne.
getMembershipState(string)	Kontrollera om ett ämne är aktivt eller inaktivt.
getProviderInfo(string)
getScope(string)	Hämta ett omfång som identifieras av dess beskrivning
getServicePrincipal(string)	Hämta ett huvudnamn för tjänsten med hjälp av dess beskrivning.
getStorageKey(string)	Lös en deskriptor till en lagringsnyckel.
getSubject(string)	Lös en beskrivning till en användare, grupp eller omfång.
getUser(string)	Hämta en användare via dess beskrivning.
listMemberships(string, GraphTraversalDirection, number)	Hämta alla medlemskap där den här beskrivningen är medlem i relationen.
lookupMembers(GraphSubjectLookup)	Hämtar alla begärda medlemmar i det aktuella omfånget (vanligtvis organisation eller konto).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Bläddra igenom medlemskap för de angivna ämnesbeskrivningarna.
lookupSubjects(GraphSubjectLookup)	Lösa beskrivningar för användare, grupper eller omfång (ämne) i en batch.
querySubjects(GraphSubjectQuery)	Search för Azure Devops-användare eller/och -grupper. Resultaten returneras i en batch med högst 100 diagramämnen.
removeMembership(string, string)	Tar bort ett medlemskap mellan en container och ett ämne.
requestAccess(any)
resolve(IdentityMappings)	Batch-mappa en lista över användare till nya användare.
setAvatar(Avatar, string)
translate(string, string)	Identitetsöversättning – Översättningsslutpunkten ska användas av genèveåtgärden.
traverseMemberships(string, GraphTraversalDirection, number)	Bläddra igenom medlemskap i den angivna ämnesbeskrivningen.
updateGroup(string, JsonPatchDocument)	Uppdatera egenskaperna för en Azure DevOps-grupp.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Mappa ett befintligt huvudnamn för tjänsten till ett annat huvudnamn för tjänsten.
updateUser(GraphUserUpdateContext, string)	Mappa en befintlig användare till en annan användare.

Konstruktorinformation

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addMembership(string, string)

Skapa ett nytt medlemskap mellan en container och ett ämne.

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

Parametrar

subjectDescriptor

string

En beskrivning till en grupp eller användare som kan vara det underordnade ämnet i relationen.

containerDescriptor

string

En beskrivning till en grupp som kan vara containern i relationen.

Returer

Promise<GraphMembership>

checkMembershipExistence(string, string)

Kontrollera om det finns en medlemskapsrelation mellan en container och ett ämne.

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

Parametrar

subjectDescriptor

string

Den grupp eller användare som är ett underordnat ämne i relationen.

containerDescriptor

string

Gruppen som är containern i relationen.

Returer

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Skapa en ny Azure DevOps-grupp eller materialisera en befintlig AAD-grupp.

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

Parametrar

creationContext

GraphGroupCreationContext

Delmängden av den fullständiga grafgruppen som används för att unikt hitta grafämnet i en extern provider.

scopeDescriptor

string

En beskrivning som refererar till omfånget (samling, projekt) där gruppen ska skapas. Om det utelämnas skapas det i omfånget för det omslutande kontot eller organisationen. Endast giltigt för VSTS-grupper.

groupDescriptors

string[]

En kommaavgränsad lista med beskrivningar som refererar till grupper som du vill att grafgruppen ska kopplas till

Returer

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parametrar

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Returer

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materialisera ett befintligt AAD-tjänsthuvudnamn till ADO-kontot.

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

Parametrar

creationContext

GraphServicePrincipalCreationContext

Delmängden av det fullständiga graph-tjänstens huvudnamn som används för att unikt hitta grafämnet i en extern provider.

groupDescriptors

string[]

En kommaavgränsad lista över deskriptorer för grupper som du vill att graph-tjänstens huvudnamn ska ansluta till

Returer

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materialisera en befintlig AAD- eller MSA-användare till ADO-kontot.

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

Parametrar

creationContext

GraphUserCreationContext

Delmängden av den fullständiga grafanvändaren som används för att unikt hitta grafämnet i en extern provider.

groupDescriptors

string[]

En kommaavgränsad lista över deskriptorer för grupper som du vill att grafanvändaren ska ansluta till

Returer

Promise<GraphUser>

deleteAvatar(string)

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

Parametrar

subjectDescriptor

string

Returer

Promise<void>

deleteGroup(string)

Tar bort en Azure DevOps-grupp från alla dess överordnade grupper.

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

Parametrar

groupDescriptor

string

Beskrivningen av gruppen som ska tas bort.

Returer

Promise<void>

deleteScope(string)

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

Parametrar

scopeDescriptor

string

Returer

Promise<void>

deleteServicePrincipal(string)

Inaktiverar ett huvudnamn för tjänsten.

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

Parametrar

servicePrincipalDescriptor

string

Beskrivningen av tjänstens huvudnamn som ska tas bort.

Returer

Promise<void>

deleteUser(string)

Inaktiverar en användare.

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

Parametrar

userDescriptor

string

Beskrivningen av användaren som ska tas bort.

Returer

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parametrar

subjectDescriptor

string

size

AvatarSize

format

string

Returer

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Returer

Promise<GraphCachePolicies>

getDescriptor(string)

Lösa en lagringsnyckel till en beskrivning

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

Parametrar

storageKey

string

Lagringsnyckel för ämnet (användare, grupp, omfång osv.) för att lösa problemet

Returer

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Hämtar den fullständiga uppsättningen federerade autentiseringsdata för providern som är tillgängliga för det angivna grafämnet och providernamnet.

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

Parametrar

subjectDescriptor

string

beskrivningen av grafämnet som vi bör hämta data för

providerName

string

namnet på providern som data ska hämtas för, t.ex. "github.com"

versionHint

number

ett versionstips som kan användas för optimistisk cachekonkurrering och för att stödja återförsök vid fel med åtkomsttoken. Observera att detta endast är ett tips och inte garanterar en viss version av svaret

Returer

Promise<GraphFederatedProviderData>

getGroup(string)

Hämta en grupp med dess beskrivning.

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

Parametrar

groupDescriptor

string

Beskrivningen av den önskade grafgruppen.

Returer

Promise<GraphGroup>

getMemberByDescriptor(string)

Den här slutpunkten returnerar ett resultat för alla medlemmar som någonsin har varit giltiga i systemet, även om medlemmen sedan dess har tagits bort eller om alla deras medlemskap har tagits bort. Medlemmens aktuella giltighet anges via dess inaktiverade egenskap, som utelämnas när den är falsk.

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

Parametrar

memberDescriptor

string

Beskrivningen av önskad medlem.

Returer

Promise<GraphMember>

getMembership(string, string)

Hämta en medlemskapsrelation mellan en container och ett ämne.

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

Parametrar

subjectDescriptor

string

En beskrivning av det underordnade ämnet i relationen.

containerDescriptor

string

En deskriptor till containern i relationen.

Returer

Promise<GraphMembership>

getMembershipState(string)

Kontrollera om ett ämne är aktivt eller inaktivt.

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

Parametrar

subjectDescriptor

string

Beskrivning av ämnet (användare, grupp, omfång osv.) för att kontrollera tillståndet för

Returer

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parametrar

userDescriptor

string

Returer

Promise<GraphProviderInfo>

getScope(string)

Hämta ett omfång som identifieras av dess beskrivning

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

Parametrar

scopeDescriptor

string

En beskrivning som unikt identifierar ett omfång.

Returer

Promise<GraphScope>

getServicePrincipal(string)

Hämta ett huvudnamn för tjänsten med hjälp av dess beskrivning.

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

Parametrar

servicePrincipalDescriptor

string

Beskrivningen av det önskade tjänstens huvudnamn.

Returer

Promise<GraphServicePrincipal>

getStorageKey(string)

Lös en deskriptor till en lagringsnyckel.

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

Parametrar

subjectDescriptor

string

Returer

Promise<GraphStorageKeyResult>

getSubject(string)

Lös en beskrivning till en användare, grupp eller omfång.

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

Parametrar

subjectDescriptor

string

Beskrivningen av det önskade ämnet.

Returer

Promise<GraphSubject>

getUser(string)

Hämta en användare via dess beskrivning.

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

Parametrar

userDescriptor

string

Den önskade användarens beskrivning.

Returer

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Hämta alla medlemskap där den här beskrivningen är medlem i relationen.

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

Parametrar

subjectDescriptor

string

Hämta alla direkta medlemskap i den här beskrivningen.

direction

GraphTraversalDirection

Standardvärdet är Upp.

depth

number

Det maximala antalet kanter som ska korsas uppåt eller nedåt i medlemskapsträdet. Det enda värde som stöds är för närvarande "1".

Returer

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Hämtar alla begärda medlemmar i det aktuella omfånget (vanligtvis organisation eller konto).

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

Parametrar

memberLookup

GraphSubjectLookup

Returer

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Bläddra igenom medlemskap för de angivna ämnesbeskrivningarna.

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

Parametrar

membershipTraversalLookup

GraphSubjectLookup

Hämta underordnade/överordnade i listan över deskriptorer beroende på riktning.

direction

GraphTraversalDirection

Standardvärdet är Okänt.

depth

number

Standardvärdet är "1".

Returer

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

lookupSubjects(GraphSubjectLookup)

Lösa beskrivningar för användare, grupper eller omfång (ämne) i en batch.

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

Parametrar

subjectLookup

GraphSubjectLookup

En lista med deskriptorer som anger en delmängd av ämnen som ska hämtas. Varje beskrivning identifierar ämnet unikt i alla instansomfattningar, men bara vid en enda tidpunkt.

Returer

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

querySubjects(GraphSubjectQuery)

Search för Azure Devops-användare eller/och -grupper. Resultaten returneras i en batch med högst 100 diagramämnen.

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

Parametrar

subjectQuery

GraphSubjectQuery

Den fråga som vi ska använda för att söka innehåller följande: Fråga: söktermen. Sökningen är endast prefixmatchning. SubjectKind: "Användare" eller "Grupp" kan anges, både eller antingen ScopeDescriptor: Omfång som inte är standard kan anges, d.v.s. projektomfattningsbeskrivning

Returer

Promise<GraphSubject[]>

removeMembership(string, string)

Tar bort ett medlemskap mellan en container och ett ämne.

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

Parametrar

subjectDescriptor

string

En beskrivning till en grupp eller användare som är det underordnade ämnet i relationen.

containerDescriptor

string

En beskrivning till en grupp som är containern i relationen.

Returer

Promise<void>

requestAccess(any)

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

Parametrar

jsondocument

any

Returer

Promise<void>

resolve(IdentityMappings)

Batch-mappa en lista över användare till nya användare.

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

Parametrar

mappings

IdentityMappings

En lista över mappningar.

Returer

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parametrar

avatar

Avatar

subjectDescriptor

string

Returer

Promise<void>

translate(string, string)

Identitetsöversättning – Översättningsslutpunkten ska användas av genèveåtgärden.

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

Parametrar

masterId

string

localId

string

Returer

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Bläddra igenom medlemskap i den angivna ämnesbeskrivningen.

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

Parametrar

subjectDescriptor

string

Hämta underordnade/överordnade till den här beskrivningen beroende på riktning.

direction

GraphTraversalDirection

Standardvärdet är Okänt.

depth

number

Standardvärdet är "1".

Returer

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Uppdatera egenskaperna för en Azure DevOps-grupp.

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

Parametrar

groupDescriptor

string

Beskrivningen av den grupp som ska ändras.

patchDocument

JsonPatchDocument

JSON+Patch-dokumentet som innehåller de fält som ska ändras.

Returer

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parametrar

scopeDescriptor

string

patchDocument

JsonPatchDocument

Returer

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Mappa ett befintligt huvudnamn för tjänsten till ett annat huvudnamn för tjänsten.

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

Parametrar

updateContext

GraphServicePrincipalUpdateContext

Delmängden av det fullständiga graftjänstens huvudnamn som används för att unikt hitta grafämnet i en extern provider.

servicePrincipalDescriptor

string

Beskrivningen av tjänstens huvudnamn som ska uppdateras

Returer

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Mappa en befintlig användare till en annan användare.

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

Parametrar

updateContext

GraphUserUpdateContext

Delmängden av den fullständiga grafanvändaren som används för att unikt hitta grafämnet i en extern provider.

userDescriptor

string

Beskrivningen av användaren som ska uppdateras

Returer

Promise<GraphUser>