GraphRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

GraphRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

addMembership(string, string)	Maak een nieuw lidmaatschap tussen een container en een onderwerp.
checkMembershipExistence(string, string)	Controleer of er een lidmaatschapsrelatie tussen een container en een onderwerp bestaat.
createGroup(GraphGroupCreationContext, string, string[])	Maak een nieuwe Azure DevOps-groep of materialiseer een bestaande AAD-groep.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialiseer een bestaande AAD-service-principal in het ADO-account.
createUser(GraphUserCreationContext, string[])	Materialiseer een bestaande AAD- of MSA-gebruiker in het ADO-account.
deleteAvatar(string)
deleteGroup(string)	Hiermee verwijdert u een Azure DevOps-groep uit alle bovenliggende groepen.
deleteScope(string)
deleteServicePrincipal(string)	Hiermee schakelt u een service-principal uit.
deleteUser(string)	Hiermee schakelt u een gebruiker uit.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Een opslagsleutel oplossen naar een descriptor
getFederatedProviderData(string, string, number)	Hiermee verkrijgt u de volledige set verificatiegegevens van federatieve provider die beschikbaar is voor de opgegeven grafiekonderwerp- en providernaam.
getGroup(string)	Een groep ophalen op basis van de descriptor.
getMemberByDescriptor(string)	Dit eindpunt retourneert een resultaat voor elk lid dat ooit geldig is geweest in het systeem, zelfs als het lid sindsdien is verwijderd of alle lidmaatschappen heeft verwijderd. De huidige geldigheid van het lid wordt aangegeven via de uitgeschakelde eigenschap, die wordt weggelaten wanneer onwaar.
getMembership(string, string)	Een lidmaatschapsrelatie ophalen tussen een container en een onderwerp.
getMembershipState(string)	Controleer of een onderwerp actief of inactief is.
getProviderInfo(string)
getScope(string)	Een bereik ophalen dat wordt geïdentificeerd door de descriptor
getServicePrincipal(string)	Haal een service-principal op met behulp van de descriptor.
getStorageKey(string)	Een descriptor oplossen in een opslagsleutel.
getSubject(string)	Een descriptor oplossen naar een gebruiker, groep of bereik.
getUser(string)	Haal een gebruiker op met behulp van de descriptor.
listMemberships(string, GraphTraversalDirection, number)	Haal alle lidmaatschappen op waarvan deze descriptor lid is van de relatie.
lookupMembers(GraphSubjectLookup)	Hiermee worden alle aangevraagde leden in het huidige bereik (meestal organisatie of account) opgevraagd.
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Doorkruis lidmaatschappen van de opgegeven onderwerpdescriptors.
lookupSubjects(GraphSubjectLookup)	Descriptors oplossen voor gebruikers, groepen of bereiken (Onderwerpen) in een batch.
querySubjects(GraphSubjectQuery)	Search voor Azure Devops-gebruikers of/en groepen. Resultaten worden geretourneerd in een batch met niet meer dan 100 grafiekonderwerpsen.
removeMembership(string, string)	Hiermee verwijdert u een lidmaatschap tussen een container en een onderwerp.
requestAccess(any)
resolve(IdentityMappings)	Een lijst met gebruikers batchgewijs toewijzen aan nieuwe gebruikers.
setAvatar(Avatar, string)
translate(string, string)	Identiteitsomzetting: het vertaaleindpunt moet worden gebruikt door geneva-actie.
traverseMemberships(string, GraphTraversalDirection, number)	Doorkruis lidmaatschappen van de opgegeven onderwerpdescriptor.
updateGroup(string, JsonPatchDocument)	Werk de eigenschappen van een Azure DevOps-groep bij.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Wijs een bestaande service-principal toe aan een andere service-principal.
updateUser(GraphUserUpdateContext, string)	Wijs een bestaande gebruiker toe aan een andere gebruiker.

Constructordetails

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addMembership(string, string)

Maak een nieuw lidmaatschap tussen een container en een onderwerp.

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

Parameters

subjectDescriptor

string

Een descriptor voor een groep of gebruiker die het onderliggende onderwerp in de relatie kan zijn.

containerDescriptor

string

Een descriptor voor een groep die de container in de relatie kan zijn.

Retouren

Promise<GraphMembership>

checkMembershipExistence(string, string)

Controleer of er een lidmaatschapsrelatie tussen een container en een onderwerp bestaat.

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

Parameters

subjectDescriptor

string

De groep of gebruiker die een onderliggend onderwerp van de relatie is.

containerDescriptor

string

De groep die de container in de relatie is.

Retouren

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Maak een nieuwe Azure DevOps-groep of materialiseer een bestaande AAD-groep.

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

Parameters

creationContext

GraphGroupCreationContext

De subset van de volledige grafiekgroep die wordt gebruikt om het grafiekonderwerp uniek te vinden in een externe provider.

scopeDescriptor

string

Een descriptor die verwijst naar het bereik (verzameling, project) waarin de groep moet worden gemaakt. Als u dit weglaat, wordt gemaakt in het bereik van het omringende account of de organisatie. Alleen geldig voor VSTS-groepen.

groupDescriptors

string[]

Een door komma's gescheiden lijst met beschrijvingen die verwijzen naar groepen waaraan u de grafiekgroep wilt koppelen

Retouren

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parameters

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Retouren

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materialiseer een bestaande AAD-service-principal in het ADO-account.

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

Parameters

creationContext

GraphServicePrincipalCreationContext

De subset van de service-principal voor de volledige grafiek die wordt gebruikt om het grafiekonderwerp uniek te vinden in een externe provider.

groupDescriptors

string[]

Een door komma's gescheiden lijst met de beschrijvingen van groepen waaraan u de grafiekservice-principal wilt koppelen

Retouren

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materialiseer een bestaande AAD- of MSA-gebruiker in het ADO-account.

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

Parameters

creationContext

GraphUserCreationContext

De subset van de volledige grafiekgebruiker die wordt gebruikt om het grafiekonderwerp uniek te vinden in een externe provider.

groupDescriptors

string[]

Een door komma's gescheiden lijst met de beschrijvingen van groepen waaraan u de graafgebruiker wilt laten deelnemen

Retouren

Promise<GraphUser>

deleteAvatar(string)

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

Parameters

subjectDescriptor

string

Retouren

Promise<void>

deleteGroup(string)

Hiermee verwijdert u een Azure DevOps-groep uit alle bovenliggende groepen.

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

Parameters

groupDescriptor

string

De beschrijving van de groep die moet worden verwijderd.

Retouren

Promise<void>

deleteScope(string)

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

Parameters

scopeDescriptor

string

Retouren

Promise<void>

deleteServicePrincipal(string)

Hiermee schakelt u een service-principal uit.

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

Parameters

servicePrincipalDescriptor

string

De beschrijving van de service-principal die moet worden verwijderd.

Retouren

Promise<void>

deleteUser(string)

Hiermee schakelt u een gebruiker uit.

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

Parameters

userDescriptor

string

De beschrijving van de gebruiker die moet worden verwijderd.

Retouren

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parameters

subjectDescriptor

string

size

AvatarSize

format

string

Retouren

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Retouren

Promise<GraphCachePolicies>

getDescriptor(string)

Een opslagsleutel oplossen naar een descriptor

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

Parameters

storageKey

string

Opslagsleutel van het onderwerp (gebruiker, groep, bereik, enzovoort) om op te lossen

Retouren

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Hiermee verkrijgt u de volledige set verificatiegegevens van federatieve provider die beschikbaar is voor de opgegeven grafiekonderwerp- en providernaam.

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

Parameters

subjectDescriptor

string

de beschrijving van het grafiekonderwerp waarvoor we gegevens moeten verkrijgen

providerName

string

de naam van de provider waarvoor gegevens moeten worden verkregen, bijvoorbeeld "github.com"

versionHint

number

een versiehint die kan worden gebruikt voor optimistische gelijktijdigheid van de cache en ter ondersteuning van nieuwe pogingen bij fouten in toegangstokens; houd er rekening mee dat dit alleen een hint is en geen garantie biedt voor een bepaalde versie van het antwoord

Retouren

Promise<GraphFederatedProviderData>

getGroup(string)

Een groep ophalen op basis van de descriptor.

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

Parameters

groupDescriptor

string

De beschrijving van de gewenste grafiekgroep.

Retouren

Promise<GraphGroup>

getMemberByDescriptor(string)

Dit eindpunt retourneert een resultaat voor elk lid dat ooit geldig is geweest in het systeem, zelfs als het lid sindsdien is verwijderd of alle lidmaatschappen heeft verwijderd. De huidige geldigheid van het lid wordt aangegeven via de uitgeschakelde eigenschap, die wordt weggelaten wanneer onwaar.

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

Parameters

memberDescriptor

string

De descriptor van het gewenste lid.

Retouren

Promise<GraphMember>

getMembership(string, string)

Een lidmaatschapsrelatie ophalen tussen een container en een onderwerp.

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

Parameters

subjectDescriptor

string

Een descriptor voor het onderliggende onderwerp in de relatie.

containerDescriptor

string

Een descriptor voor de container in de relatie.

Retouren

Promise<GraphMembership>

getMembershipState(string)

Controleer of een onderwerp actief of inactief is.

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

Parameters

subjectDescriptor

string

Descriptor van het onderwerp (gebruiker, groep, bereik, enzovoort) om de status van

Retouren

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parameters

userDescriptor

string

Retouren

Promise<GraphProviderInfo>

getScope(string)

Een bereik ophalen dat wordt geïdentificeerd door de descriptor

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

Parameters

scopeDescriptor

string

Een descriptor die een bereik uniek identificeert.

Retouren

Promise<GraphScope>

getServicePrincipal(string)

Haal een service-principal op met behulp van de descriptor.

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

Parameters

servicePrincipalDescriptor

string

De beschrijving van de gewenste service-principal.

Retouren

Promise<GraphServicePrincipal>

getStorageKey(string)

Een descriptor oplossen in een opslagsleutel.

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

Parameters

subjectDescriptor

string

Retouren

Promise<GraphStorageKeyResult>

getSubject(string)

Een descriptor oplossen naar een gebruiker, groep of bereik.

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

Parameters

subjectDescriptor

string

De descriptor van het gewenste onderwerp.

Retouren

Promise<GraphSubject>

getUser(string)

Haal een gebruiker op met behulp van de descriptor.

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

Parameters

userDescriptor

string

De beschrijving van de gewenste gebruiker.

Retouren

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Haal alle lidmaatschappen op waarvan deze descriptor lid is van de relatie.

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

Parameters

subjectDescriptor

string

Alle directe lidmaatschappen van deze descriptor ophalen.

direction

GraphTraversalDirection

Standaard ingesteld op Up.

depth

number

Het maximum aantal randen dat omhoog of omlaag door de lidmaatschapsstructuur moet worden gekruist. Momenteel is de enige ondersteunde waarde '1'.

Retouren

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Hiermee worden alle aangevraagde leden in het huidige bereik (meestal organisatie of account) opgevraagd.

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

Parameters

memberLookup

GraphSubjectLookup

Retouren

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Doorkruis lidmaatschappen van de opgegeven onderwerpdescriptors.

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

Parameters

membershipTraversalLookup

GraphSubjectLookup

Haal de afstammelingen/voorouders van de lijst met descriptors op, afhankelijk van de richting.

direction

GraphTraversalDirection

De standaardwaarde is Onbekend.

depth

number

De standaardwaarde is '1'.

Retouren

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

lookupSubjects(GraphSubjectLookup)

Descriptors oplossen voor gebruikers, groepen of bereiken (Onderwerpen) in een batch.

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

Parameters

subjectLookup

GraphSubjectLookup

Een lijst met descriptors die een subset van op te halen onderwerpen specificeert. Elke descriptor identificeert het onderwerp uniek in alle exemplaarbereiken, maar slechts op één moment.

Retouren

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

querySubjects(GraphSubjectQuery)

Search voor Azure Devops-gebruikers of/en groepen. Resultaten worden geretourneerd in een batch met niet meer dan 100 grafiekonderwerpsen.

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

Parameters

subjectQuery

GraphSubjectQuery

De query die we gebruiken om te zoeken, bevat het volgende: Query: de zoekterm. De zoekopdracht is alleen overeenkomend met het voorvoegsel. SubjectKind: 'Gebruiker' of 'Groep' kan worden opgegeven, beide of beide ScopeDescriptor: Er kan een niet-standaardbereik worden opgegeven, d.w.w. projectbereikdescriptor

Retouren

Promise<GraphSubject[]>

removeMembership(string, string)

Hiermee verwijdert u een lidmaatschap tussen een container en een onderwerp.

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

Parameters

subjectDescriptor

string

Een descriptor voor een groep of gebruiker die het onderliggende onderwerp in de relatie is.

containerDescriptor

string

Een descriptor voor een groep die de container in de relatie is.

Retouren

Promise<void>

requestAccess(any)

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

Parameters

jsondocument

any

Retouren

Promise<void>

resolve(IdentityMappings)

Een lijst met gebruikers batchgewijs toewijzen aan nieuwe gebruikers.

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

Parameters

mappings

IdentityMappings

Een lijst met toewijzingen.

Retouren

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parameters

avatar

Avatar

subjectDescriptor

string

Retouren

Promise<void>

translate(string, string)

Identiteitsomzetting: het vertaaleindpunt moet worden gebruikt door geneva-actie.

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

Parameters

masterId

string

localId

string

Retouren

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Doorkruis lidmaatschappen van de opgegeven onderwerpdescriptor.

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

Parameters

subjectDescriptor

string

Haal de afstammelingen/voorouders van deze descriptor op, afhankelijk van de richting.

direction

GraphTraversalDirection

De standaardwaarde is Onbekend.

depth

number

De standaardwaarde is '1'.

Retouren

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Werk de eigenschappen van een Azure DevOps-groep bij.

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

Parameters

groupDescriptor

string

De beschrijving van de groep die moet worden gewijzigd.

patchDocument

JsonPatchDocument

Het JSON+Patch-document met de velden die moeten worden gewijzigd.

Retouren

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parameters

scopeDescriptor

string

patchDocument

JsonPatchDocument

Retouren

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Wijs een bestaande service-principal toe aan een andere service-principal.

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

Parameters

updateContext

GraphServicePrincipalUpdateContext

De subset van de service-principal voor de volledige grafiek die wordt gebruikt om het grafiekonderwerp uniek te vinden in een externe provider.

servicePrincipalDescriptor

string

De beschrijving van de service-principal die moet worden bijgewerkt

Retouren

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Wijs een bestaande gebruiker toe aan een andere gebruiker.

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

Parameters

updateContext

GraphUserUpdateContext

De subset van de volledige grafiekgebruiker die wordt gebruikt om het grafiekonderwerp uniek te vinden in een externe provider.

userDescriptor

string

De beschrijving van de gebruiker die moet worden bijgewerkt

Retouren

Promise<GraphUser>