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 de DevOps do Azure ou materialize um grupo existente do AAD.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Materialize uma entidade de serviço existente do AAD 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 de DevOps do Azure de todos os seus grupos pai.
deleteScope(string)
deleteServicePrincipal(string)	Desabilita uma entidade de serviço.
deleteUser(string)	Desativa 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 federado disponíveis para determinado assunto do gráfico e nome do provedor.
getGroup(string)	Obtenha um grupo pelo seu descritor.
getMemberByDescriptor(string)	Esse ponto de extremidade retorna um resultado para qualquer membro que já tenha sido válido no sistema, mesmo que o membro já tenha sido excluído ou tenha tido todas as suas associações excluídas. A validade atual do membro é indicada através de sua propriedade desabilitada, que é omitida quando falsa.
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 pelo 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)	Obter um usuário pelo seu descritor.
listMemberships(string, GraphTraversalDirection, number)	Obtenha todas as associações em que este 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)	Transversal aos descritores temáticos fornecidos.
lookupSubjects(GraphSubjectLookup)	Resolva descritores para usuários, grupos ou escopos (Assuntos) em um lote.
querySubjects(GraphSubjectQuery)	Pesquise usuários e/ou grupos do Azure Devops. Os resultados serão devolvidos num lote com um máximo de 100 sujeitos gráficos.
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 - Traduzir endpoint deve ser usado por ação genebra.
traverseMemberships(string, GraphTraversalDirection, number)	Percorrer as associações do descritor de assunto dado.
updateGroup(string, JsonPatchDocument)	Atualize as propriedades de um grupo de DevOps do Azure.
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 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 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 sujeito filho na relação.

containerDescriptor

string

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

Devoluções

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 sujeito filho da relação.

containerDescriptor

string

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

Devoluções

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Crie um novo grupo de DevOps do Azure 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 gráficos completo usado para localizar exclusivamente o assunto do gráfico 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 âmbito da conta ou organização anexa. Válido apenas para grupos VSTS.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores que fazem referência a grupos aos quais você deseja que o grupo gráfico se junte

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 uma entidade de serviço existente do AAD na conta do ADO.

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

Parâmetros

creationContext

GraphServicePrincipalCreationContext

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

groupDescriptors

string[]

Uma lista separada por vírgulas dos descritores dos grupos aos quais você deseja que a entidade de serviço do gráfico se junte

Devoluções

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 do gráfico completo usado para encontrar exclusivamente o assunto do gráfico em um provedor externo.

groupDescriptors

string[]

Uma lista separada por vírgulas de descritores de grupos aos quais você deseja que o usuário do gráfico se junte

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 de DevOps do Azure de todos os seus grupos pai.

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

Parâmetros

groupDescriptor

string

O descritor do grupo a ser excluído.

Devoluções

Promise<void>

deleteScope(string)

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

Parâmetros

scopeDescriptor

string

Devoluções

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.

Devoluções

Promise<void>

deleteUser(string)

Desativa um usuário.

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

Parâmetros

userDescriptor

string

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

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 (usuário, grupo, escopo, etc.) para resolver

Devoluções

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Adquire o conjunto completo de dados de autenticação de provedor federado disponíveis para determinado assunto do gráfico e nome do provedor.

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

Parâmetros

subjectDescriptor

string

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

providerName

string

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

versionHint

number

uma dica de versão que pode ser usada para simultaneidade de cache otimista e para suportar novas tentativas em falhas de token de acesso; Note que esta é apenas uma dica e não garante uma versão específica na resposta

Devoluções

Promise<GraphFederatedProviderData>

getGroup(string)

Obtenha um grupo pelo seu descritor.

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

Parâmetros

groupDescriptor

string

O descritor do grupo gráfico desejado.

Devoluções

Promise<GraphGroup>

getMemberByDescriptor(string)

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

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

Parâmetros

memberDescriptor

string

O descritor do membro desejado.

Devoluções

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 sujeito criança na relação.

containerDescriptor

string

Um descritor para o contêiner 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 escopo identificado por seu descritor

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

Parâmetros

scopeDescriptor

string

Um descritor que identifica exclusivamente um escopo.

Devoluções

Promise<GraphScope>

getServicePrincipal(string)

Obtenha uma entidade de serviço pelo seu descritor.

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

Parâmetros

servicePrincipalDescriptor

string

O descritor da entidade de serviço desejada.

Devoluções

Promise<GraphServicePrincipal>

getStorageKey(string)

Resolva um descritor para uma chave de armazenamento.

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

Parâmetros

subjectDescriptor

string

Devoluções

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 sujeito desejado.

Devoluções

Promise<GraphSubject>

getUser(string)

Obter um usuário pelo seu descritor.

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

Parâmetros

userDescriptor

string

O descritor do usuário desejado.

Devoluções

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Obtenha todas as associações em que este descritor é um 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

O padrão é Up.

depth

number

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

Devoluções

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

Devoluções

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Transversal aos descritores temáticos fornecidos.

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

Parâmetros

membershipTraversalLookup

GraphSubjectLookup

Procure os descendentes/antepassados da lista de descritores dependendo da direção.

direction

GraphTraversalDirection

O valor padrão é Unknown.

depth

number

O valor padrão é '1'.

Devoluções

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

lookupSubjects(GraphSubjectLookup)

Resolva descritores para usuários, grupos ou escopos (Assuntos) 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 assuntos a serem recuperados. Cada descritor identifica exclusivamente o assunto em todos os escopos de instância, mas apenas em um único ponto no tempo.

Devoluções

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

querySubjects(GraphSubjectQuery)

Pesquise usuários e/ou grupos do Azure Devops. Os resultados serão devolvidos num lote com um máximo de 100 sujeitos gráficos.

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 de correspondência de prefixo. SubjectKind: "User" ou "Group" pode ser especificado, ambos ou ScopeDescriptor: Escopo não padrão pode ser especificado, ou seja, descritor de escopo do projeto

Devoluções

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 sujeito filho na relação.

containerDescriptor

string

Um descritor para um grupo que é o contêiner 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)

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.

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 - Traduzir endpoint deve ser usado por ação genebra.

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

Parâmetros

masterId

string

localId

string

Devoluções

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Percorrer as associações do descritor de assunto dado.

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

Parâmetros

subjectDescriptor

string

Procure os descendentes/antepassados deste descritor dependendo da direção.

direction

GraphTraversalDirection

O valor padrão é Unknown.

depth

number

O valor padrão é '1'.

Devoluções

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Atualize as propriedades de um grupo de DevOps do Azure.

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 serem alterados.

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)

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 gráfico completa usada para localizar exclusivamente o assunto do gráfico em um provedor externo.

servicePrincipalDescriptor

string

O descritor da entidade de serviço a ser atualizada

Devoluções

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 do gráfico completo usado para encontrar exclusivamente o assunto do gráfico em um provedor externo.

userDescriptor

string

O descritor do usuário a ser atualizado

Devoluções

Promise<GraphUser>