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[]

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

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

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

Значение по умолчанию: Unknown.

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

Значение по умолчанию: Unknown.

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>