GraphRestClient class

Pakiet:

azure-devops-extension-api

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

Extends

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[])	Materializuj istniejącą jednostkę usługi AAD na koncie ADO.
createUser(GraphUserCreationContext, string[])	Materializuj 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)	Rozwiązywanie problemu z kluczem magazynu deskryptorem
getFederatedProviderData(string, string, number)	Uzyskuje pełny zestaw danych uwierzytelniania dostawcy federacyjnego dostępnych dla danego podmiotu grafu i nazwy dostawcy.
getGroup(string)	Pobierz grupę według deskryptora.
getMemberByDescriptor(string)	Ten punkt końcowy zwraca wynik dla każdego członka, który kiedykolwiek był prawidłowy w systemie, nawet jeśli członek został usunięty lub wszystkie ich członkostwa zostały usunięte. Bieżąca ważność elementu członkowskiego jest wskazywana za pośrednictwem jego właściwości wyłączonej, która jest pomijana, gdy wartość false.
getMembership(string, string)	Uzyskaj relację członkostwa między kontenerem a tematem.
getMembershipState(string)	Sprawdź, czy temat jest aktywny, czy nieaktywny.
getProviderInfo(string)
getScope(string)	Pobieranie zakresu zidentyfikowanego przez deskryptor
getServicePrincipal(string)	Pobierz jednostkę usługi według deskryptora.
getStorageKey(string)	Rozwiąż deskryptor do klucza magazynu.
getSubject(string)	Rozwiąż deskryptor do użytkownika, grupy lub zakresu.
getUser(string)	Pobierz użytkownika według 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 organizacja lub konto).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Przechodzenie do członkostwa w danych deskryptorach podmiotów.
lookupSubjects(GraphSubjectLookup)	Rozwiąż deskryptory dla użytkowników, grup lub zakresów (podmiotów) w partii.
querySubjects(GraphSubjectQuery)	Search dla użytkowników usługi Azure Devops lub/i grup. Wyniki zostaną zwrócone w partii z nie więcej niż 100 tematami grafu.
removeMembership(string, string)	Usuwa członkostwo między kontenerem a tematem.
requestAccess(any)
resolve(IdentityMappings)	Usługa Batch mapuje listę użytkowników na nowych użytkowników.
setAvatar(Avatar, string)
translate(string, string)	Tłumaczenie tożsamości — tłumaczenie punktu końcowego ma być używane przez akcję genewa.
traverseMemberships(string, GraphTraversalDirection, number)	Przechodzenie do członkostwa w danym deskryptorze podmiotu.
updateGroup(string, JsonPatchDocument)	Zaktualizuj właściwości grupy usługi Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Mapuj istniejącą jednostkę usługi na inną jednostkę usługi.
updateUser(GraphUserUpdateContext, string)	Mapuj 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 do grupy lub użytkownika, który może być tematem podrzędnym w relacji.

containerDescriptor

string

Deskryptor do grupy, która 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 tematem 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 grafu używany do unikatowego znajdowania tematu grafu u dostawcy zewnętrznego.

scopeDescriptor

string

Deskryptor odwołujący się do zakresu (kolekcji, projektu), w którym należy utworzyć grupę. Jeśli zostanie pominięty, zostanie utworzony w zakresie otaczającego konta lub organizacji. Prawidłowe tylko dla grup usługi VSTS.

groupDescriptors

string[]

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

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[])

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

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

Parametry

creationContext

GraphServicePrincipalCreationContext

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

groupDescriptors

string[]

Rozdzielona przecinkami lista deskryptorów grup, które mają zostać dołączone do jednostki usługi programu Graph

Zwraca

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materializuj 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 użytkownika grafu używany do unikatowego znajdowania tematu grafu 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 do usunięcia.

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)

Rozwiązywanie problemu z kluczem magazynu deskryptorem

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

Parametry

storageKey

string

Klucz magazynu tematu (użytkownik, grupa, zakres itp.), aby rozwiązać ten problem

Zwraca

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Uzyskuje pełny zestaw danych uwierzytelniania dostawcy federacyjnego dostępnych dla danego podmiotu 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 uzyskać dane

providerName

string

nazwa dostawcy do uzyskiwania danych, np. "github.com"

versionHint

number

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

Zwraca

Promise<GraphFederatedProviderData>

getGroup(string)

Pobierz grupę według deskryptora.

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

Parametry

groupDescriptor

string

Deskryptor żądanej grupy grafu.

Zwraca

Promise<GraphGroup>

getMemberByDescriptor(string)

Ten punkt końcowy zwraca wynik dla każdego członka, który kiedykolwiek był prawidłowy w systemie, nawet jeśli członek został usunięty lub wszystkie ich członkostwa zostały usunięte. Bieżąca ważność elementu członkowskiego jest wskazywana za pośrednictwem jego właściwości wyłączonej, 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)

Uzyskaj 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 relacji.

containerDescriptor

string

Deskryptor do 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 zidentyfikowanego przez 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 deskryptora.

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

Parametry

servicePrincipalDescriptor

string

Deskryptor żądanej jednostki usługi.

Zwraca

Promise<GraphServicePrincipal>

getStorageKey(string)

Rozwiąż deskryptor do klucza magazynu.

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

Parametry

subjectDescriptor

string

Zwraca

Promise<GraphStorageKeyResult>

getSubject(string)

Rozwiąż deskryptor do użytkownika, grupy lub zakresu.

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

Parametry

subjectDescriptor

string

Deskryptor żądanego tematu.

Zwraca

Promise<GraphSubject>

getUser(string)

Pobierz użytkownika według 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

Pobierz wszystkie bezpośrednie członkostwa w tym deskryptorze.

direction

GraphTraversalDirection

Wartości domyślne do góry.

depth

number

Maksymalna liczba krawędzi do przechodzenia 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 organizacja lub konto).

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

Parametry

memberLookup

GraphSubjectLookup

Zwraca

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Przechodzenie do członkostwa w danych deskryptorach podmiotów.

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

Parametry

membershipTraversalLookup

GraphSubjectLookup

Pobierz elementów potomnych/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)

Rozwiąż deskryptory dla użytkowników, grup lub zakresów (podmiotów) w partii.

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

Parametry

subjectLookup

GraphSubjectLookup

Lista deskryptorów, które określają podzestaw tematów do pobrania. Każdy deskryptor jednoznacznie identyfikuje temat we wszystkich zakresach wystąpień, ale tylko w jednym punkcie w czasie.

Zwraca

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

querySubjects(GraphSubjectQuery)

Search dla użytkowników usługi Azure Devops lub/i grup. Wyniki zostaną zwrócone w partii z nie więcej niż 100 tematami grafu.

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

Parametry

subjectQuery

GraphSubjectQuery

Zapytanie, którego będziemy używać do wyszukiwania, obejmuje następujące elementy: Zapytanie: wyszukiwany termin. Wyszukiwanie będzie pasować tylko do prefiksu. SubjectKind: można określić "Użytkownik" lub "Grupę", zarówno, jak i dla klasy 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 do grupy lub użytkownika będącego podmiotem podrzędnym w relacji.

containerDescriptor

string

Deskryptor do 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)

Usługa Batch mapuje listę 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 — tłumaczenie punktu końcowego ma być używane przez akcję genewa.

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

Parametry

masterId

string

localId

string

Zwraca

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Przechodzenie do członkostwa w danym deskryptorze podmiotu.

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

Parametry

subjectDescriptor

string

Pobierz elementów potomnych/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)

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

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

Parametry

groupDescriptor

string

Deskryptor grupy do zmodyfikowania.

patchDocument

JsonPatchDocument

Dokument JSON+Patch zawierający pola do zmiany.

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)

Mapuj 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 dostawcy zewnętrznego.

servicePrincipalDescriptor

string

Deskryptor jednostki usługi do aktualizacji

Zwraca

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

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

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

Parametry

updateContext

GraphUserUpdateContext

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

userDescriptor

string

Deskryptor użytkownika do aktualizacji

Zwraca

Promise<GraphUser>