GraphRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às 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 contentor e um assunto.
checkMembershipExistence(string, string)	Verifique se existe uma relação de associação entre um contentor e um assunto.
createGroup(GraphGroupCreationContext, string, string[])	Crie um novo grupo do Azure DevOps ou materialize um grupo do AAD existente.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialize um principal de serviço do AAD existente na conta ADO.
createUser(GraphUserCreationContext, string[])	Materialize um utilizador do AAD ou MSA existente na conta ADO.
deleteAvatar(string)
deleteGroup(string)	Remove um grupo do Azure DevOps de todos os grupos principais.
deleteScope(string)
deleteServicePrincipal(string)	Desativa um principal de serviço.
deleteUser(string)	Desativa um utilizador.
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 do fornecedor federado disponíveis para o requerente de gráfico e o nome do fornecedor especificados.
getGroup(string)	Obtenha um grupo pelo respetivo descritor.
getMemberByDescriptor(string)	Este ponto final devolve um resultado para qualquer membro que tenha sido válido no sistema, mesmo que o membro tenha sido eliminado ou tenha eliminado todas as respetivas associações. A validade atual do membro é indicada através da respetiva propriedade desativada, o que é omitido quando falso.
getMembership(string, string)	Obtenha uma relação de associação entre um contentor e um assunto.
getMembershipState(string)	Verifique se um assunto está ativo ou inativo.
getProviderInfo(string)
getScope(string)	Obter um âmbito identificado pelo respetivo descritor
getServicePrincipal(string)	Obtenha um principal de serviço pelo respetivo descritor.
getStorageKey(string)	Resolva um descritor numa chave de armazenamento.
getSubject(string)	Resolva um descritor para um utilizador, grupo ou âmbito.
getUser(string)	Obtenha um utilizador pelo respetivo descritor.
listMemberships(string, GraphTraversalDirection, number)	Obtenha todas as associações em que este descritor é membro na relação.
lookupMembers(GraphSubjectLookup)	Obtém todos os membros pedidos no âmbito atual (geralmente organização ou conta).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Percorre as associações dos descritores do assunto especificados.
lookupSubjects(GraphSubjectLookup)	Resolva descritores para utilizadores, grupos ou âmbitos (Assuntos) num lote.
querySubjects(GraphSubjectQuery)	Pesquisa para utilizadores do Azure Devops ou/e grupos. Os resultados serão devolvidos num lote sem mais de 100 assuntos de grafos.
removeMembership(string, string)	Elimina uma associação entre um contentor e um assunto.
requestAccess(any)
resolve(IdentityMappings)	Mapear em lote uma lista de utilizadores para novos utilizadores.
setAvatar(Avatar, string)
translate(string, string)	Tradução de Identidade – o ponto final de tradução deve ser utilizado pela ação geneva.
traverseMemberships(string, GraphTraversalDirection, number)	Percorre as 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)	Mapear um principal de serviço existente para um principal de serviço diferente.
updateUser(GraphUserUpdateContext, string)	Mapear um utilizador existente para um utilizador diferente.

Detalhes do Construtor

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addMembership(string, string)

Crie uma nova associação entre um contentor e um assunto.

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

Parâmetros

subjectDescriptor

string

Um descritor para um grupo ou utilizador que pode ser o subordinado na relação.

containerDescriptor

string

Um descritor para um grupo que pode ser o contentor na relação.

Devoluções

Promise<GraphMembership>

checkMembershipExistence(string, string)

Verifique se existe uma relação de associação entre um contentor e um assunto.

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

Parâmetros

subjectDescriptor

string

O grupo ou utilizador que é um assunto subordinado da relação.

containerDescriptor

string

O grupo que é o contentor na relação.

Devoluções

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

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

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

Parâmetros

creationContext

GraphGroupCreationContext

O subconjunto do grupo de gráficos completo utilizado para localizar exclusivamente o assunto do gráfico num fornecedor externo.

scopeDescriptor

string

Um descritor que referencia o âmbito (coleção, projeto) no qual o grupo deve ser criado. Se omitido, será criado no âmbito da conta ou organização que inclui. Válido apenas para grupos VSTS.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores que referenciam grupos que pretende que o grupo de gráficos adira

Devoluções

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Parâmetros

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Devoluções

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Materialize um principal de serviço do AAD existente na conta ADO.

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

Parâmetros

creationContext

GraphServicePrincipalCreationContext

O subconjunto do principal de serviço de grafo completo utilizado para localizar exclusivamente o assunto do gráfico num fornecedor externo.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores de grupos que pretende que o principal de serviço de gráficos adira

Devoluções

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Materialize um utilizador do AAD ou MSA existente na conta ADO.

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

Parâmetros

creationContext

GraphUserCreationContext

O subconjunto do utilizador de gráfico completo utilizado para localizar exclusivamente o assunto do gráfico num fornecedor externo.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores de grupos que pretende que o utilizador do gráfico adira

Devoluções

Promise<GraphUser>

deleteAvatar(string)

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

Parâmetros

subjectDescriptor

string

Devoluções

Promise<void>

deleteGroup(string)

Remove um grupo do Azure DevOps de todos os grupos principais.

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

Parâmetros

groupDescriptor

string

O descritor do grupo a eliminar.

Devoluções

Promise<void>

deleteScope(string)

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

Parâmetros

scopeDescriptor

string

Devoluções

Promise<void>

deleteServicePrincipal(string)

Desativa um principal de serviço.

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

Parâmetros

servicePrincipalDescriptor

string

O descritor do principal de serviço a eliminar.

Devoluções

Promise<void>

deleteUser(string)

Desativa um utilizador.

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

Parâmetros

userDescriptor

string

O descritor do utilizador a eliminar.

Devoluções

Promise<void>

getAvatar(string, AvatarSize, string)

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

Parâmetros

subjectDescriptor

string

size

AvatarSize

format

string

Devoluções

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Devoluções

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 (utilizador, grupo, âmbito, etc.) para resolver

Devoluções

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Adquire o conjunto completo de dados de autenticação do fornecedor federado disponíveis para o requerente de gráfico e o nome do fornecedor especificados.

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

Parâmetros

subjectDescriptor

string

o descritor do assunto do gráfico para o qual devemos adquirir dados

providerName

string

o nome do fornecedor a adquirir dados para, por exemplo, "github.com"

versionHint

number

uma sugestão de versão que pode ser utilizada para simultaneidade de cache otimista e para suportar repetições sobre falhas de tokens de acesso; tenha em atenção que esta é apenas uma sugestão e não garante uma versão específica na resposta

Devoluções

Promise<GraphFederatedProviderData>

getGroup(string)

Obtenha um grupo pelo respetivo descritor.

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

Parâmetros

groupDescriptor

string

O descritor do grupo de gráficos pretendido.

Devoluções

Promise<GraphGroup>

getMemberByDescriptor(string)

Este ponto final devolve um resultado para qualquer membro que tenha sido válido no sistema, mesmo que o membro tenha sido eliminado ou tenha eliminado todas as respetivas associações. A validade atual do membro é indicada através da respetiva propriedade desativada, o que é omitido quando falso.

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

Parâmetros

memberDescriptor

string

O descritor do membro pretendido.

Devoluções

Promise<GraphMember>

getMembership(string, string)

Obtenha uma relação de associação entre um contentor e um assunto.

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

Parâmetros

subjectDescriptor

string

Um descritor para o subordinado na relação.

containerDescriptor

string

Um descritor para o contentor na relação.

Devoluções

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 (utilizador, grupo, âmbito, etc.) para verificar o estado de

Devoluções

Promise<GraphMembershipState>

getProviderInfo(string)

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

Parâmetros

userDescriptor

string

Devoluções

Promise<GraphProviderInfo>

getScope(string)

Obter um âmbito identificado pelo respetivo descritor

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

Parâmetros

scopeDescriptor

string

Um descritor que identifica exclusivamente um âmbito.

Devoluções

Promise<GraphScope>

getServicePrincipal(string)

Obtenha um principal de serviço pelo respetivo descritor.

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

Parâmetros

servicePrincipalDescriptor

string

O descritor do principal de serviço pretendido.

Devoluções

Promise<GraphServicePrincipal>

getStorageKey(string)

Resolva um descritor numa chave de armazenamento.

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

Parâmetros

subjectDescriptor

string

Devoluções

Promise<GraphStorageKeyResult>

getSubject(string)

Resolva um descritor para um utilizador, grupo ou âmbito.

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

Parâmetros

subjectDescriptor

string

O descritor do assunto pretendido.

Devoluções

Promise<GraphSubject>

getUser(string)

Obtenha um utilizador pelo respetivo descritor.

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

Parâmetros

userDescriptor

string

O descritor do utilizador pretendido.

Devoluções

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

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

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

Parâmetros

subjectDescriptor

string

Obtenha todas as associações diretas deste descritor.

direction

GraphTraversalDirection

Predefinições para Cima.

depth

number

O número máximo de arestas a percorrer para cima ou para baixo na árvore de associação. Atualmente, o único valor suportado é "1".

Devoluções

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Obtém todos os membros pedidos no âmbito atual (geralmente organização ou conta).

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

Parâmetros

memberLookup

GraphSubjectLookup

Devoluções

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Percorre as associações dos descritores do assunto especificados.

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

Parâmetros

membershipTraversalLookup

GraphSubjectLookup

Obtenha os descendentes/antepassados da lista de descritores consoante a direção.

direction

GraphTraversalDirection

O valor predefinido é Desconhecido.

depth

number

O valor predefinido é "1".

Devoluções

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

lookupSubjects(GraphSubjectLookup)

Resolva descritores para utilizadores, grupos ou âmbitos (Assuntos) num lote.

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

Parâmetros

subjectLookup

GraphSubjectLookup

Uma lista de descritores que especifica um subconjunto de assuntos a obter. Cada descritor identifica exclusivamente o assunto em todos os âmbitos de instância, mas apenas num único ponto no tempo.

Devoluções

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

querySubjects(GraphSubjectQuery)

Pesquisa para utilizadores do Azure Devops ou/e grupos. Os resultados serão devolvidos num lote sem mais de 100 assuntos de grafos.

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

Parâmetros

subjectQuery

GraphSubjectQuery

A consulta que iremos utilizar para procurar inclui o seguinte: Consulta: o termo de pesquisa. A pesquisa será apenas a correspondência do prefixo. SubjectKind: "Utilizador" ou "Grupo" podem ser especificados, tanto como ScopeDescriptor: o âmbito não predefinido pode ser especificado, ou seja, descritor do âmbito do projeto

Devoluções

Promise<GraphSubject[]>

removeMembership(string, string)

Elimina uma associação entre um contentor e um assunto.

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

Parâmetros

subjectDescriptor

string

Um descritor para um grupo ou utilizador que seja o requerente subordinado na relação.

containerDescriptor

string

Um descritor para um grupo que é o contentor na relação.

Devoluções

Promise<void>

requestAccess(any)

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

Parâmetros

jsondocument

any

Devoluções

Promise<void>

resolve(IdentityMappings)

Mapear em lote uma lista de utilizadores para novos utilizadores.

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

Parâmetros

mappings

IdentityMappings

Uma lista de mapeamentos.

Devoluções

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Parâmetros

avatar

Avatar

subjectDescriptor

string

Devoluções

Promise<void>

translate(string, string)

Tradução de Identidade – o ponto final de tradução deve ser utilizado pela ação geneva.

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

Parâmetros

masterId

string

localId

string

Devoluções

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Percorre as associações do descritor de assunto especificado.

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

Parâmetros

subjectDescriptor

string

Obtenha os descendentes/antepassados deste descritor consoante a direção.

direction

GraphTraversalDirection

O valor predefinido é Desconhecido.

depth

number

O valor predefinido é "1".

Devoluções

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

patchDocument

JsonPatchDocument

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

Devoluções

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Parâmetros

scopeDescriptor

string

patchDocument

JsonPatchDocument

Devoluções

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Mapear um principal de serviço existente para um principal de serviço diferente.

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

Parâmetros

updateContext

GraphServicePrincipalUpdateContext

O subconjunto do principal de serviço de grafo completo utilizado para localizar exclusivamente o assunto do gráfico num fornecedor externo.

servicePrincipalDescriptor

string

O descritor do principal de serviço a atualizar

Devoluções

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Mapear um utilizador existente para um utilizador diferente.

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

Parâmetros

updateContext

GraphUserUpdateContext

O subconjunto do utilizador de gráfico completo utilizado para localizar exclusivamente o assunto do gráfico num fornecedor externo.

userDescriptor

string

O descritor do utilizador a atualizar

Devoluções

Promise<GraphUser>