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)	설명자로 식별된 scope 가져옵니다.
getServicePrincipal(string)	설명자로 서비스 주체를 가져옵니다.
getStorageKey(string)	스토리지 키에 대한 설명자를 확인합니다.
getSubject(string)	사용자, 그룹 또는 scope 설명자를 확인합니다.
getUser(string)	설명자로 사용자를 가져옵니다.
listMemberships(string, GraphTraversalDirection, number)	이 설명자가 관계의 멤버인 모든 멤버 자격을 가져옵니다.
lookupMembers(GraphSubjectLookup)	현재 scope 요청된 모든 멤버(일반적으로 organization 또는 계정)를 가져옵니다.
lookupMembershipTraversals(GraphSubjectLookup, GraphTraversalDirection, number)	지정된 주체 설명자의 멤버 자격을 트래버스합니다.
lookupSubjects(GraphSubjectLookup)	일괄 처리에서 사용자, 그룹 또는 범위(주체)에 대한 설명자를 확인합니다.
querySubjects(GraphSubjectQuery)	Azure Devops 사용자 또는/및 그룹에 대한 Search. 결과는 그래프 주체가 100개 이하인 일괄 처리로 반환됩니다.
removeMembership(string, string)	컨테이너와 주체 간의 멤버 자격을 삭제합니다.
requestAccess(any)
resolve(IdentityMappings)	사용자 목록을 새 사용자에게 일괄 매핑합니다.
setAvatar(Avatar, string)
translate(string, string)	ID 번역 - 엔드포인트 번역은 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

그룹을 만들어야 하는 scope(컬렉션, 프로젝트)를 참조하는 설명자입니다. 생략하면 은 바깥쪽 계정 또는 organization scope 만들어집니다. 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

resolve 제목(사용자, 그룹, scope 등)의 스토리지 키

반환

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

주체(사용자, 그룹, scope 등)의 검사 상태에 대한 설명자

반환

Promise<GraphMembershipState>

getProviderInfo(string)

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

매개 변수

userDescriptor

string

반환

Promise<GraphProviderInfo>

getScope(string)

설명자로 식별된 scope 가져옵니다.

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

매개 변수

scopeDescriptor

string

scope 고유하게 식별하는 설명자입니다.

반환

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)

사용자, 그룹 또는 scope 설명자를 확인합니다.

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)

현재 scope 요청된 모든 멤버(일반적으로 organization 또는 계정)를 가져옵니다.

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

검색할 주제의 하위 집합을 지정하는 설명자 목록입니다. 각 설명자는 모든 instance 범위에서 제목을 고유하게 식별하지만 한 지점에서만 식별합니다.

반환

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

querySubjects(GraphSubjectQuery)

Azure Devops 사용자 또는/및 그룹에 대한 Search. 결과는 그래프 주체가 100개 이하인 일괄 처리로 반환됩니다.

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

매개 변수

subjectQuery

GraphSubjectQuery

검색에 사용할 쿼리에는 쿼리: 검색 용어가 포함됩니다. 검색은 접두사만 일치합니다. SubjectKind: "User" 또는 "Group"을 지정할 수 있습니다. 둘 다 또는 ScopeDescriptor: 기본이 아닌 scope 지정할 수 있습니다(예: 프로젝트 scope 설명자).

반환

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)

ID 번역 - 엔드포인트 번역은 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>