GraphRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends

RestClientBase

Costruttori

GraphRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addMembership(string, string)	Creare una nuova appartenenza tra un contenitore e un oggetto.
checkMembershipExistence(string, string)	Verificare se esiste una relazione di appartenenza tra un contenitore e un oggetto.
createGroup(GraphGroupCreationContext, string, string[])	Creare un nuovo gruppo Di Azure DevOps o materializzare un gruppo AAD esistente.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materializzare un'entità servizio AAD esistente nell'account ADO.
createUser(GraphUserCreationContext, string[])	Materializzare un utente AAD o MSA esistente nell'account ADO.
deleteAvatar(string)
deleteGroup(string)	Rimuove un gruppo Di Azure DevOps da tutti i gruppi padre.
deleteScope(string)
deleteServicePrincipal(string)	Disabilita un'entità servizio.
deleteUser(string)	Disabilita un utente.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Risolvere una chiave di archiviazione in un descrittore
getFederatedProviderData(string, string, number)	Acquisisce il set completo di dati di autenticazione del provider federato disponibili per l'oggetto grafico e il nome del provider specificati.
getGroup(string)	Ottenere un gruppo in base al descrittore.
getMemberByDescriptor(string)	Questo endpoint restituisce un risultato per qualsiasi membro mai valido nel sistema, anche se il membro è stato eliminato o ha eliminato tutte le appartenenze. La validità corrente del membro viene indicata tramite la relativa proprietà disabilitata, che viene omessa quando false.
getMembership(string, string)	Ottenere una relazione di appartenenza tra un contenitore e un oggetto.
getMembershipState(string)	Verificare se un oggetto è attivo o inattivo.
getProviderInfo(string)
getScope(string)	Ottenere un ambito identificato dal descrittore
getServicePrincipal(string)	Ottenere un'entità servizio dal descrittore.
getStorageKey(string)	Risolvere un descrittore in una chiave di archiviazione.
getSubject(string)	Risolvere un descrittore in un utente, un gruppo o un ambito.
getUser(string)	Ottenere un utente dal descrittore.
listMemberships(string, GraphTraversalDirection, number)	Ottenere tutte le appartenenze in cui questo descrittore è un membro della relazione.
lookupMembers(GraphSubjectLookup)	Ottiene tutti i membri richiesti nell'ambito corrente (in genere l'organizzazione o l'account).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Attraversare le appartenenze dei descrittori di soggetto specificati.
lookupSubjects(GraphSubjectLookup)	Risolvere i descrittori agli utenti, ai gruppi o agli ambiti (Soggetti) in un batch.
querySubjects(GraphSubjectQuery)	Search per gli utenti o/o i gruppi di Azure Devops. I risultati verranno restituiti in un batch senza più di 100 soggetti a grafo.
removeMembership(string, string)	Elimina un'appartenenza tra un contenitore e un oggetto.
requestAccess(any)
resolve(IdentityMappings)	Eseguire il mapping di un elenco di utenti a nuovi utenti.
setAvatar(Avatar, string)
translate(string, string)	Identity Translation: l'endpoint di traduzione delle identità deve essere usato dall'azione di ginevra.
traverseMemberships(string, GraphTraversalDirection, number)	Attraversare le appartenenze del descrittore soggetto specificato.
updateGroup(string, JsonPatchDocument)	Aggiornare le proprietà di un gruppo Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Eseguire il mapping di un'entità servizio esistente a un'entità servizio diversa.
updateUser(GraphUserUpdateContext, string)	Eseguire il mapping di un utente esistente a un utente diverso.

Dettagli costruttore

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addMembership(string, string)

Creare una nuova appartenenza tra un contenitore e un oggetto.

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

Parametri

subjectDescriptor

string

Descrittore di un gruppo o di un utente che può essere l'oggetto figlio nella relazione.

containerDescriptor

string

Descrittore di un gruppo che può essere il contenitore nella relazione.

Restituisce

Promise<GraphMembership>

checkMembershipExistence(string, string)

Verificare se esiste una relazione di appartenenza tra un contenitore e un oggetto.

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

Parametri

subjectDescriptor

string

Gruppo o utente che è un oggetto figlio della relazione.

containerDescriptor

string

Gruppo che rappresenta il contenitore nella relazione.

Restituisce

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Creare un nuovo gruppo Di Azure DevOps o materializzare un gruppo AAD esistente.

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

Parametri

creationContext

GraphGroupCreationContext

Subset del gruppo di gragrafi completo usato per trovare in modo univoco l'oggetto del grafico in un provider esterno.

scopeDescriptor

string

Descrittore che fa riferimento all'ambito (raccolta, progetto) in cui deve essere creato il gruppo. Se omesso, verrà creato nell'ambito dell'account o dell'organizzazione che lo racchiude. Valido solo per i gruppi VSTS.

groupDescriptors

string[]

Elenco delimitato da virgole di descrittori che fanno riferimento a gruppi a cui si vuole che il gruppo di grafici si unisca

Restituisce

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parametri

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Restituisce

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materializzare un'entità servizio AAD esistente nell'account ADO.

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

Parametri

creationContext

GraphServicePrincipalCreationContext

Subset dell'entità servizio graph completa usata per trovare in modo univoco l'oggetto del grafico in un provider esterno.

groupDescriptors

string[]

Elenco delimitato da virgole di descrittori di gruppi a cui si vuole aggiungere l'entità servizio graph

Restituisce

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materializzare un utente AAD o MSA esistente nell'account ADO.

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

Parametri

creationContext

GraphUserCreationContext

Subset dell'utente del grafico completo usato per trovare in modo univoco l'oggetto del grafico in un provider esterno.

groupDescriptors

string[]

Elenco delimitato da virgole di descrittori di gruppi a cui si vuole che l'utente del grafo si unisce

Restituisce

Promise<GraphUser>

deleteAvatar(string)

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

Parametri

subjectDescriptor

string

Restituisce

Promise<void>

deleteGroup(string)

Rimuove un gruppo Di Azure DevOps da tutti i gruppi padre.

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

Parametri

groupDescriptor

string

Descrittore del gruppo da eliminare.

Restituisce

Promise<void>

deleteScope(string)

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

Parametri

scopeDescriptor

string

Restituisce

Promise<void>

deleteServicePrincipal(string)

Disabilita un'entità servizio.

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

Parametri

servicePrincipalDescriptor

string

Descrittore dell'entità servizio da eliminare.

Restituisce

Promise<void>

deleteUser(string)

Disabilita un utente.

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

Parametri

userDescriptor

string

Descrittore dell'utente da eliminare.

Restituisce

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parametri

subjectDescriptor

string

size

AvatarSize

format

string

Restituisce

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Restituisce

Promise<GraphCachePolicies>

getDescriptor(string)

Risolvere una chiave di archiviazione in un descrittore

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

Parametri

storageKey

string

Chiave di archiviazione dell'oggetto (utente, gruppo, ambito e così via) da risolvere

Restituisce

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Acquisisce il set completo di dati di autenticazione del provider federato disponibili per l'oggetto grafico e il nome del provider specificati.

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

Parametri

subjectDescriptor

string

descrittore dell'oggetto del grafico per cui è necessario acquisire i dati

providerName

string

nome del provider per cui acquisire dati, ad esempio "github.com"

versionHint

number

hint di versione che può essere usato per la concorrenza della cache ottimistica e per supportare i tentativi in caso di errori dei token di accesso; si noti che si tratta solo di un hint e non garantisce una versione specifica sulla risposta

Restituisce

Promise<GraphFederatedProviderData>

getGroup(string)

Ottenere un gruppo in base al descrittore.

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

Parametri

groupDescriptor

string

Descrittore del gruppo di gragrafi desiderato.

Restituisce

Promise<GraphGroup>

getMemberByDescriptor(string)

Questo endpoint restituisce un risultato per qualsiasi membro mai valido nel sistema, anche se il membro è stato eliminato o ha eliminato tutte le appartenenze. La validità corrente del membro viene indicata tramite la relativa proprietà disabilitata, che viene omessa quando false.

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

Parametri

memberDescriptor

string

Descrittore del membro desiderato.

Restituisce

Promise<GraphMember>

getMembership(string, string)

Ottenere una relazione di appartenenza tra un contenitore e un oggetto.

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

Parametri

subjectDescriptor

string

Descrittore dell'oggetto figlio nella relazione.

containerDescriptor

string

Descrittore del contenitore nella relazione.

Restituisce

Promise<GraphMembership>

getMembershipState(string)

Verificare se un oggetto è attivo o inattivo.

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

Parametri

subjectDescriptor

string

Descrittore dell'oggetto (utente, gruppo, ambito e così via) per controllare lo stato di

Restituisce

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parametri

userDescriptor

string

Restituisce

Promise<GraphProviderInfo>

getScope(string)

Ottenere un ambito identificato dal descrittore

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

Parametri

scopeDescriptor

string

Descrittore che identifica in modo univoco un ambito.

Restituisce

Promise<GraphScope>

getServicePrincipal(string)

Ottenere un'entità servizio dal descrittore.

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

Parametri

servicePrincipalDescriptor

string

Descrittore dell'entità servizio desiderata.

Restituisce

Promise<GraphServicePrincipal>

getStorageKey(string)

Risolvere un descrittore in una chiave di archiviazione.

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

Parametri

subjectDescriptor

string

Restituisce

Promise<GraphStorageKeyResult>

getSubject(string)

Risolvere un descrittore in un utente, un gruppo o un ambito.

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

Parametri

subjectDescriptor

string

Descrittore dell'oggetto desiderato.

Restituisce

Promise<GraphSubject>

getUser(string)

Ottenere un utente dal descrittore.

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

Parametri

userDescriptor

string

Descrittore dell'utente desiderato.

Restituisce

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Ottenere tutte le appartenenze in cui questo descrittore è un membro della relazione.

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

Parametri

subjectDescriptor

string

Recuperare tutte le appartenenze dirette di questo descrittore.

direction

GraphTraversalDirection

Impostazione predefinita su Up.

depth

number

Numero massimo di bordi da attraversare verso l'alto o verso il basso dell'albero di appartenenza. Attualmente l'unico valore supportato è '1'.

Restituisce

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Ottiene tutti i membri richiesti nell'ambito corrente (in genere l'organizzazione o l'account).

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

Parametri

memberLookup

GraphSubjectLookup

Restituisce

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Attraversare le appartenenze dei descrittori di soggetto specificati.

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

Parametri

membershipTraversalLookup

GraphSubjectLookup

Recuperare i discendenti/predecessori dell'elenco di descrittori a seconda della direzione.

direction

GraphTraversalDirection

Il valore predefinito è Unknown.

depth

number

il cui valore predefinito è 1.

Restituisce

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

lookupSubjects(GraphSubjectLookup)

Risolvere i descrittori agli utenti, ai gruppi o agli ambiti (Soggetti) in un batch.

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

Parametri

subjectLookup

GraphSubjectLookup

Elenco di descrittori che specifica un subset di soggetti da recuperare. Ogni descrittore identifica in modo univoco l'oggetto in tutti gli ambiti dell'istanza, ma solo in un singolo momento.

Restituisce

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

querySubjects(GraphSubjectQuery)

Search per gli utenti o/o i gruppi di Azure Devops. I risultati verranno restituiti in un batch senza più di 100 soggetti a grafo.

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

Parametri

subjectQuery

GraphSubjectQuery

La query che verrà usata per la ricerca include quanto segue: Query: termine di ricerca. La ricerca sarà solo prefisso corrispondente. SubjectKind: è possibile specificare "User" o "Group", entrambi o ScopeDescriptor: è possibile specificare un ambito non predefinito, ad esempio il descrittore dell'ambito del progetto.

Restituisce

Promise<GraphSubject[]>

removeMembership(string, string)

Elimina un'appartenenza tra un contenitore e un oggetto.

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

Parametri

subjectDescriptor

string

Descrittore a un gruppo o a un utente che è l'oggetto figlio nella relazione.

containerDescriptor

string

Descrittore a un gruppo che è il contenitore nella relazione.

Restituisce

Promise<void>

requestAccess(any)

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

Parametri

jsondocument

any

Restituisce

Promise<void>

resolve(IdentityMappings)

Eseguire il mapping di un elenco di utenti a nuovi utenti.

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

Parametri

mappings

IdentityMappings

Elenco di mapping.

Restituisce

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parametri

avatar

Avatar

subjectDescriptor

string

Restituisce

Promise<void>

translate(string, string)

Identity Translation: l'endpoint di traduzione delle identità deve essere usato dall'azione di ginevra.

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

Parametri

masterId

string

localId

string

Restituisce

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Attraversare le appartenenze del descrittore soggetto specificato.

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

Parametri

subjectDescriptor

string

Recuperare i discendenti/predecessori di questo descrittore a seconda della direzione.

direction

GraphTraversalDirection

Il valore predefinito è Unknown.

depth

number

il cui valore predefinito è 1.

Restituisce

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Aggiornare le proprietà di un gruppo Azure DevOps.

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

Parametri

groupDescriptor

string

Descrittore del gruppo da modificare.

patchDocument

JsonPatchDocument

Documento JSON+Patch contenente i campi da modificare.

Restituisce

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parametri

scopeDescriptor

string

patchDocument

JsonPatchDocument

Restituisce

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Eseguire il mapping di un'entità servizio esistente a un'entità servizio diversa.

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

Parametri

updateContext

GraphServicePrincipalUpdateContext

Subset dell'entità servizio grafico completo usata per trovare in modo univoco l'oggetto grafico in un provider esterno.

servicePrincipalDescriptor

string

Descrittore dell'entità servizio da aggiornare

Restituisce

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Eseguire il mapping di un utente esistente a un utente diverso.

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

Parametri

updateContext

GraphUserUpdateContext

Subset dell'utente completo del grafico usato per trovare in modo univoco l'oggetto grafico in un provider esterno.

userDescriptor

string

Descrittore dell'utente da aggiornare

Restituisce

Promise<GraphUser>