GraphRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

RestClientBase

Construtores

GraphRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addMembership(string, string)	Crie uma nova associação entre um contêiner e um assunto.
checkMembershipExistence(string, string)	Verifique se existe uma relação de associação entre um contêiner e um assunto.
createGroup(GraphGroupCreationContext, string, string[])	Crie um novo grupo do Azure DevOps ou materialize um grupo existente do AAD.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialize uma entidade de serviço do AAD existente na conta do ADO.
createUser(GraphUserCreationContext, string[])	Materialize um usuário existente do AAD ou msa na conta do ADO.
deleteAvatar(string)
deleteGroup(string)	Remove um grupo do Azure DevOps de todos os seus grupos pai.
deleteScope(string)
deleteServicePrincipal(string)	Desabilita uma entidade de serviço.
deleteUser(string)	Desabilita um usuário.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Resolver uma chave de armazenamento para um descritor
getFederatedProviderData(string, string, number)	Adquire o conjunto completo de dados de autenticação de provedor federados disponíveis para o assunto do grafo e o nome do provedor fornecidos.
getGroup(string)	Obtenha um grupo por seu descritor.
getMemberByDescriptor(string)	Esse ponto de extremidade retorna um resultado para qualquer membro que já foi válido no sistema, mesmo que o membro tenha sido excluído ou tenha todas as suas associações excluídas. A validade atual do membro é indicada por meio de sua propriedade desabilitada, que é omitida quando false.
getMembership(string, string)	Obtenha uma relação de associação entre um contêiner e um assunto.
getMembershipState(string)	Verifique se um assunto está ativo ou inativo.
getProviderInfo(string)
getScope(string)	Obter um escopo identificado por seu descritor
getServicePrincipal(string)	Obtenha uma entidade de serviço por seu descritor.
getStorageKey(string)	Resolva um descritor para uma chave de armazenamento.
getSubject(string)	Resolva um descritor para um usuário, grupo ou escopo.
getUser(string)	Obtenha um usuário por seu descritor.
listMemberships(string, GraphTraversalDirection, number)	Obtenha todas as associações em que esse descritor é um membro na relação.
lookupMembers(GraphSubjectLookup)	Obtém todos os membros solicitados no escopo atual (geralmente organização ou conta).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Percorra as associações dos descritores de assunto especificados.
lookupSubjects(GraphSubjectLookup)	Resolva descritores para usuários, grupos ou escopos (Entidades) em um lote.
querySubjects(GraphSubjectQuery)	Pesquisa para usuários do Azure Devops ou/e grupos. Os resultados serão retornados em um lote com no máximo 100 entidades de grafo.
removeMembership(string, string)	Exclui uma associação entre um contêiner e um assunto.
requestAccess(any)
resolve(IdentityMappings)	Mapeie em lote uma lista de usuários para novos usuários.
setAvatar(Avatar, string)
translate(string, string)	Tradução de Identidade – o ponto de extremidade de tradução deve ser usado pela ação geneva.
traverseMemberships(string, GraphTraversalDirection, number)	Percorra associações do descritor de assunto especificado.
updateGroup(string, JsonPatchDocument)	Atualize as propriedades de um grupo do Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Mapeie uma entidade de serviço existente para uma entidade de serviço diferente.
updateUser(GraphUserUpdateContext, string)	Mapeie um usuário existente para um usuário diferente.

Detalhes do construtor

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

addMembership(string, string)

Crie uma nova associação entre um contêiner e um assunto.

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

Parâmetros

subjectDescriptor

string

Um descritor para um grupo ou usuário que pode ser o assunto filho na relação.

containerDescriptor

string

Um descritor para um grupo que pode ser o contêiner na relação.

Retornos

Promise<GraphMembership>

checkMembershipExistence(string, string)

Verifique se existe uma relação de associação entre um contêiner e um assunto.

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

Parâmetros

subjectDescriptor

string

O grupo ou usuário que é um assunto filho da relação.

containerDescriptor

string

O grupo que é o contêiner na relação.

Retornos

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Crie um novo grupo do Azure DevOps ou materialize um grupo existente do AAD.

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

Parâmetros

creationContext

GraphGroupCreationContext

O subconjunto do grupo de grafo completo usado para localizar exclusivamente o assunto do grafo em um provedor externo.

scopeDescriptor

string

Um descritor que faz referência ao escopo (coleção, projeto) no qual o grupo deve ser criado. Se omitido, será criado no escopo da conta ou organização delimitador. Válido somente para grupos VSTS.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores que fazem referência a grupos que você deseja que o grupo de grafos ingresse

Retornos

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parâmetros

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Retornos

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materialize uma entidade de serviço do AAD existente na conta do ADO.

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

Parâmetros

creationContext

GraphServicePrincipalCreationContext

O subconjunto da entidade de serviço de grafo completa usada para localizar exclusivamente o assunto do grafo em um provedor externo.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores de grupos que você deseja que a entidade de serviço de grafo ingresse

Retornos

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materialize um usuário existente do AAD ou msa na conta do ADO.

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

Parâmetros

creationContext

GraphUserCreationContext

O subconjunto do usuário de grafo completo usado para localizar exclusivamente o assunto do grafo em um provedor externo.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores de grupos que você deseja que o usuário do grafo ingresse

Retornos

Promise<GraphUser>

deleteAvatar(string)

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

Parâmetros

subjectDescriptor

string

Retornos

Promise<void>

deleteGroup(string)

Remove um grupo do Azure DevOps de todos os seus grupos pai.

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

Parâmetros

groupDescriptor

string

O descritor do grupo a ser excluído.

Retornos

Promise<void>

deleteScope(string)

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

Parâmetros

scopeDescriptor

string

Retornos

Promise<void>

deleteServicePrincipal(string)

Desabilita uma entidade de serviço.

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

Parâmetros

servicePrincipalDescriptor

string

O descritor da entidade de serviço a ser excluída.

Retornos

Promise<void>

deleteUser(string)

Desabilita um usuário.

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

Parâmetros

userDescriptor

string

O descritor do usuário a ser excluído.

Retornos

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parâmetros

subjectDescriptor

string

size

AvatarSize

format

string

Retornos

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Retornos

Promise<GraphCachePolicies>

getDescriptor(string)

Resolver uma chave de armazenamento para um descritor

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

Parâmetros

storageKey

string

Chave de armazenamento do assunto (usuário, grupo, escopo etc.) para resolve

Retornos

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Adquire o conjunto completo de dados de autenticação de provedor federados disponíveis para o assunto do grafo e o nome do provedor fornecidos.

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

Parâmetros

subjectDescriptor

string

o descritor do assunto do grafo para o qual devemos adquirir dados

providerName

string

o nome do provedor para o qual adquirir dados, por exemplo, "github.com"

versionHint

number

uma dica de versão que pode ser usada para simultaneidade de cache otimista e para dar suporte a novas tentativas em falhas de token de acesso; observe que essa é apenas uma dica e não garante uma versão específica na resposta

Retornos

Promise<GraphFederatedProviderData>

getGroup(string)

Obtenha um grupo por seu descritor.

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

Parâmetros

groupDescriptor

string

O descritor do grupo de grafos desejado.

Retornos

Promise<GraphGroup>

getMemberByDescriptor(string)

Esse ponto de extremidade retorna um resultado para qualquer membro que já foi válido no sistema, mesmo que o membro tenha sido excluído ou tenha todas as suas associações excluídas. A validade atual do membro é indicada por meio de sua propriedade desabilitada, que é omitida quando false.

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

Parâmetros

memberDescriptor

string

O descritor do membro desejado.

Retornos

Promise<GraphMember>

getMembership(string, string)

Obtenha uma relação de associação entre um contêiner e um assunto.

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

Parâmetros

subjectDescriptor

string

Um descritor para o assunto filho na relação.

containerDescriptor

string

Um descritor para o contêiner na relação.

Retornos

Promise<GraphMembership>

getMembershipState(string)

Verifique se um assunto está ativo ou inativo.

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

Parâmetros

subjectDescriptor

string

Descritor do assunto (usuário, grupo, escopo etc.) para marcar estado de

Retornos

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parâmetros

userDescriptor

string

Retornos

Promise<GraphProviderInfo>

getScope(string)

Obter um escopo identificado por seu descritor

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

Parâmetros

scopeDescriptor

string

Um descritor que identifica exclusivamente um escopo.

Retornos

Promise<GraphScope>

getServicePrincipal(string)

Obtenha uma entidade de serviço por seu descritor.

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

Parâmetros

servicePrincipalDescriptor

string

O descritor da entidade de serviço desejada.

Retornos

Promise<GraphServicePrincipal>

getStorageKey(string)

Resolva um descritor para uma chave de armazenamento.

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

Parâmetros

subjectDescriptor

string

Retornos

Promise<GraphStorageKeyResult>

getSubject(string)

Resolva um descritor para um usuário, grupo ou escopo.

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

Parâmetros

subjectDescriptor

string

O descritor do assunto desejado.

Retornos

Promise<GraphSubject>

getUser(string)

Obtenha um usuário por seu descritor.

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

Parâmetros

userDescriptor

string

O descritor do usuário desejado.

Retornos

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Obtenha todas as associações em que esse descritor é um membro na relação.

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

Parâmetros

subjectDescriptor

string

Busque todas as associações diretas desse descritor.

direction

GraphTraversalDirection

O padrão é Up.

depth

number

O número máximo de bordas a percorrer para cima ou para baixo na árvore de associação. Atualmente, o único valor com suporte é '1'.

Retornos

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Obtém todos os membros solicitados no escopo atual (geralmente organização ou conta).

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

Parâmetros

memberLookup

GraphSubjectLookup

Retornos

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Percorra as associações dos descritores de assunto especificados.

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

Parâmetros

membershipTraversalLookup

GraphSubjectLookup

Busque os descendentes/ancestrais da lista de descritores, dependendo da direção.

direction

GraphTraversalDirection

O valor padrão é Desconhecido.

depth

number

O valor padrão é '1'.

Retornos

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

lookupSubjects(GraphSubjectLookup)

Resolva descritores para usuários, grupos ou escopos (Entidades) em um lote.

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

Parâmetros

subjectLookup

GraphSubjectLookup

Uma lista de descritores que especifica um subconjunto de sujeitos a serem recuperados. Cada descritor identifica exclusivamente o assunto em todos os escopos de instância, mas apenas em um único ponto no tempo.

Retornos

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

querySubjects(GraphSubjectQuery)

Pesquisa para usuários do Azure Devops ou/e grupos. Os resultados serão retornados em um lote com no máximo 100 entidades de grafo.

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

Parâmetros

subjectQuery

GraphSubjectQuery

A consulta que usaremos para pesquisar inclui o seguinte: Consulta: o termo de pesquisa. A pesquisa será apenas correspondente ao prefixo. SubjectKind: "Usuário" ou "Grupo" pode ser especificado, tanto quanto ScopeDescriptor: escopo não padrão pode ser especificado, ou seja, descritor de escopo de projeto

Retornos

Promise<GraphSubject[]>

removeMembership(string, string)

Exclui uma associação entre um contêiner e um assunto.

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

Parâmetros

subjectDescriptor

string

Um descritor para um grupo ou usuário que é o assunto filho na relação.

containerDescriptor

string

Um descritor para um grupo que é o contêiner na relação.

Retornos

Promise<void>

requestAccess(any)

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

Parâmetros

jsondocument

any

Retornos

Promise<void>

resolve(IdentityMappings)

Mapeie em lote uma lista de usuários para novos usuários.

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

Parâmetros

mappings

IdentityMappings

Uma lista de mapeamentos.

Retornos

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parâmetros

avatar

Avatar

subjectDescriptor

string

Retornos

Promise<void>

translate(string, string)

Tradução de Identidade – o ponto de extremidade de tradução deve ser usado pela ação geneva.

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

Parâmetros

masterId

string

localId

string

Retornos

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Percorra associações do descritor de assunto especificado.

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

Parâmetros

subjectDescriptor

string

Busque os descendentes/ancestrais desse descritor dependendo da direção.

direction

GraphTraversalDirection

O valor padrão é Desconhecido.

depth

number

O valor padrão é '1'.

Retornos

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Atualize as propriedades de um grupo do Azure DevOps.

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

Parâmetros

groupDescriptor

string

O descritor do grupo a ser modificado.

patchDocument

JsonPatchDocument

O documento JSON+Patch que contém os campos a serem alterados.

Retornos

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parâmetros

scopeDescriptor

string

patchDocument

JsonPatchDocument

Retornos

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Mapeie uma entidade de serviço existente para uma entidade de serviço diferente.

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

Parâmetros

updateContext

GraphServicePrincipalUpdateContext

O subconjunto da entidade de serviço de grafo completa usada para localizar exclusivamente o assunto do grafo em um provedor externo.

servicePrincipalDescriptor

string

O descritor da entidade de serviço a ser atualizada

Retornos

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Mapeie um usuário existente para um usuário diferente.

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

Parâmetros

updateContext

GraphUserUpdateContext

O subconjunto do usuário de grafo completo usado para localizar exclusivamente o assunto do grafo em um provedor externo.

userDescriptor

string

O descritor do usuário a ser atualizado

Retornos

Promise<GraphUser>