GraphRestClient class
應該使用 (衍生自) 的基類，向 VSS REST API 提出要求
- Extends
建構函式
| Graph |
屬性
| RESOURCE_AREA_ID |
方法
建構函式詳細資料
GraphRestClient(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()
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：可以指定 “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>