GraphRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie

RestClientBase

Konstruktory

GraphRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

addMembership(string, string)	Utwórz nowe członkostwo między kontenerem a tematem.
checkMembershipExistence(string, string)	Sprawdź, czy istnieje relacja członkostwa między kontenerem a tematem.
createGroup(GraphGroupCreationContext, string, string[])	Utwórz nową grupę usługi Azure DevOps lub zmaterializuj istniejącą grupę usługi AAD.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Zmaterializuj istniejącą jednostkę usługi AAD na koncie ADO.
createUser(GraphUserCreationContext, string[])	Zmaterializuj istniejącego użytkownika usługi AAD lub MSA na koncie ADO.
deleteAvatar(string)
deleteGroup(string)	Usuwa grupę usługi Azure DevOps ze wszystkich jej grup nadrzędnych.
deleteScope(string)
deleteServicePrincipal(string)	Wyłącza jednostkę usługi.
deleteUser(string)	Wyłącza użytkownika.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Rozpoznawanie klucza magazynu z deskryptorem
getFederatedProviderData(string, string, number)	Pobiera pełny zestaw danych uwierzytelniania dostawcy federacyjnego dostępnych dla danego tematu grafu i nazwy dostawcy.
getGroup(string)	Pobierz grupę według jej deskryptora.
getMemberByDescriptor(string)	Ten punkt końcowy zwraca wynik dla dowolnego elementu członkowskiego, który kiedykolwiek był prawidłowy w systemie, nawet jeśli element członkowski został od tego czasu usunięty lub usunięto wszystkie jego członkostwa. Bieżąca ważność elementu członkowskiego jest wskazywana przez jego właściwość disabled, która jest pomijana, gdy wartość false .
getMembership(string, string)	Pobierz relację członkostwa między kontenerem a tematem.
getMembershipState(string)	Sprawdź, czy temat jest aktywny, czy nieaktywny.
getProviderInfo(string)
getScope(string)	Pobieranie zakresu identyfikowanego przez jego deskryptor
getServicePrincipal(string)	Pobierz jednostkę usługi według jej deskryptora.
getStorageKey(string)	Rozmiń deskryptor na klucz magazynu.
getSubject(string)	Rozpoznawanie deskryptora jako użytkownika, grupy lub zakresu.
getUser(string)	Pobierz użytkownika według jego deskryptora.
listMemberships(string, GraphTraversalDirection, number)	Pobierz wszystkie członkostwa, w których ten deskryptor jest członkiem relacji.
lookupMembers(GraphSubjectLookup)	Pobiera wszystkich żądanych członków w bieżącym zakresie (zwykle w instytucji lub na koncie).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Przechodzenie przez członkostwo w podanych deskryptorach tematycznych.
lookupSubjects(GraphSubjectLookup)	Rozpoznawanie deskryptorów dla użytkowników, grup lub zakresów (tematów) w partii.
querySubjects(GraphSubjectQuery)	Wyszukaj użytkowników usługi Azure DevOps i/lub grupy. Wyniki zostaną zwrócone w partii zawierającej nie więcej niż 100 tematów wykresów.
removeMembership(string, string)	Usuwa członkostwo między kontenerem a tematem.
requestAccess(any)
resolve(IdentityMappings)	Mapowanie wsadowe listy użytkowników na nowych użytkowników.
setAvatar(Avatar, string)
translate(string, string)	Tłumaczenie tożsamości - Punkt końcowy Translate ma być używany przez akcję genewą.
traverseMemberships(string, GraphTraversalDirection, number)	Przechodzenie przez członkostwo w danym deskryptorze tematu.
updateGroup(string, JsonPatchDocument)	Aktualizowanie właściwości grupy usługi Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Zamapuj istniejącą jednostkę usługi na inną jednostkę usługi.
updateUser(GraphUserUpdateContext, string)	Zmapuj istniejącego użytkownika na innego użytkownika.

Szczegóły konstruktora

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

addMembership(string, string)

Utwórz nowe członkostwo między kontenerem a tematem.

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

Parametry

subjectDescriptor

string

Deskryptor grupy lub użytkownika, który może być podmiotem podrzędnym w relacji.

containerDescriptor

string

Deskryptor grupy, który może być kontenerem w relacji.

Zwraca

Promise<GraphMembership>

checkMembershipExistence(string, string)

Sprawdź, czy istnieje relacja członkostwa między kontenerem a tematem.

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

Parametry

subjectDescriptor

string

Grupa lub użytkownik, który jest podrzędnym podmiotem relacji.

containerDescriptor

string

Grupa, która jest kontenerem w relacji.

Zwraca

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Utwórz nową grupę usługi Azure DevOps lub zmaterializuj istniejącą grupę usługi AAD.

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

Parametry

creationContext

GraphGroupCreationContext

Podzbiór pełnej grupy grafów używany do unikatowego znajdowania tematu grafu u u zewnętrznego dostawcy.

scopeDescriptor

string

Deskryptor odwołujący się do zakresu (kolekcji, projektu), w którym grupa ma zostać utworzona. Jeśli zostanie pominięty, zostanie utworzony w zakresie otaczającego konta lub organizacji. Dotyczy tylko grup usługi VSTS.

groupDescriptors

string[]

Rozdzielona przecinkami lista deskryptorów odwołujących się do grup, do których grupa grafów ma zostać dołączona

Zwraca

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parametry

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Zwraca

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Zmaterializuj istniejącą jednostkę usługi AAD na koncie ADO.

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

Parametry

creationContext

GraphServicePrincipalCreationContext

Podzbiór pełnej jednostki usługi grafu używany do unikatowego znajdowania tematu grafu u u dostawcy zewnętrznego.

groupDescriptors

string[]

Rozdzielona przecinkami lista deskryptorów grup, do których ma dołączyć jednostka usługi grafu

Zwraca

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Zmaterializuj istniejącego użytkownika usługi AAD lub MSA na koncie ADO.

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

Parametry

creationContext

GraphUserCreationContext

Podzbiór pełnego grafu używany przez użytkownika do unikatowego znajdowania tematu grafu u u zewnętrznego dostawcy.

groupDescriptors

string[]

Rozdzielona przecinkami lista deskryptorów grup, do których ma dołączyć użytkownik grafu

Zwraca

Promise<GraphUser>

deleteAvatar(string)

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

Parametry

subjectDescriptor

string

Zwraca

Promise<void>

deleteGroup(string)

Usuwa grupę usługi Azure DevOps ze wszystkich jej grup nadrzędnych.

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

Parametry

groupDescriptor

string

Deskryptor grupy, która ma zostać usunięta.

Zwraca

Promise<void>

deleteScope(string)

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

Parametry

scopeDescriptor

string

Zwraca

Promise<void>

deleteServicePrincipal(string)

Wyłącza jednostkę usługi.

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

Parametry

servicePrincipalDescriptor

string

Deskryptor jednostki usługi do usunięcia.

Zwraca

Promise<void>

deleteUser(string)

Wyłącza użytkownika.

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

Parametry

userDescriptor

string

Deskryptor użytkownika do usunięcia.

Zwraca

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parametry

subjectDescriptor

string

size

AvatarSize

format

string

Zwraca

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Zwraca

Promise<GraphCachePolicies>

getDescriptor(string)

Rozpoznawanie klucza magazynu z deskryptorem

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

Parametry

storageKey

string

Klucz przechowywania podmiotu (użytkownika, grupy, zakresu itp.) w celu rozwiązania

Zwraca

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Pobiera pełny zestaw danych uwierzytelniania dostawcy federacyjnego dostępnych dla danego tematu grafu i nazwy dostawcy.

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

Parametry

subjectDescriptor

string

deskryptor tematu grafu, dla którego powinniśmy pozyskać dane

providerName

string

nazwę dostawcy, dla którego mają być pozyskiwane dane, np. "github.com"

versionHint

number

Wskazówka dotycząca wersji, która może być używana do optymistycznej współbieżności pamięci podręcznej i do obsługi ponownych prób w przypadku awarii tokenu dostępu; Należy pamiętać, że jest to tylko wskazówka i nie gwarantuje konkretnej wersji odpowiedzi

Zwraca

Promise<GraphFederatedProviderData>

getGroup(string)

Pobierz grupę według jej deskryptora.

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

Parametry

groupDescriptor

string

Deskryptor żądanej grupy wykresów.

Zwraca

Promise<GraphGroup>

getMemberByDescriptor(string)

Ten punkt końcowy zwraca wynik dla dowolnego elementu członkowskiego, który kiedykolwiek był prawidłowy w systemie, nawet jeśli element członkowski został od tego czasu usunięty lub usunięto wszystkie jego członkostwa. Bieżąca ważność elementu członkowskiego jest wskazywana przez jego właściwość disabled, która jest pomijana, gdy wartość false .

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

Parametry

memberDescriptor

string

Deskryptor żądanego elementu członkowskiego.

Zwraca

Promise<GraphMember>

getMembership(string, string)

Pobierz relację członkostwa między kontenerem a tematem.

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

Parametry

subjectDescriptor

string

Deskryptor do podmiotu podrzędnego w związku.

containerDescriptor

string

Deskryptor kontenera w relacji.

Zwraca

Promise<GraphMembership>

getMembershipState(string)

Sprawdź, czy temat jest aktywny, czy nieaktywny.

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

Parametry

subjectDescriptor

string

Deskryptor tematu (użytkownik, grupa, zakres itp.) w celu sprawdzenia stanu

Zwraca

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parametry

userDescriptor

string

Zwraca

Promise<GraphProviderInfo>

getScope(string)

Pobieranie zakresu identyfikowanego przez jego deskryptor

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

Parametry

scopeDescriptor

string

Deskryptor, który jednoznacznie identyfikuje zakres.

Zwraca

Promise<GraphScope>

getServicePrincipal(string)

Pobierz jednostkę usługi według jej deskryptora.

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

Parametry

servicePrincipalDescriptor

string

Deskryptor żądanej jednostki usługi.

Zwraca

Promise<GraphServicePrincipal>

getStorageKey(string)

Rozmiń deskryptor na klucz magazynu.

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

Parametry

subjectDescriptor

string

Zwraca

Promise<GraphStorageKeyResult>

getSubject(string)

Rozpoznawanie deskryptora jako użytkownika, grupy lub zakresu.

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

Parametry

subjectDescriptor

string

Deskryptor pożądanego tematu.

Zwraca

Promise<GraphSubject>

getUser(string)

Pobierz użytkownika według jego deskryptora.

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

Parametry

userDescriptor

string

Deskryptor żądanego użytkownika.

Zwraca

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Pobierz wszystkie członkostwa, w których ten deskryptor jest członkiem relacji.

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

Parametry

subjectDescriptor

string

Pobiera wszystkie bezpośrednie członkostwa tego deskryptora.

direction

GraphTraversalDirection

Wartość domyślna to Up.

depth

number

Maksymalna liczba krawędzi do przebycia w górę lub w dół drzewa członkostwa. Obecnie jedyną obsługiwaną wartością jest "1".

Zwraca

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Pobiera wszystkich żądanych członków w bieżącym zakresie (zwykle w instytucji lub na koncie).

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

Parametry

memberLookup

GraphSubjectLookup

Zwraca

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Przechodzenie przez członkostwo w podanych deskryptorach tematycznych.

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

Parametry

membershipTraversalLookup

GraphSubjectLookup

Pobierz potomków/przodków listy deskryptorów w zależności od kierunku.

direction

GraphTraversalDirection

Wartość domyślna to Nieznany.

depth

number

Wartość domyślna to "1".

Zwraca

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

lookupSubjects(GraphSubjectLookup)

Rozpoznawanie deskryptorów dla użytkowników, grup lub zakresów (tematów) w partii.

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

Parametry

subjectLookup

GraphSubjectLookup

Lista deskryptorów określająca podzbiór tematów do pobrania. Każdy deskryptor jednoznacznie identyfikuje temat we wszystkich zakresach wystąpień, ale tylko w jednym momencie.

Zwraca

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

querySubjects(GraphSubjectQuery)

Wyszukaj użytkowników usługi Azure DevOps i/lub grupy. Wyniki zostaną zwrócone w partii zawierającej nie więcej niż 100 tematów wykresów.

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

Parametry

subjectQuery

GraphSubjectQuery

Zapytanie, którego będziemy używać do wyszukiwania, obejmuje następujące elementy: Zapytanie: wyszukiwane hasło. Wyszukiwanie będzie dotyczyło tylko dopasowania prefiksu. SubjectKind: Można określić wartość "User" lub "Group", obie te wartości lub dowolne ScopeDescriptor: Można określić zakres inny niż domyślny, tj. deskryptor zakresu projektu

Zwraca

Promise<GraphSubject[]>

removeMembership(string, string)

Usuwa członkostwo między kontenerem a tematem.

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

Parametry

subjectDescriptor

string

Deskryptor grupy lub użytkownika, który jest podmiotem podrzędnym w relacji.

containerDescriptor

string

Deskryptor grupy, która jest kontenerem w relacji.

Zwraca

Promise<void>

requestAccess(any)

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

Parametry

jsondocument

any

Zwraca

Promise<void>

resolve(IdentityMappings)

Mapowanie wsadowe listy użytkowników na nowych użytkowników.

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

Parametry

mappings

IdentityMappings

Lista mapowań.

Zwraca

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parametry

avatar

Avatar

subjectDescriptor

string

Zwraca

Promise<void>

translate(string, string)

Tłumaczenie tożsamości - Punkt końcowy Translate ma być używany przez akcję genewą.

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

Parametry

masterId

string

localId

string

Zwraca

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Przechodzenie przez członkostwo w danym deskryptorze tematu.

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

Parametry

subjectDescriptor

string

Pobierz potomków/przodków tego deskryptora w zależności od kierunku.

direction

GraphTraversalDirection

Wartość domyślna to Nieznany.

depth

number

Wartość domyślna to "1".

Zwraca

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Aktualizowanie właściwości grupy usługi Azure DevOps.

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

Parametry

groupDescriptor

string

Deskryptor grupy, która ma zostać zmodyfikowana.

patchDocument

JsonPatchDocument

Dokument JSON+Patch zawierający pola, które mają zostać zmienione.

Zwraca

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parametry

scopeDescriptor

string

patchDocument

JsonPatchDocument

Zwraca

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Zamapuj istniejącą jednostkę usługi na inną jednostkę usługi.

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

Parametry

updateContext

GraphServicePrincipalUpdateContext

Podzbiór pełnej jednostki usługi grafu używany do unikatowego znajdowania tematu grafu u u dostawcy zewnętrznego.

servicePrincipalDescriptor

string

Deskryptor jednostki usługi do zaktualizowania

Zwraca

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Zmapuj istniejącego użytkownika na innego użytkownika.

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

Parametry

updateContext

GraphUserUpdateContext

Podzbiór pełnego grafu używany przez użytkownika do unikatowego znajdowania tematu grafu u u zewnętrznego dostawcy.

userDescriptor

string

Deskryptor użytkownika do zaktualizowania

Zwraca

Promise<GraphUser>