GraphRestClient class

new GraphRestClient(options: IVssRestClientOptions)

Parametri

static RESOURCE_AREA_ID: string

Valore della proprietà

Creare una nuova appartenenza tra un contenitore e un oggetto.

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

Parametri

Restituisce

Disabilita un'entità servizio.

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

Parametri

Restituisce

Disabilita un utente.

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

Parametri

Restituisce

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

Parametri

Restituisce

function getCachePolicies(): Promise<GraphCachePolicies>

Restituisce

Risolvere una chiave di archiviazione in un descrittore

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

Parametri

Restituisce

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

Restituisce

Ottenere un gruppo in base al descrittore.

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

Parametri

Restituisce

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

Restituisce

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

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

Parametri

Restituisce

Verificare se un oggetto è attivo o inattivo.

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

Parametri

Restituisce

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

Parametri

Restituisce

Ottenere un ambito identificato dal descrittore

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

Parametri

Restituisce

Ottenere un'entità servizio dal descrittore.

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

Parametri

Restituisce

Risolvere un descrittore in una chiave di archiviazione.

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

Parametri

Restituisce

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

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

Parametri

Restituisce

Ottenere un utente dal descrittore.

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

Restituisce

Attraversare le appartenenze dei descrittori di soggetto specificati.

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

Restituisce

Elimina un'appartenenza tra un contenitore e un oggetto.

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

Parametri

Restituisce

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

Parametri

Restituisce

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

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

Parametri

Restituisce

Attraversare le appartenenze del descrittore soggetto specificato.

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

Parametri

Restituisce

Aggiornare le proprietà di un gruppo Azure DevOps.

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

Parametri

Restituisce

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

Parametri

Restituisce

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

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

Parametri

Restituisce

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

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

Parametri

Restituisce