GraphRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

GraphRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addMembership(string, string)	Создайте новое членство между контейнером и субъектом.
checkMembershipExistence(string, string)	Проверьте, существует ли отношение членства между контейнером и субъектом.
createGroup(GraphGroupCreationContext, string, string[])	Создайте новую группу Azure DevOps или материализуйте существующую группу AAD.
createScope(GraphScopeCreationContext, string)
createServicePrincipal(GraphServicePrincipalCreationContext, string[])	Материализуйте существующий субъект-службу AAD в учетную запись ADO.
createUser(GraphUserCreationContext, string[])	Материализуйте существующего пользователя AAD или MSA в учетную запись ADO.
deleteAvatar(string)
deleteGroup(string)	Удаляет группу Azure DevOps из всех родительских групп.
deleteScope(string)
deleteServicePrincipal(string)	Отключает субъекта-службу.
deleteUser(string)	Отключает пользователя.
getAvatar(string, AvatarSize, string)
getCachePolicies()
getDescriptor(string)	Преобразование ключа хранилища в дескриптор
getFederatedProviderData(string, string, number)	Получает полный набор данных федеративной проверки подлинности поставщика, доступных для заданного субъекта графа и имени поставщика.
getGroup(string)	Получите группу по ее дескриптору.
getMemberByDescriptor(string)	Эта конечная точка возвращает результат для любого участника, который когда-либо был действительным в системе, даже если с тех пор он был удален или все его членства были удалены. Текущая действительность элемента указывается через его отключенное свойство, которое опускается при значении false.
getMembership(string, string)	Получение отношения членства между контейнером и субъектом.
getMembershipState(string)	Проверьте, активен ли субъект или нет.
getProviderInfo(string)
getScope(string)	Получение области видимости по ее дескриптору
getServicePrincipal(string)	Получение субъекта-службы по его дескриптору.
getStorageKey(string)	Преобразуйте дескриптор в ключ хранилища.
getSubject(string)	Преобразуйте дескриптор в пользователя, группу или область.
getUser(string)	Получите пользователя по его дескриптору.
listMemberships(string, GraphTraversalDirection, number)	Получите все членства, в которых этот дескриптор является членом отношения.
lookupMembers(GraphSubjectLookup)	Получает всех запрошенных участников в текущей области (обычно это организация или учетная запись).
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	Обход членства заданных дескрипторов субъекта.
lookupSubjects(GraphSubjectLookup)	Разрешайте дескрипторы для пользователей, групп или областей (субъектов) в пакете.
querySubjects(GraphSubjectQuery)	Поиск пользователей или (или) групп Azure DevOps. Результаты будут возвращены в пакете, содержащем не более 100 графических тем.
removeMembership(string, string)	Удаляет членство между контейнером и субъектом.
requestAccess(any)
resolve(IdentityMappings)	Пакетное сопоставление списка пользователей с новыми пользователями.
setAvatar(Avatar, string)
translate(string, string)	Трансляция удостоверений - конечная точка перевода должна использоваться действием Geneva.
traverseMemberships(string, GraphTraversalDirection, number)	Обход членства заданного дескриптора субъекта.
updateGroup(string, JsonPatchDocument)	Обновите свойства группы Azure DevOps.
updateScope(string, JsonPatchDocument)
updateServicePrincipal(GraphServicePrincipalUpdateContext, string)	Сопоставление существующего субъекта-службы с другим субъектом-службой.
updateUser(GraphUserUpdateContext, string)	Сопоставление существующего пользователя с другим пользователем.

Сведения о конструкторе

GraphRestClient(IVssRestClientOptions)

new GraphRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addMembership(string, string)

Создайте новое членство между контейнером и субъектом.

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

Параметры

subjectDescriptor

string

Дескриптор группы или пользователя, который может быть дочерним субъектом в отношениях.

containerDescriptor

string

Дескриптор группы, которая может быть контейнером в отношении.

Возвращаемое значение

Promise<GraphMembership>

checkMembershipExistence(string, string)

Проверьте, существует ли отношение членства между контейнером и субъектом.

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

Параметры

subjectDescriptor

string

Группа или пользователь, которые являются дочерним субъектом отношения.

containerDescriptor

string

Группа, которая является контейнером в отношении.

Возвращаемое значение

Promise<boolean>

createGroup(GraphGroupCreationContext, string, string[])

Создайте новую группу Azure DevOps или материализуйте существующую группу AAD.

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

Параметры

creationContext

GraphGroupCreationContext

Подмножество полной группы графов, используемое для однозначного поиска субъекта графа у внешнего поставщика.

scopeDescriptor

string

Дескриптор, указывающий на область (коллекцию, проект), в которой должна быть создана группа. Если этот параметр опущен, будет создан в области вложенной учетной записи или организации. Действует только для групп VSTS.

groupDescriptors

string[]

Разделенный запятыми список дескрипторов, ссылающихся на группы, к которым должна присоединиться группа графа

Возвращаемое значение

Promise<GraphGroup>

createScope(GraphScopeCreationContext, string)

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

Параметры

creationContext

GraphScopeCreationContext

scopeDescriptor

string

Возвращаемое значение

Promise<GraphScope>

createServicePrincipal(GraphServicePrincipalCreationContext, string[])

Материализуйте существующий субъект-службу AAD в учетную запись ADO.

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

Параметры

creationContext

GraphServicePrincipalCreationContext

Подмножество полного субъекта-службы графа, используемое для однозначного поиска субъекта графа у внешнего поставщика.

groupDescriptors

string[]

Разделенный запятыми список дескрипторов групп, к которым должен присоединиться субъект-служба graph

Возвращаемое значение

Promise<GraphServicePrincipal>

createUser(GraphUserCreationContext, string[])

Материализуйте существующего пользователя AAD или MSA в учетную запись ADO.

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

Параметры

creationContext

GraphUserCreationContext

Подмножество пользователя полного графа, используемое для однозначного поиска субъекта графа у внешнего поставщика.

groupDescriptors

string[]

Разделенный запятыми список дескрипторов групп, к которым пользователь графа должен присоединиться

Возвращаемое значение

Promise<GraphUser>

deleteAvatar(string)

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

Параметры

subjectDescriptor

string

Возвращаемое значение

Promise<void>

deleteGroup(string)

Удаляет группу Azure DevOps из всех родительских групп.

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

Параметры

groupDescriptor

string

Дескриптор удаляемой группы.

Возвращаемое значение

Promise<void>

deleteScope(string)

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

Параметры

scopeDescriptor

string

Возвращаемое значение

Promise<void>

deleteServicePrincipal(string)

Отключает субъекта-службу.

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

Параметры

servicePrincipalDescriptor

string

Дескриптор субъекта-службы, который необходимо удалить.

Возвращаемое значение

Promise<void>

deleteUser(string)

Отключает пользователя.

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

Параметры

userDescriptor

string

Дескриптор пользователя, которого нужно удалить.

Возвращаемое значение

Promise<void>

getAvatar(string, AvatarSize, string)

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

Параметры

subjectDescriptor

string

size

AvatarSize

format

string

Возвращаемое значение

Promise<Avatar>

getCachePolicies()

function getCachePolicies(): Promise<GraphCachePolicies>

Возвращаемое значение

Promise<GraphCachePolicies>

getDescriptor(string)

Преобразование ключа хранилища в дескриптор

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

Параметры

storageKey

string

Ключ хранения субъекта (пользователя, группы, области и т. д.) для разрешения

Возвращаемое значение

Promise<GraphDescriptorResult>

getFederatedProviderData(string, string, number)

Получает полный набор данных федеративной проверки подлинности поставщика, доступных для заданного субъекта графа и имени поставщика.

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

Параметры

subjectDescriptor

string

дескриптор предмета графа, для которого мы должны получить данные

providerName

string

название поставщика, для которого необходимо получить данные, например «github.com»

versionHint

number

подсказка о версии, которую можно использовать для оптимистичного параллелизма кэша и поддержки повторных попыток при сбоях маркера доступа; Обратите внимание, что это только подсказка и не гарантирует конкретную версию по ответу

Возвращаемое значение

Promise<GraphFederatedProviderData>

getGroup(string)

Получите группу по ее дескриптору.

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

Параметры

groupDescriptor

string

Дескриптор нужной группы графов.

Возвращаемое значение

Promise<GraphGroup>

getMemberByDescriptor(string)

Эта конечная точка возвращает результат для любого участника, который когда-либо был действительным в системе, даже если с тех пор он был удален или все его членства были удалены. Текущая действительность элемента указывается через его отключенное свойство, которое опускается при значении false.

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

Параметры

memberDescriptor

string

Дескриптор нужного элемента.

Возвращаемое значение

Promise<GraphMember>

getMembership(string, string)

Получение отношения членства между контейнером и субъектом.

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

Параметры

subjectDescriptor

string

Дескриптор для дочернего субъекта в отношениях.

containerDescriptor

string

Дескриптор контейнера в отношении.

Возвращаемое значение

Promise<GraphMembership>

getMembershipState(string)

Проверьте, активен ли субъект или нет.

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

Параметры

subjectDescriptor

string

Дескриптор субъекта (пользователя, группы, области видимости и т.д.) для проверки состояния

Возвращаемое значение

Promise<GraphMembershipState>

getProviderInfo(string)

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

Параметры

userDescriptor

string

Возвращаемое значение

Promise<GraphProviderInfo>

getScope(string)

Получение области видимости по ее дескриптору

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

Параметры

scopeDescriptor

string

Дескриптор, который однозначно идентифицирует область.

Возвращаемое значение

Promise<GraphScope>

getServicePrincipal(string)

Получение субъекта-службы по его дескриптору.

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

Параметры

servicePrincipalDescriptor

string

Дескриптор нужного субъекта-службы.

Возвращаемое значение

Promise<GraphServicePrincipal>

getStorageKey(string)

Преобразуйте дескриптор в ключ хранилища.

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

Параметры

subjectDescriptor

string

Возвращаемое значение

Promise<GraphStorageKeyResult>

getSubject(string)

Преобразуйте дескриптор в пользователя, группу или область.

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

Параметры

subjectDescriptor

string

Дескриптор желаемого предмета.

Возвращаемое значение

Promise<GraphSubject>

getUser(string)

Получите пользователя по его дескриптору.

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

Параметры

userDescriptor

string

Дескриптор нужного пользователя.

Возвращаемое значение

Promise<GraphUser>

listMemberships(string, GraphTraversalDirection, number)

Получите все членства, в которых этот дескриптор является членом отношения.

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

Параметры

subjectDescriptor

string

Получить все прямые членства этого дескриптора.

direction

GraphTraversalDirection

По умолчанию установлено значение «Вверх».

depth

number

Максимальное количество ребер для обхода вверх или вниз по дереву членства. В настоящее время единственным поддерживаемым значением является '1'.

Возвращаемое значение

Promise<GraphMembership[]>

lookupMembers(GraphSubjectLookup)

Получает всех запрошенных участников в текущей области (обычно это организация или учетная запись).

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

Параметры

memberLookup

GraphSubjectLookup

Возвращаемое значение

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

lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)

Обход членства заданных дескрипторов субъекта.

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

Параметры

membershipTraversalLookup

GraphSubjectLookup

Извлекайте потомков/предков из списка дескрипторов в зависимости от направления.

direction

GraphTraversalDirection

Значение по умолчанию — Неизвестно.

depth

number

Значение по умолчанию — '1'.

Возвращаемое значение

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

lookupSubjects(GraphSubjectLookup)

Разрешайте дескрипторы для пользователей, групп или областей (субъектов) в пакете.

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

Параметры

subjectLookup

GraphSubjectLookup

Список дескрипторов, указывающий подмножество объектов для извлечения. Каждый дескриптор уникально идентифицирует субъекта во всех областях экземпляра, но только в определенный момент времени.

Возвращаемое значение

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

querySubjects(GraphSubjectQuery)

Поиск пользователей или (или) групп Azure DevOps. Результаты будут возвращены в пакете, содержащем не более 100 графических тем.

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

Параметры

subjectQuery

GraphSubjectQuery

Запрос, который мы будем использовать для поиска, включает в себя следующее: Запрос: поисковый запрос. Поиск будет осуществляться только по сопоставлению префиксов. SubjectKind: Может быть указан "User" или "Group", оба или либо ScopeDescriptor: Может быть указана область действия, не используемая по умолчанию, т.е. дескриптор области проекта

Возвращаемое значение

Promise<GraphSubject[]>

removeMembership(string, string)

Удаляет членство между контейнером и субъектом.

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

Параметры

subjectDescriptor

string

Дескриптор группы или пользователя, который является дочерним субъектом в отношениях.

containerDescriptor

string

Дескриптор группы, которая является контейнером в отношении.

Возвращаемое значение

Promise<void>

requestAccess(any)

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

Параметры

jsondocument

any

Возвращаемое значение

Promise<void>

resolve(IdentityMappings)

Пакетное сопоставление списка пользователей с новыми пользователями.

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

Параметры

mappings

IdentityMappings

Список сопоставлений.

Возвращаемое значение

Promise<ResolveDisconnectedUsersResponse>

setAvatar(Avatar, string)

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

Параметры

avatar

Avatar

subjectDescriptor

string

Возвращаемое значение

Promise<void>

translate(string, string)

Трансляция удостоверений - конечная точка перевода должна использоваться действием Geneva.

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

Параметры

masterId

string

localId

string

Возвращаемое значение

Promise<string>

traverseMemberships(string, GraphTraversalDirection, number)

Обход членства заданного дескриптора субъекта.

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

Параметры

subjectDescriptor

string

Получите потомков/предков этого дескриптора в зависимости от направления.

direction

GraphTraversalDirection

Значение по умолчанию — Неизвестно.

depth

number

Значение по умолчанию — '1'.

Возвращаемое значение

Promise<GraphMembershipTraversal>

updateGroup(string, JsonPatchDocument)

Обновите свойства группы Azure DevOps.

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

Параметры

groupDescriptor

string

Дескриптор группы, которую необходимо изменить.

patchDocument

JsonPatchDocument

Документ JSON+Patch, содержащий поля для изменения.

Возвращаемое значение

Promise<GraphGroup>

updateScope(string, JsonPatchDocument)

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

Параметры

scopeDescriptor

string

patchDocument

JsonPatchDocument

Возвращаемое значение

Promise<void>

updateServicePrincipal(GraphServicePrincipalUpdateContext, string)

Сопоставление существующего субъекта-службы с другим субъектом-службой.

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

Параметры

updateContext

GraphServicePrincipalUpdateContext

Подмножество полного субъекта-службы графа, используемое для однозначного поиска субъекта графа у внешнего поставщика.

servicePrincipalDescriptor

string

Дескриптор субъекта-службы для обновления

Возвращаемое значение

Promise<GraphServicePrincipal>

updateUser(GraphUserUpdateContext, string)

Сопоставление существующего пользователя с другим пользователем.

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

Параметры

updateContext

GraphUserUpdateContext

Подмножество пользователя полного графа, используемое для однозначного поиска субъекта графа у внешнего поставщика.

userDescriptor

string

Дескриптор пользователя для обновления

Возвращаемое значение

Promise<GraphUser>