GraphRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

RestClientBase

Constructeurs

GraphRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

addMembership(string, string)	Créez une appartenance entre un conteneur et un objet.
checkMembershipExistence(string, string)	Vérifiez s’il existe une relation d’appartenance entre un conteneur et un objet.
createGroup(GraphGroupCreationContext, string, string[])	Créez un groupe Azure DevOps ou matérialisez un groupe AAD existant.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Matérialisez un principal de service AAD existant dans le compte ADO.
createUser(GraphUserCreationContext, string[])	Matérialisez un utilisateur AAD ou MSA existant dans le compte ADO.
deleteAvatar(string)
deleteGroup(string)	Supprime un groupe Azure DevOps de tous ses groupes parents.
deleteScope(string)
deleteServicePrincipal(string)	Désactive un principal de service.
deleteUser(string)	Désactive un utilisateur.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Résoudre une clé de stockage en descripteur
getFederatedProviderData(string, string, number)	Acquiert l’ensemble complet des données d’authentification du fournisseur fédéré disponibles pour le sujet du graphique et le nom du fournisseur donnés.
getGroup(string)	Obtenir un groupe par son descripteur.
getMemberByDescriptor(string)	Ce point de terminaison retourne un résultat pour tout membre qui a déjà été valide dans le système, même si le membre a été supprimé depuis ou si toutes ses appartenances ont été supprimées. La validité actuelle du membre est indiquée par sa propriété désactivée, qui est omise lorsque false.
getMembership(string, string)	Obtenir une relation d’appartenance entre un conteneur et un objet.
getMembershipState(string)	Vérifiez si un sujet est actif ou inactif.
getProviderInfo(string)
getScope(string)	Obtenir une étendue identifiée par son descripteur
getServicePrincipal(string)	Obtenir un principal de service par son descripteur.
getStorageKey(string)	Résoudre un descripteur en clé de stockage.
getSubject(string)	Résolvez un descripteur pour un utilisateur, un groupe ou une étendue.
getUser(string)	Obtenir un utilisateur par son descripteur.
listMemberships(string, GraphTraversalDirection, number)	Obtenez toutes les appartenances pour lesquelles ce descripteur est membre de la relation.
lookupMembers(GraphSubjectLookup)	Obtient tous les membres demandés dans l’étendue actuelle (généralement organization ou compte).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Parcourir les appartenances des descripteurs d’objet donnés.
lookupSubjects(GraphSubjectLookup)	Résolvez les descripteurs d’utilisateurs, de groupes ou d’étendues (sujets) dans un lot.
querySubjects(GraphSubjectQuery)	Recherche pour les utilisateurs ou/et groupes Azure Devops. Les résultats seront retournés dans un lot avec pas plus de 100 sujets graphiques.
removeMembership(string, string)	Supprime une appartenance entre un conteneur et un objet.
requestAccess(any)
resolve(IdentityMappings)	Batch-mapper une liste d’utilisateurs à de nouveaux utilisateurs.
setAvatar(Avatar, string)
translate(string, string)	Traduction d’identité : le point de terminaison de traduction est censé être utilisé par l’action geneva.
traverseMemberships(string, GraphTraversalDirection, number)	Parcourir les appartenances du descripteur d’objet donné.
updateGroup(string, JsonPatchDocument)	Mettez à jour les propriétés d’un groupe Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Mapper un principal de service existant à un autre principal de service.
updateUser(GraphUserUpdateContext, string)	Mapper un utilisateur existant à un autre utilisateur.

Détails du constructeur

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

addMembership(string, string)

Créez une appartenance entre un conteneur et un objet.

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

Paramètres

subjectDescriptor

string

Descripteur pour un groupe ou un utilisateur qui peut être le sujet enfant dans la relation.

containerDescriptor

string

Descripteur pour un groupe qui peut être le conteneur dans la relation.

Retours

Promise<GraphMembership>

checkMembershipExistence(string, string)

Vérifiez s’il existe une relation d’appartenance entre un conteneur et un objet.

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

Paramètres

subjectDescriptor

string

Groupe ou utilisateur qui est un sujet enfant de la relation.

containerDescriptor

string

Groupe qui est le conteneur dans la relation.

Retours

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Créez un groupe Azure DevOps ou matérialisez un groupe AAD existant.

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

Paramètres

creationContext

GraphGroupCreationContext

Sous-ensemble du groupe de graphiques complet utilisé pour rechercher de manière unique le sujet du graphe dans un fournisseur externe.

scopeDescriptor

string

Descripteur référençant l’étendue (collection, projet) dans laquelle le groupe doit être créé. S’il est omis, est créé dans l’étendue du compte ou du organization englobant. Valide uniquement pour les groupes VSTS.

groupDescriptors

string[]

Liste séparée par des virgules de descripteurs référençant les groupes que vous souhaitez joindre au groupe de graphiques

Retours

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Paramètres

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Retours

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Matérialisez un principal de service AAD existant dans le compte ADO.

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

Paramètres

creationContext

GraphServicePrincipalCreationContext

Sous-ensemble du principal de service de graphe complet utilisé pour rechercher de manière unique le sujet du graphe dans un fournisseur externe.

groupDescriptors

string[]

Liste séparée par des virgules de descripteurs de groupes que vous souhaitez joindre au principal du service graph

Retours

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Matérialisez un utilisateur AAD ou MSA existant dans le compte ADO.

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

Paramètres

creationContext

GraphUserCreationContext

Sous-ensemble de l’utilisateur de graphe complet utilisé pour rechercher de manière unique le sujet du graphique dans un fournisseur externe.

groupDescriptors

string[]

Liste séparée par des virgules de descripteurs de groupes que l’utilisateur du graphique doit rejoindre

Retours

Promise<GraphUser>

deleteAvatar(string)

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

Paramètres

subjectDescriptor

string

Retours

Promise<void>

deleteGroup(string)

Supprime un groupe Azure DevOps de tous ses groupes parents.

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

Paramètres

groupDescriptor

string

Descripteur du groupe à supprimer.

Retours

Promise<void>

deleteScope(string)

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

Paramètres

scopeDescriptor

string

Retours

Promise<void>

deleteServicePrincipal(string)

Désactive un principal de service.

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

Paramètres

servicePrincipalDescriptor

string

Descripteur du principal de service à supprimer.

Retours

Promise<void>

deleteUser(string)

Désactive un utilisateur.

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

Paramètres

userDescriptor

string

Descripteur de l’utilisateur à supprimer.

Retours

Promise<void>

getAvatar(string, AvatarSize, string)

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

Paramètres

subjectDescriptor

string

size

AvatarSize

format

string

Retours

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Retours

Promise<GraphCachePolicies>

getDescriptor(string)

Résoudre une clé de stockage en descripteur

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

Paramètres

storageKey

string

Clé de stockage du sujet (utilisateur, groupe, étendue, etc.) à résoudre

Retours

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Acquiert l’ensemble complet des données d’authentification du fournisseur fédéré disponibles pour le sujet du graphique et le nom du fournisseur donnés.

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

Paramètres

subjectDescriptor

string

le descripteur du sujet de graphe que nous devrions acquérir des données pour

providerName

string

nom du fournisseur pour lequel acquérir des données, par exemple « github.com »

versionHint

number

un indicateur de version qui peut être utilisé pour la concurrence du cache optimiste et pour prendre en charge les nouvelles tentatives en cas d’échecs de jeton d’accès ; notez qu’il s’agit d’un indicateur uniquement et ne garantit pas une version particulière sur la réponse

Retours

Promise<GraphFederatedProviderData>

getGroup(string)

Obtenir un groupe par son descripteur.

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

Paramètres

groupDescriptor

string

Descripteur du groupe de graphiques souhaité.

Retours

Promise<GraphGroup>

getMemberByDescriptor(string)

Ce point de terminaison retourne un résultat pour tout membre qui a déjà été valide dans le système, même si le membre a été supprimé depuis ou si toutes ses appartenances ont été supprimées. La validité actuelle du membre est indiquée par sa propriété désactivée, qui est omise lorsque false.

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

Paramètres

memberDescriptor

string

Descripteur du membre souhaité.

Retours

Promise<GraphMember>

getMembership(string, string)

Obtenir une relation d’appartenance entre un conteneur et un objet.

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

Paramètres

subjectDescriptor

string

Descripteur pour le sujet enfant dans la relation.

containerDescriptor

string

Descripteur du conteneur dans la relation.

Retours

Promise<GraphMembership>

getMembershipState(string)

Vérifiez si un sujet est actif ou inactif.

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

Paramètres

subjectDescriptor

string

Descripteur du sujet (utilisateur, groupe, étendue, etc.) pour case activée’état de

Retours

Promise<GraphMembershipState>

getProviderInfo(string)

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

Paramètres

userDescriptor

string

Retours

Promise<GraphProviderInfo>

getScope(string)

Obtenir une étendue identifiée par son descripteur

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

Paramètres

scopeDescriptor

string

Descripteur qui identifie de manière unique une étendue.

Retours

Promise<GraphScope>

getServicePrincipal(string)

Obtenir un principal de service par son descripteur.

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

Paramètres

servicePrincipalDescriptor

string

Descripteur du principal de service souhaité.

Retours

Promise<GraphServicePrincipal>

getStorageKey(string)

Résoudre un descripteur en clé de stockage.

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

Paramètres

subjectDescriptor

string

Retours

Promise<GraphStorageKeyResult>

getSubject(string)

Résolvez un descripteur pour un utilisateur, un groupe ou une étendue.

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

Paramètres

subjectDescriptor

string

Descripteur du sujet souhaité.

Retours

Promise<GraphSubject>

getUser(string)

Obtenir un utilisateur par son descripteur.

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

Paramètres

userDescriptor

string

Descripteur de l’utilisateur souhaité.

Retours

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Obtenez toutes les appartenances pour lesquelles ce descripteur est membre de la relation.

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

Paramètres

subjectDescriptor

string

Récupérez toutes les appartenances directes de ce descripteur.

direction

GraphTraversalDirection

La valeur par défaut est Up.

depth

number

Nombre maximal d’arêtes à parcourir vers le haut ou vers le bas de l’arborescence d’appartenance. Actuellement, la seule valeur prise en charge est « 1 ».

Retours

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Obtient tous les membres demandés dans l’étendue actuelle (généralement organization ou compte).

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

Paramètres

memberLookup

GraphSubjectLookup

Retours

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Parcourir les appartenances des descripteurs d’objet donnés.

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

Paramètres

membershipTraversalLookup

GraphSubjectLookup

Récupérez les descendants/ancêtres de la liste des descripteurs en fonction de la direction.

direction

GraphTraversalDirection

La valeur par défaut est Unknown.

depth

number

La valeur par défaut est « 1 ».

Retours

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

lookupSubjects(GraphSubjectLookup)

Résolvez les descripteurs d’utilisateurs, de groupes ou d’étendues (sujets) dans un lot.

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

Paramètres

subjectLookup

GraphSubjectLookup

Liste de descripteurs qui spécifie un sous-ensemble de sujets à récupérer. Chaque descripteur identifie de manière unique le sujet dans toutes les étendues instance, mais seulement à un seul moment dans le temps.

Retours

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

querySubjects(GraphSubjectQuery)

Recherche pour les utilisateurs ou/et groupes Azure Devops. Les résultats seront retournés dans un lot avec pas plus de 100 sujets graphiques.

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

Paramètres

subjectQuery

GraphSubjectQuery

La requête que nous allons utiliser pour effectuer la recherche comprend les éléments suivants : Requête : le terme de recherche. La recherche correspond uniquement au préfixe. SubjectKind : « User » ou « Group » peuvent être spécifiés, les deux ou scopeDescriptor : une étendue non par défaut peut être spécifiée, c’est-à-dire le descripteur d’étendue du projet

Retours

Promise<GraphSubject[]>

removeMembership(string, string)

Supprime une appartenance entre un conteneur et un objet.

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

Paramètres

subjectDescriptor

string

Descripteur pour un groupe ou un utilisateur qui est le sujet enfant dans la relation.

containerDescriptor

string

Descripteur pour un groupe qui est le conteneur dans la relation.

Retours

Promise<void>

requestAccess(any)

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

Paramètres

jsondocument

any

Retours

Promise<void>

resolve(IdentityMappings)

Batch-mapper une liste d’utilisateurs à de nouveaux utilisateurs.

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

Paramètres

mappings

IdentityMappings

Liste de mappages.

Retours

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Paramètres

avatar

Avatar

subjectDescriptor

string

Retours

Promise<void>

translate(string, string)

Traduction d’identité : le point de terminaison de traduction est censé être utilisé par l’action geneva.

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

Paramètres

masterId

string

localId

string

Retours

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Parcourir les appartenances du descripteur d’objet donné.

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

Paramètres

subjectDescriptor

string

Récupérez les descendants/ancêtres de ce descripteur en fonction de la direction.

direction

GraphTraversalDirection

La valeur par défaut est Unknown.

depth

number

La valeur par défaut est « 1 ».

Retours

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Mettez à jour les propriétés d’un groupe Azure DevOps.

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

Paramètres

groupDescriptor

string

Descripteur du groupe à modifier.

patchDocument

JsonPatchDocument

Document JSON+Patch contenant les champs à modifier.

Retours

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Paramètres

scopeDescriptor

string

patchDocument

JsonPatchDocument

Retours

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Mapper un principal de service existant à un autre principal de service.

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

Paramètres

updateContext

GraphServicePrincipalUpdateContext

Sous-ensemble du principal de service de graphe complet utilisé pour rechercher de manière unique le sujet du graphe dans un fournisseur externe.

servicePrincipalDescriptor

string

Descripteur du principal de service à mettre à jour

Retours

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Mapper un utilisateur existant à un autre utilisateur.

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

Paramètres

updateContext

GraphUserUpdateContext

Sous-ensemble de l’utilisateur de graphe complet utilisé pour rechercher de manière unique le sujet du graphique dans un fournisseur externe.

userDescriptor

string

Descripteur de l’utilisateur à mettre à jour

Retours

Promise<GraphUser>