GraphRestClient class

参考

包:: azure-devops-extension-api

应使用 (派生自) 的基类向 VSS REST API 发出请求

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

默认为 Up。

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：可以指定“用户”或“组”，也可以指定 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>