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 sujeto.
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 existente de AAD o MSA 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)	Resolver una clave de almacenamiento en un descriptor
getFederatedProviderData(string, string, number)	Adquiere el conjunto completo de datos de autenticación de proveedor federado disponibles para el asunto del gráfico y el nombre del proveedor especificados.
getGroup(string)	Obtener un grupo por su descriptor.
getMemberByDescriptor(string)	Este extremo devuelve un resultado para cualquier miembro que haya sido válido en el sistema, incluso si el miembro se ha eliminado desde entonces o si se han eliminado todas sus pertenencias. La validez actual del miembro se indica a través de su propiedad disabled, que se omite cuando es false.
getMembership(string, string)	Obtener 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)	Obtener un ámbito identificado por su descriptor
getServicePrincipal(string)	Obtenga una entidad de servicio por su descriptor.
getStorageKey(string)	Resolver un descriptor en una clave de almacenamiento.
getSubject(string)	Resolver un descriptor en un usuario, grupo o ámbito.
getUser(string)	Obtener un usuario por su descriptor.
listMemberships(string, GraphTraversalDirection, number)	Obtenga todas las membresías 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)	Recorrer las pertenencias de los descriptores de materia dados.
lookupSubjects(GraphSubjectLookup)	Resuelva descriptores a usuarios, grupos o ámbitos (Asuntos) en un lote.
querySubjects(GraphSubjectQuery)	Busque usuarios o grupos de Azure DevOps. Los resultados se devolverán en un lote con no más de 100 temas gráficos.
removeMembership(string, string)	Elimina una pertenencia entre un contenedor y un asunto.
requestAccess(any)
resolve(IdentityMappings)	Asigne por lotes una lista de usuarios a nuevos usuarios.
setAvatar(Avatar, string)
translate(string, string)	Traducción de identidad: se supone que el punto final de traducción debe ser utilizado por la acción de Ginebra.
traverseMemberships(string, GraphTraversalDirection, number)	Recorrer las membresías del descriptor de sujeto dado.
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 una entidad de servicio diferente.
updateUser(GraphUserUpdateContext, string)	Asigne un usuario existente a un usuario diferente.

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 sujeto.

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

Parámetros

subjectDescriptor

string

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

containerDescriptor

string

El 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

El subconjunto del grupo de gráficos completo que se usa para buscar de forma única el asunto del gráfico en un proveedor externo.

scopeDescriptor

string

Un 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 u organización adjunta. Válido solo para grupos VSTS.

groupDescriptors

string[]

Una lista separada por comas de descriptores que hacen referencia a los grupos que desea que el grupo de gráficos 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 gráficos completa que se usa para buscar de forma única el asunto del gráfico en un proveedor externo.

groupDescriptors

string[]

Una lista separada por comas de los descriptores de los grupos a los que desea que se una la entidad de servicio de gráficos

Devoluciones

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

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

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

Parámetros

creationContext

GraphUserCreationContext

El subconjunto del usuario del gráfico completo que se usa para buscar de forma única el asunto del gráfico en un proveedor externo.

groupDescriptors

string[]

Una lista separada por comas de descriptores de grupos a los que desea que se una el usuario del gráfico

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

El 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

El 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)

Resolver 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.) a resolver

Devoluciones

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Adquiere el conjunto completo de datos de autenticación de proveedor federado disponibles para el asunto del gráfico y el nombre del proveedor especificados.

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

Parámetros

subjectDescriptor

string

el descriptor del tema gráfico para el que debemos adquirir datos

providerName

string

el nombre del proveedor para el que se adquieren los 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 esto es solo una sugerencia y no garantiza una versión particular en la respuesta

Devoluciones

Promise<GraphFederatedProviderData>

getGroup(string)

Obtener un grupo por su descriptor.

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

Parámetros

groupDescriptor

string

El descriptor del grupo de grafos deseado.

Devoluciones

Promise<GraphGroup>

getMemberByDescriptor(string)

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

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

Parámetros

memberDescriptor

string

El descriptor del miembro deseado.

Devoluciones

Promise<GraphMember>

getMembership(string, string)

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

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

Parámetros

subjectDescriptor

string

Un descriptor para el sujeto secundario en la relación.

containerDescriptor

string

Descriptor del 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 tema (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)

Obtener 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)

Resolver un descriptor en una clave de almacenamiento.

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

Parámetros

subjectDescriptor

string

Devoluciones

Promise<GraphStorageKeyResult>

getSubject(string)

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

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

Parámetros

subjectDescriptor

string

El descriptor del tema deseado.

Devoluciones

Promise<GraphSubject>

getUser(string)

Obtener un usuario por su descriptor.

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

Parámetros

userDescriptor

string

El descriptor del usuario deseado.

Devoluciones

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Obtenga todas las membresías 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 Arriba.

depth

number

El número máximo de bordes que se van a recorrer hacia arriba o hacia abajo en 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)

Recorrer las pertenencias de los descriptores de materia dados.

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

Parámetros

membershipTraversalLookup

GraphSubjectLookup

Obtener los descendientes/antepasados de la lista de descriptores según 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 a usuarios, grupos o ámbitos (Asuntos) en un lote.

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

Parámetros

subjectLookup

GraphSubjectLookup

Una lista de descriptores que especifica un subconjunto de temas que se van a recuperar. Cada descriptor identifica de forma única el sujeto en todos los ámbitos de instancia, pero solo en un único punto en el tiempo.

Devoluciones

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

querySubjects(GraphSubjectQuery)

Busque usuarios o grupos de Azure DevOps. Los resultados se devolverán en un lote con no más de 100 temas gráficos.

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 coincidirá con prefijos. SubjectKind: Se puede especificar "User" o "Group", ambos o cualquiera ScopeDescriptor: Se puede especificar un alcance no predeterminado, es decir, un descriptor de alcance del 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)

Asigne por lotes una lista de usuarios a nuevos usuarios.

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

Parámetros

mappings

IdentityMappings

Una 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 identidad: se supone que el punto final de traducción debe ser utilizado por la acción de Ginebra.

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

Parámetros

masterId

string

localId

string

Devoluciones

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Recorrer las membresías del descriptor de sujeto dado.

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

Parámetros

subjectDescriptor

string

Busque los descendientes / antepasados de este descriptor según 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

El descriptor del grupo que se va a modificar.

patchDocument

JsonPatchDocument

El 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 una entidad de servicio diferente.

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

Parámetros

updateContext

GraphServicePrincipalUpdateContext

Subconjunto de la entidad de servicio de gráficos completa que se usa para buscar de forma única el asunto del gráfico 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 un usuario diferente.

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

Parámetros

updateContext

GraphUserUpdateContext

El subconjunto del usuario del gráfico completo que se usa para buscar de forma única el asunto del gráfico en un proveedor externo.

userDescriptor

string

El descriptor del usuario que se va a actualizar

Devoluciones

Promise<GraphUser>