GraphRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

GraphRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

addMembership(string, string)	Cree una nueva pertenencia entre un contenedor y un asunto.
checkMembershipExistence(string, string)	Compruebe si existe una relación de pertenencia entre un contenedor y un asunto.
createGroup(GraphGroupCreationContext, string, string[])	Cree un nuevo grupo de Azure DevOps o materialice un grupo de AAD existente.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialice una entidad de servicio de AAD existente en la cuenta de ADO.
createUser(GraphUserCreationContext, string[])	Materialice un usuario de AAD o MSA existente en la cuenta de ADO.
deleteAvatar(string)
deleteGroup(string)	Quita un grupo de Azure DevOps de todos sus grupos primarios.
deleteScope(string)
deleteServicePrincipal(string)	Deshabilita una entidad de servicio.
deleteUser(string)	Deshabilita un usuario.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Resolución de una clave de almacenamiento en un descriptor
getFederatedProviderData(string, string, number)	Adquiere el conjunto completo de datos de autenticación del proveedor federado disponibles para el sujeto y el nombre del proveedor del grafo especificados.
getGroup(string)	Obtiene un grupo por su descriptor.
getMemberByDescriptor(string)	Este punto de conexión devuelve un resultado para cualquier miembro que haya sido válido en el sistema, incluso si el miembro se ha eliminado desde entonces o ha eliminado todas sus pertenencias. La validez actual del miembro se indica a través de su propiedad deshabilitada, que se omite cuando es false.
getMembership(string, string)	Obtiene una relación de pertenencia entre un contenedor y un asunto.
getMembershipState(string)	Compruebe si un sujeto está activo o inactivo.
getProviderInfo(string)
getScope(string)	Obtención de un ámbito identificado por su descriptor
getServicePrincipal(string)	Obtenga una entidad de servicio por su descriptor.
getStorageKey(string)	Resuelva un descriptor en una clave de almacenamiento.
getSubject(string)	Resuelva un descriptor en un usuario, grupo o ámbito.
getUser(string)	Obtenga un usuario por su descriptor.
listMemberships(string, GraphTraversalDirection, number)	Obtenga todas las pertenencias en las que este descriptor es miembro de la relación.
lookupMembers(GraphSubjectLookup)	Obtiene todos los miembros solicitados en el ámbito actual (normalmente organización o cuenta).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Atraviesa las pertenencias de los descriptores de asunto especificados.
lookupSubjects(GraphSubjectLookup)	Resuelva descriptores para usuarios, grupos o ámbitos (Sujetos) en un lote.
querySubjects(GraphSubjectQuery)	Búsqueda para usuarios o grupos de Azure Devops. Los resultados se devolverán en un lote sin más de 100 temas de grafos.
removeMembership(string, string)	Elimina una pertenencia entre un contenedor y un asunto.
requestAccess(any)
resolve(IdentityMappings)	Asignar por lotes una lista de usuarios a nuevos usuarios.
setAvatar(Avatar, string)
translate(string, string)	Traducción de identidades: se supone que la acción de Ginebra usará el punto de conexión de traducción de identidades.
traverseMemberships(string, GraphTraversalDirection, number)	Atraviesa las pertenencias del descriptor de asunto especificado.
updateGroup(string, JsonPatchDocument)	Actualice las propiedades de un grupo de Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Asigne una entidad de servicio existente a otra entidad de servicio.
updateUser(GraphUserUpdateContext, string)	Asigne un usuario existente a otro usuario.

Detalles del constructor

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

addMembership(string, string)

Cree una nueva pertenencia entre un contenedor y un asunto.

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

Parámetros

subjectDescriptor

string

Descriptor de un grupo o usuario que puede ser el sujeto secundario de la relación.

containerDescriptor

string

Descriptor de un grupo que puede ser el contenedor de la relación.

Devoluciones

Promise<GraphMembership>

checkMembershipExistence(string, string)

Compruebe si existe una relación de pertenencia entre un contenedor y un asunto.

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

Parámetros

subjectDescriptor

string

Grupo o usuario que es un sujeto secundario de la relación.

containerDescriptor

string

Grupo que es el contenedor de la relación.

Devoluciones

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Cree un nuevo grupo de Azure DevOps o materialice un grupo de AAD existente.

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

Parámetros

creationContext

GraphGroupCreationContext

Subconjunto del grupo de grafos completo que se usa para buscar de forma única el asunto del grafo en un proveedor externo.

scopeDescriptor

string

Descriptor que hace referencia al ámbito (colección, proyecto) en el que se debe crear el grupo. Si se omite, se creará en el ámbito de la cuenta o organización envolventes. Válido solo para grupos de VSTS.

groupDescriptors

string[]

Una lista separada por comas de descriptores que hacen referencia a grupos que quiere que el grupo de grafos se una

Devoluciones

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parámetros

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Devoluciones

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materialice una entidad de servicio de AAD existente en la cuenta de ADO.

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

Parámetros

creationContext

GraphServicePrincipalCreationContext

Subconjunto de la entidad de servicio de grafos completa que se usa para buscar de forma única el asunto del grafo en un proveedor externo.

groupDescriptors

string[]

Una lista separada por comas de descriptores de grupos a los que desea que se una la entidad de servicio del grafo.

Devoluciones

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materialice un usuario de AAD o MSA existente en la cuenta de ADO.

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

Parámetros

creationContext

GraphUserCreationContext

Subconjunto del usuario de grafo completo que se usa para buscar de forma única el asunto del grafo en un proveedor externo.

groupDescriptors

string[]

Una lista separada por comas de descriptores de grupos que desea que el usuario del grafo se una

Devoluciones

Promise<GraphUser>

deleteAvatar(string)

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

Parámetros

subjectDescriptor

string

Devoluciones

Promise<void>

deleteGroup(string)

Quita un grupo de Azure DevOps de todos sus grupos primarios.

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

Parámetros

groupDescriptor

string

Descriptor del grupo que se va a eliminar.

Devoluciones

Promise<void>

deleteScope(string)

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

Parámetros

scopeDescriptor

string

Devoluciones

Promise<void>

deleteServicePrincipal(string)

Deshabilita una entidad de servicio.

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

Parámetros

servicePrincipalDescriptor

string

Descriptor de la entidad de servicio que se va a eliminar.

Devoluciones

Promise<void>

deleteUser(string)

Deshabilita un usuario.

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

Parámetros

userDescriptor

string

Descriptor del usuario que se va a eliminar.

Devoluciones

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parámetros

subjectDescriptor

string

size

AvatarSize

format

string

Devoluciones

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Devoluciones

Promise<GraphCachePolicies>

getDescriptor(string)

Resolución de una clave de almacenamiento en un descriptor

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

Parámetros

storageKey

string

Clave de almacenamiento del asunto (usuario, grupo, ámbito, etc.) para resolver

Devoluciones

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Adquiere el conjunto completo de datos de autenticación del proveedor federado disponibles para el sujeto y el nombre del proveedor del grafo especificados.

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

Parámetros

subjectDescriptor

string

descriptor del asunto del grafo para el que debemos adquirir datos

providerName

string

el nombre del proveedor para el que se van a adquirir datos, por ejemplo, "github.com"

versionHint

number

una sugerencia de versión que se puede usar para la simultaneidad de caché optimista y para admitir reintentos en errores de token de acceso; tenga en cuenta que se trata de una sugerencia solo y no garantiza una versión determinada en la respuesta.

Devoluciones

Promise<GraphFederatedProviderData>

getGroup(string)

Obtiene un grupo por su descriptor.

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

Parámetros

groupDescriptor

string

Descriptor del grupo de grafos deseado.

Devoluciones

Promise<GraphGroup>

getMemberByDescriptor(string)

Este punto de conexión devuelve un resultado para cualquier miembro que haya sido válido en el sistema, incluso si el miembro se ha eliminado desde entonces o ha eliminado todas sus pertenencias. La validez actual del miembro se indica a través de su propiedad deshabilitada, que se omite cuando es false.

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

Parámetros

memberDescriptor

string

Descriptor del miembro deseado.

Devoluciones

Promise<GraphMember>

getMembership(string, string)

Obtiene una relación de pertenencia entre un contenedor y un asunto.

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

Parámetros

subjectDescriptor

string

Descriptor para el sujeto secundario de la relación.

containerDescriptor

string

Descriptor para el contenedor de la relación.

Devoluciones

Promise<GraphMembership>

getMembershipState(string)

Compruebe si un sujeto está activo o inactivo.

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

Parámetros

subjectDescriptor

string

Descriptor del asunto (usuario, grupo, ámbito, etc.) para comprobar el estado de

Devoluciones

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parámetros

userDescriptor

string

Devoluciones

Promise<GraphProviderInfo>

getScope(string)

Obtención de un ámbito identificado por su descriptor

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

Parámetros

scopeDescriptor

string

Descriptor que identifica de forma única un ámbito.

Devoluciones

Promise<GraphScope>

getServicePrincipal(string)

Obtenga una entidad de servicio por su descriptor.

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

Parámetros

servicePrincipalDescriptor

string

Descriptor de la entidad de servicio deseada.

Devoluciones

Promise<GraphServicePrincipal>

getStorageKey(string)

Resuelva un descriptor en una clave de almacenamiento.

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

Parámetros

subjectDescriptor

string

Devoluciones

Promise<GraphStorageKeyResult>

getSubject(string)

Resuelva un descriptor en un usuario, grupo o ámbito.

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

Parámetros

subjectDescriptor

string

Descriptor del asunto deseado.

Devoluciones

Promise<GraphSubject>

getUser(string)

Obtenga un usuario por su descriptor.

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

Parámetros

userDescriptor

string

Descriptor del usuario deseado.

Devoluciones

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Obtenga todas las pertenencias en las que este descriptor es miembro de la relación.

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

Parámetros

subjectDescriptor

string

Capture todas las pertenencias directas de este descriptor.

direction

GraphTraversalDirection

El valor predeterminado es Up (Arriba).

depth

number

Número máximo de bordes que recorrer hacia arriba o hacia abajo el árbol de pertenencia. Actualmente, el único valor admitido es "1".

Devoluciones

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Obtiene todos los miembros solicitados en el ámbito actual (normalmente organización o cuenta).

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

Parámetros

memberLookup

GraphSubjectLookup

Devoluciones

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Atraviesa las pertenencias de los descriptores de asunto especificados.

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

Parámetros

membershipTraversalLookup

GraphSubjectLookup

Capture los descendientes o antecesores de la lista de descriptores en función de la dirección.

direction

GraphTraversalDirection

El valor predeterminado es Desconocido.

depth

number

El valor predeterminado es 1.

Devoluciones

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

lookupSubjects(GraphSubjectLookup)

Resuelva descriptores para usuarios, grupos o ámbitos (Sujetos) en un lote.

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

Parámetros

subjectLookup

GraphSubjectLookup

Lista de descriptores que especifica un subconjunto de temas que se van a recuperar. Cada descriptor identifica de forma única el asunto en todos los ámbitos de instancia, pero solo en un único momento dado.

Devoluciones

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

querySubjects(GraphSubjectQuery)

Búsqueda para usuarios o grupos de Azure Devops. Los resultados se devolverán en un lote sin más de 100 temas de grafos.

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

Parámetros

subjectQuery

GraphSubjectQuery

La consulta que usaremos para buscar incluye lo siguiente: Consulta: el término de búsqueda. La búsqueda solo será un prefijo que coincida. SubjectKind: se puede especificar "User" o "Group", ambos o scopeDescriptor: se puede especificar un ámbito no predeterminado, es decir, descriptor de ámbito de proyecto.

Devoluciones

Promise<GraphSubject[]>

removeMembership(string, string)

Elimina una pertenencia entre un contenedor y un asunto.

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

Parámetros

subjectDescriptor

string

Descriptor de un grupo o usuario que es el sujeto secundario de la relación.

containerDescriptor

string

Descriptor de un grupo que es el contenedor de la relación.

Devoluciones

Promise<void>

requestAccess(any)

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

Parámetros

jsondocument

any

Devoluciones

Promise<void>

resolve(IdentityMappings)

Asignar por lotes una lista de usuarios a nuevos usuarios.

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

Parámetros

mappings

IdentityMappings

Lista de asignaciones.

Devoluciones

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parámetros

avatar

Avatar

subjectDescriptor

string

Devoluciones

Promise<void>

translate(string, string)

Traducción de identidades: se supone que la acción de Ginebra usará el punto de conexión de traducción de identidades.

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

Parámetros

masterId

string

localId

string

Devoluciones

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Atraviesa las pertenencias del descriptor de asunto especificado.

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

Parámetros

subjectDescriptor

string

Capture los descendientes o antecesores de este descriptor en función de la dirección.

direction

GraphTraversalDirection

El valor predeterminado es Desconocido.

depth

number

El valor predeterminado es 1.

Devoluciones

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Actualice las propiedades de un grupo de Azure DevOps.

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

Parámetros

groupDescriptor

string

Descriptor del grupo que se va a modificar.

patchDocument

JsonPatchDocument

Documento JSON+Patch que contiene los campos que se van a modificar.

Devoluciones

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parámetros

scopeDescriptor

string

patchDocument

JsonPatchDocument

Devoluciones

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Asigne una entidad de servicio existente a otra entidad de servicio.

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

Parámetros

updateContext

GraphServicePrincipalUpdateContext

Subconjunto de la entidad de servicio de grafos completa que se usa para buscar de forma única el asunto del grafo en un proveedor externo.

servicePrincipalDescriptor

string

Descriptor de la entidad de servicio que se va a actualizar.

Devoluciones

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Asigne un usuario existente a otro usuario.

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

Parámetros

updateContext

GraphUserUpdateContext

Subconjunto del usuario de grafo completo que se usa para buscar de forma única el asunto del grafo en un proveedor externo.

userDescriptor

string

Descriptor del usuario que se va a actualizar

Devoluciones

Promise<GraphUser>