GraphRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends

RestClientBase

Konstruktoren

GraphRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addMembership(string, string)	Erstellen Sie eine neue Mitgliedschaft zwischen einem Container und einem Antragsteller.
checkMembershipExistence(string, string)	Überprüfen Sie, ob eine Mitgliedschaftsbeziehung zwischen einem Container und einem Antragsteller vorhanden ist.
createGroup(GraphGroupCreationContext, string, string[])	Erstellen Sie eine neue Azure DevOps-Gruppe, oder materialisieren Sie eine vorhandene AAD-Gruppe.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialisieren Sie einen vorhandenen AAD-Dienstprinzipal im ADO-Konto.
createUser(GraphUserCreationContext, string[])	Materialisieren sie einen vorhandenen AAD- oder MSA-Benutzer in das ADO-Konto.
deleteAvatar(string)
deleteGroup(string)	Entfernt eine Azure DevOps-Gruppe aus allen übergeordneten Gruppen.
deleteScope(string)
deleteServicePrincipal(string)	Deaktiviert einen Dienstprinzipal.
deleteUser(string)	Deaktiviert einen Benutzer.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Auflösen eines Speicherschlüssels in einen Deskriptor
getFederatedProviderData(string, string, number)	Ruft den vollständigen Satz von Verbundanbieterauthentifizierungsdaten ab, die für den angegebenen Graph-Antragsteller und Anbieternamen verfügbar sind.
getGroup(string)	Ruft eine Gruppe anhand ihrer Deskriptor ab.
getMemberByDescriptor(string)	Dieser Endpunkt gibt ein Ergebnis für alle Mitglieder zurück, die jemals im System gültig waren, auch wenn das Mitglied inzwischen gelöscht oder alle Mitgliedschaften gelöscht wurden. Die aktuelle Gültigkeit des Members wird durch seine deaktivierte Eigenschaft angegeben, die bei false ausgelassen wird.
getMembership(string, string)	Ruft eine Mitgliedschaftsbeziehung zwischen einem Container und einem Antragsteller ab.
getMembershipState(string)	Überprüfen Sie, ob ein Betreff aktiv oder inaktiv ist.
getProviderInfo(string)
getScope(string)	Abrufen eines Bereichs, der durch seinen Deskriptor identifiziert wird
getServicePrincipal(string)	Ruft einen Dienstprinzipal anhand seines Deskriptors ab.
getStorageKey(string)	Auflösen eines Deskriptors in einen Speicherschlüssel.
getSubject(string)	Auflösen eines Deskriptors in einen Benutzer, eine Gruppe oder einen Bereich.
getUser(string)	Rufen Sie einen Benutzer anhand seines Deskriptors ab.
listMemberships(string, GraphTraversalDirection, number)	Ruft alle Mitgliedschaften ab, bei denen dieser Deskriptor mitglied in der Beziehung ist.
lookupMembers(GraphSubjectLookup)	Ruft alle angeforderten Mitglieder im aktuellen Bereich ab (in der Regel organization oder Konto).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Durchlaufen von Mitgliedschaften der angegebenen Betreffdeskriptoren.
lookupSubjects(GraphSubjectLookup)	Auflösen von Deskriptoren zu Benutzern, Gruppen oder Bereichen (Themen) in einem Batch.
querySubjects(GraphSubjectQuery)	Search für Azure Devops-Benutzer oder/und -Gruppen. Die Ergebnisse werden in einem Batch mit maximal 100 Graph-Themen zurückgegeben.
removeMembership(string, string)	Löscht eine Mitgliedschaft zwischen einem Container und einem Antragsteller.
requestAccess(any)
resolve(IdentityMappings)	Ordnen Sie eine Liste von Benutzern neuen Benutzern in Batch zu.
setAvatar(Avatar, string)
translate(string, string)	Identitätsübersetzung: Der Übersetzungsendpunkt sollte von der Genfer Aktion verwendet werden.
traverseMemberships(string, GraphTraversalDirection, number)	Durchlaufen sie Mitgliedschaften des angegebenen Betreffdeskriptors.
updateGroup(string, JsonPatchDocument)	Aktualisieren Sie die Eigenschaften einer Azure DevOps-Gruppe.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Ordnen Sie einen vorhandenen Dienstprinzipal einem anderen Dienstprinzipal zu.
updateUser(GraphUserUpdateContext, string)	Ordnen Sie einen vorhandenen Benutzer einem anderen Benutzer zu.

Details zum Konstruktor

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addMembership(string, string)

Erstellen Sie eine neue Mitgliedschaft zwischen einem Container und einem Antragsteller.

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

Parameter

subjectDescriptor

string

Ein Deskriptor für eine Gruppe oder einen Benutzer, der der untergeordnete Antragsteller in der Beziehung sein kann.

containerDescriptor

string

Ein Deskriptor für eine Gruppe, die der Container in der Beziehung sein kann.

Gibt zurück

Promise<GraphMembership>

checkMembershipExistence(string, string)

Überprüfen Sie, ob eine Mitgliedschaftsbeziehung zwischen einem Container und einem Antragsteller vorhanden ist.

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

Parameter

subjectDescriptor

string

Die Gruppe oder der Benutzer, die ein untergeordneter Gegenstand der Beziehung ist.

containerDescriptor

string

Die Gruppe, die der Container in der Beziehung ist.

Gibt zurück

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Erstellen Sie eine neue Azure DevOps-Gruppe, oder materialisieren Sie eine vorhandene AAD-Gruppe.

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

Parameter

creationContext

GraphGroupCreationContext

Die Teilmenge der vollständigen Graphgruppe, die verwendet wird, um den Graph-Betreff in einem externen Anbieter eindeutig zu finden.

scopeDescriptor

string

Ein Deskriptor, der auf den Bereich (Auflistung, Projekt) verweist, in dem die Gruppe erstellt werden soll. Wenn nicht angegeben, wird im Bereich des einschließenden Kontos oder organization erstellt. Nur für VSTS-Gruppen gültig.

groupDescriptors

string[]

Eine durch Trennzeichen getrennte Liste von Deskriptoren, die auf Gruppen verweisen, in die die Graphgruppe verknüpft werden soll

Gibt zurück

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parameter

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Gibt zurück

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materialisieren Sie einen vorhandenen AAD-Dienstprinzipal im ADO-Konto.

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

Parameter

creationContext

GraphServicePrincipalCreationContext

Die Teilmenge des vollständigen Graphdienstprinzipals, der verwendet wird, um den Graph-Betreff in einem externen Anbieter eindeutig zu finden.

groupDescriptors

string[]

Eine durch Trennzeichen getrennte Liste von Deskriptoren von Gruppen, die dem Graph-Dienstprinzipal beitreten sollen

Gibt zurück

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materialisieren sie einen vorhandenen AAD- oder MSA-Benutzer in das ADO-Konto.

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

Parameter

creationContext

GraphUserCreationContext

Die Teilmenge des vollständigen Graphbenutzers, der verwendet wird, um den Graph-Betreff in einem externen Anbieter eindeutig zu finden.

groupDescriptors

string[]

Eine durch Trennzeichen getrennte Liste von Deskriptoren von Gruppen, an die der Graphbenutzer teilnehmen soll

Gibt zurück

Promise<GraphUser>

deleteAvatar(string)

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

Parameter

subjectDescriptor

string

Gibt zurück

Promise<void>

deleteGroup(string)

Entfernt eine Azure DevOps-Gruppe aus allen übergeordneten Gruppen.

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

Parameter

groupDescriptor

string

Der Deskriptor der zu löschenden Gruppe.

Gibt zurück

Promise<void>

deleteScope(string)

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

Parameter

scopeDescriptor

string

Gibt zurück

Promise<void>

deleteServicePrincipal(string)

Deaktiviert einen Dienstprinzipal.

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

Parameter

servicePrincipalDescriptor

string

Der Deskriptor des zu löschenden Dienstprinzipals.

Gibt zurück

Promise<void>

deleteUser(string)

Deaktiviert einen Benutzer.

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

Parameter

userDescriptor

string

Der Deskriptor des zu löschenden Benutzers.

Gibt zurück

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parameter

subjectDescriptor

string

size

AvatarSize

format

string

Gibt zurück

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Gibt zurück

Promise<GraphCachePolicies>

getDescriptor(string)

Auflösen eines Speicherschlüssels in einen Deskriptor

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

Parameter

storageKey

string

Speicherschlüssel des aufzulösenden Betreffs (Benutzer, Gruppe, Bereich usw.)

Gibt zurück

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Ruft den vollständigen Satz von Verbundanbieterauthentifizierungsdaten ab, die für den angegebenen Graph-Antragsteller und Anbieternamen verfügbar sind.

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

Parameter

subjectDescriptor

string

der Deskriptor des Graph-Betreffs, für den wir Daten abrufen sollten

providerName

string

den Namen des Anbieters, für den Daten abgerufen werden sollen, z. B. "github.com"

versionHint

number

ein Versionshinweis, der für optimistische Cacheparallelität und zur Unterstützung von Wiederholungen bei Zugriffstokenfehlern verwendet werden kann; Beachten Sie, dass dies nur ein Hinweis ist und keine bestimmte Version der Antwort garantiert.

Gibt zurück

Promise<GraphFederatedProviderData>

getGroup(string)

Ruft eine Gruppe anhand ihrer Deskriptor ab.

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

Parameter

groupDescriptor

string

Der Deskriptor der gewünschten Graphgruppe.

Gibt zurück

Promise<GraphGroup>

getMemberByDescriptor(string)

Dieser Endpunkt gibt ein Ergebnis für alle Mitglieder zurück, die jemals im System gültig waren, auch wenn das Mitglied inzwischen gelöscht oder alle Mitgliedschaften gelöscht wurden. Die aktuelle Gültigkeit des Members wird durch seine deaktivierte Eigenschaft angegeben, die bei false ausgelassen wird.

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

Parameter

memberDescriptor

string

Der Deskriptor des gewünschten Elements.

Gibt zurück

Promise<GraphMember>

getMembership(string, string)

Ruft eine Mitgliedschaftsbeziehung zwischen einem Container und einem Antragsteller ab.

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

Parameter

subjectDescriptor

string

Ein Deskriptor zum untergeordneten Antragsteller in der Beziehung.

containerDescriptor

string

Ein Deskriptor für den Container in der Beziehung.

Gibt zurück

Promise<GraphMembership>

getMembershipState(string)

Überprüfen Sie, ob ein Betreff aktiv oder inaktiv ist.

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

Parameter

subjectDescriptor

string

Deskriptor des Betreffs (Benutzer, Gruppe, Bereich usw.) zum Überprüfen des Status von

Gibt zurück

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parameter

userDescriptor

string

Gibt zurück

Promise<GraphProviderInfo>

getScope(string)

Abrufen eines Bereichs, der durch seinen Deskriptor identifiziert wird

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

Parameter

scopeDescriptor

string

Ein Deskriptor, der einen Bereich eindeutig identifiziert.

Gibt zurück

Promise<GraphScope>

getServicePrincipal(string)

Ruft einen Dienstprinzipal anhand seines Deskriptors ab.

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

Parameter

servicePrincipalDescriptor

string

Der Deskriptor des gewünschten Dienstprinzipals.

Gibt zurück

Promise<GraphServicePrincipal>

getStorageKey(string)

Auflösen eines Deskriptors in einen Speicherschlüssel.

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

Parameter

subjectDescriptor

string

Gibt zurück

Promise<GraphStorageKeyResult>

getSubject(string)

Auflösen eines Deskriptors in einen Benutzer, eine Gruppe oder einen Bereich.

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

Parameter

subjectDescriptor

string

Der Deskriptor des gewünschten Betreffs.

Gibt zurück

Promise<GraphSubject>

getUser(string)

Rufen Sie einen Benutzer anhand seines Deskriptors ab.

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

Parameter

userDescriptor

string

Der Deskriptor des gewünschten Benutzers.

Gibt zurück

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Ruft alle Mitgliedschaften ab, bei denen dieser Deskriptor mitglied in der Beziehung ist.

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

Parameter

subjectDescriptor

string

Rufen Sie alle direkten Mitgliedschaften dieses Deskriptors ab.

direction

GraphTraversalDirection

Der Standardwert ist "Up".

depth

number

Die maximale Anzahl von Kanten, die in der Mitgliedschaftsstruktur nach oben oder unten durchlaufen werden sollen. Derzeit wird nur der Wert "1" unterstützt.

Gibt zurück

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Ruft alle angeforderten Mitglieder im aktuellen Bereich ab (in der Regel organization oder Konto).

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

Parameter

memberLookup

GraphSubjectLookup

Gibt zurück

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Durchlaufen von Mitgliedschaften der angegebenen Betreffdeskriptoren.

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

Parameter

membershipTraversalLookup

GraphSubjectLookup

Rufen Sie je nach Richtung die Nachfolger/Vorfahren der Liste der Deskriptoren ab.

direction

GraphTraversalDirection

Der Standardwert ist Unknown (Unbekannt).

depth

number

Der Standardwert ist „1“.

Gibt zurück

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

lookupSubjects(GraphSubjectLookup)

Auflösen von Deskriptoren zu Benutzern, Gruppen oder Bereichen (Themen) in einem Batch.

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

Parameter

subjectLookup

GraphSubjectLookup

Eine Liste von Deskriptoren, die eine Teilmenge der abzurufenden Themen angibt. Jeder Deskriptor identifiziert den Betreff eindeutig in allen instance Bereichen, aber nur zu einem einzigen Zeitpunkt.

Gibt zurück

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

querySubjects(GraphSubjectQuery)

Search für Azure Devops-Benutzer oder/und -Gruppen. Die Ergebnisse werden in einem Batch mit maximal 100 Graph-Themen zurückgegeben.

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

Parameter

subjectQuery

GraphSubjectQuery

Die Abfrage, die wir für die Suche verwenden, enthält Folgendes: Abfrage: der Suchbegriff. Die Suche entspricht nur dem Präfix. SubjectKind: "User" oder "Group" kann angegeben werden, sowohl als auch ScopeDescriptor: Nicht standardmäßiger Bereich kann angegeben werden, d. h. Projektbereichsdeskriptor

Gibt zurück

Promise<GraphSubject[]>

removeMembership(string, string)

Löscht eine Mitgliedschaft zwischen einem Container und einem Antragsteller.

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

Parameter

subjectDescriptor

string

Ein Deskriptor für eine Gruppe oder einen Benutzer, der der untergeordnete Antragsteller in der Beziehung ist.

containerDescriptor

string

Ein Deskriptor für eine Gruppe, die der Container in der Beziehung ist.

Gibt zurück

Promise<void>

requestAccess(any)

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

Parameter

jsondocument

any

Gibt zurück

Promise<void>

resolve(IdentityMappings)

Ordnen Sie eine Liste von Benutzern neuen Benutzern in Batch zu.

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

Parameter

mappings

IdentityMappings

Eine Liste von Zuordnungen.

Gibt zurück

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parameter

avatar

Avatar

subjectDescriptor

string

Gibt zurück

Promise<void>

translate(string, string)

Identitätsübersetzung: Der Übersetzungsendpunkt sollte von der Genfer Aktion verwendet werden.

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

Parameter

masterId

string

localId

string

Gibt zurück

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Durchlaufen sie Mitgliedschaften des angegebenen Betreffdeskriptors.

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

Parameter

subjectDescriptor

string

Rufen Sie die Nachfolger/Vorfahren dieses Deskriptors abhängig von der Richtung ab.

direction

GraphTraversalDirection

Der Standardwert ist Unknown (Unbekannt).

depth

number

Der Standardwert ist „1“.

Gibt zurück

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Aktualisieren Sie die Eigenschaften einer Azure DevOps-Gruppe.

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

Parameter

groupDescriptor

string

Der Deskriptor der zu ändernden Gruppe.

patchDocument

JsonPatchDocument

Das JSON+Patch-Dokument mit den zu ändernden Feldern.

Gibt zurück

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parameter

scopeDescriptor

string

patchDocument

JsonPatchDocument

Gibt zurück

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Ordnen Sie einen vorhandenen Dienstprinzipal einem anderen Dienstprinzipal zu.

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

Parameter

updateContext

GraphServicePrincipalUpdateContext

Die Teilmenge des vollständigen Graphdienstprinzipals, der verwendet wird, um den Graph-Betreff in einem externen Anbieter eindeutig zu finden.

servicePrincipalDescriptor

string

Der Deskriptor des zu aktualisierenden Dienstprinzipals

Gibt zurück

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Ordnen Sie einen vorhandenen Benutzer einem anderen Benutzer zu.

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

Parameter

updateContext

GraphUserUpdateContext

Die Teilmenge des vollständigen Graphbenutzers, der verwendet wird, um den Graph-Betreff in einem externen Anbieter eindeutig zu finden.

userDescriptor

string

Der Deskriptor des zu aktualisierenden Benutzers

Gibt zurück

Promise<GraphUser>