CoreRestClient class

패키지:

azure-devops-extension-api

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends

RestClientBase

생성자

CoreRestClient(IVssRestClientOptions)

속성

RESOURCE_AREA_ID

메서드

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	팀 프로젝트에서 팀을 만듭니다.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	팀을 삭제합니다.
getAllTeams(boolean, number, number, boolean)	모든 팀의 목록을 가져옵니다.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	ID로 프로세스를 가져옵니다.
getProcesses()	프로세스 목록을 가져옵니다.
getProject(string, boolean, boolean)	필요에 따라 기능을 포함하여 지정된 ID 또는 이름을 가진 프로젝트를 가져옵니다.
getProjectCollection(string)	지정된 ID 또는 이름을 사용하여 프로젝트 컬렉션을 가져옵니다.
getProjectCollections(number, number)	이 애플리케이션에 대한 프로젝트 컬렉션 참조를 가져옵니다.
getProjectHistoryEntries(number)	프로젝트 변경 기록을 가져옵니다.
getProjectProperties(string, string[])	팀 프로젝트 속성의 컬렉션을 가져옵니다.
getProjects(any, number, number, number, boolean)	인증된 사용자가 액세스할 수 있는 organization 모든 프로젝트를 가져옵니다.
getProjectsProperties(string[], string[])	여러 프로젝트에 대한 팀 프로젝트 속성 컬렉션을 가져옵니다.
getProjectTeamsByCategory(string, boolean, number, number)	프로젝트에서 사용자가 읽을 수 있는 팀의 목록을 가져오고 사용자가 멤버인 팀(읽을 수 있는 목록에서 제외됨).
getProxies(string)
getTeam(string, string, boolean)	특정 팀을 가져옵니다.
getTeamMembersWithExtendedProperties(string, string, number, number)	특정 팀의 멤버 목록을 가져옵니다.
getTeams(string, boolean, number, number, boolean)	팀 목록을 가져옵니다.
queueCreateProject(TeamProject)	만들 프로젝트를 큐에 대기합니다. GetOperation을 사용하여 프로젝트 상태 만들기 위해 주기적으로 검사.
queueDeleteProject(string)	삭제할 프로젝트를 큐에 대기합니다. GetOperation을 사용하여 프로젝트 상태 삭제하기 위해 주기적으로 검사.
removeProjectAvatar(string)	프로젝트의 아바타를 제거합니다.
setProjectAvatar(ProjectAvatar, string)	프로젝트의 아바타를 설정합니다.
setProjectProperties(string, JsonPatchDocument)	팀 프로젝트 속성을 만들고 업데이트하고 삭제합니다.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	기존 프로젝트의 이름, 약어, 설명 또는 프로젝트 복원을 업데이트합니다.
updateTeam(WebApiTeam, string, string)	팀의 이름 및/또는 설명을 업데이트합니다.

생성자 세부 정보

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

매개 변수

options

IVssRestClientOptions

속성 세부 정보

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

속성 값

string

메서드 세부 정보

createConnectedService(WebApiConnectedServiceDetails, string)

function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>

매개 변수

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

반환

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

매개 변수

mruData

IdentityData

mruName

string

반환

Promise<void>

createOrUpdateProxy(Proxy)

function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>

매개 변수

proxy

Proxy

반환

Promise<Proxy>

createTeam(WebApiTeam, string)

팀 프로젝트에서 팀을 만듭니다.

function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>

매개 변수

team

WebApiTeam

팀을 만드는 데 사용되는 팀 데이터입니다.

projectId

string

팀을 만들 팀 프로젝트의 이름 또는 ID(GUID)입니다.

반환

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

매개 변수

mruData

IdentityData

mruName

string

반환

Promise<void>

deleteProxy(string, string)

function deleteProxy(proxyUrl: string, site?: string): Promise<void>

매개 변수

proxyUrl

string

site

string

반환

Promise<void>

deleteTeam(string, string)

팀을 삭제합니다.

function deleteTeam(projectId: string, teamId: string): Promise<void>

매개 변수

projectId

string

삭제할 팀이 포함된 팀 프로젝트의 이름 또는 ID(GUID)입니다.

teamId

string

삭제할 팀의 이름 또는 ID입니다.

반환

Promise<void>

getAllTeams(boolean, number, number, boolean)

모든 팀의 목록을 가져옵니다.

function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

매개 변수

mine

boolean

true이면 사용자를 요청하는 모든 팀이 구성원임을 반환합니다. 그렇지 않으면 모든 팀 사용자에게 읽기 권한이 반환됩니다.

top

number

반환할 최대 팀 수입니다.

skip

number

건너뛸 팀 수입니다.

expandIdentity

boolean

결과 WebApiTeam 개체에서 ID 정보를 확장할지 여부를 나타내는 값입니다.

반환

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>

매개 변수

projectId

string

name

string

반환

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>

매개 변수

projectId

string

kind

ConnectedServiceKind

반환

Promise<WebApiConnectedService[]>

getIdentityMru(string)

function getIdentityMru(mruName: string): Promise<IdentityRef[]>

매개 변수

mruName

string

반환

Promise<IdentityRef[]>

getProcessById(string)

ID로 프로세스를 가져옵니다.

function getProcessById(processId: string): Promise<Process>

매개 변수

processId

string

프로세스의 ID입니다.

반환

Promise<Process>

getProcesses()

프로세스 목록을 가져옵니다.

function getProcesses(): Promise<Process[]>

반환

Promise<Process[]>

getProject(string, boolean, boolean)

필요에 따라 기능을 포함하여 지정된 ID 또는 이름을 가진 프로젝트를 가져옵니다.

function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>

매개 변수

projectId

string

includeCapabilities

boolean

팀 프로젝트 결과에 기능(예: 소스 제어)을 포함합니다(기본값: false).

includeHistory

boolean

이름이 바뀐 프로젝트(과거에 이러한 이름을 가진 프로젝트) 내에서 검색합니다.

반환

Promise<TeamProject>

getProjectCollection(string)

지정된 ID 또는 이름을 사용하여 프로젝트 컬렉션을 가져옵니다.

function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>

매개 변수

collectionId

string

반환

Promise<TeamProjectCollection>

getProjectCollections(number, number)

이 애플리케이션에 대한 프로젝트 컬렉션 참조를 가져옵니다.

function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>

매개 변수

top

number

skip

number

반환

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

프로젝트 변경 기록을 가져옵니다.

function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>

매개 변수

minRevision

number

기록에 반환할 최소 수정 번호입니다.

반환

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

팀 프로젝트 속성의 컬렉션을 가져옵니다.

function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>

매개 변수

projectId

string

팀 프로젝트 ID입니다.

keys

string[]

팀 프로젝트 속성 이름의 쉼표로 구분된 문자열입니다. 와일드카드 문자("?" 및 "*")가 지원됩니다. 키를 지정하지 않으면 모든 속성이 반환됩니다.

반환

Promise<ProjectProperty[]>

getProjects(any, number, number, number, boolean)

인증된 사용자가 액세스할 수 있는 organization 모든 프로젝트를 가져옵니다.

function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>

매개 변수

stateFilter

any

특정 팀 프로젝트 상태의 팀 프로젝트를 필터링합니다(기본값: WellFormed).

top

number

skip

number

continuationToken

number

이미 페치된 프로젝트 수를 보여 주는 포인터입니다.

getDefaultTeamImageUrl

boolean

반환

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

여러 프로젝트에 대한 팀 프로젝트 속성 컬렉션을 가져옵니다.

function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>

매개 변수

projectIds

string[]

팀 프로젝트 ID의 쉼표로 구분된 문자열

properties

string[]

반환

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

프로젝트에서 사용자가 읽을 수 있는 팀의 목록을 가져오고 사용자가 멤버인 팀(읽을 수 있는 목록에서 제외됨).

function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>

매개 변수

projectId

string

검색할 팀이 포함된 팀 프로젝트의 이름 또는 ID(GUID)입니다.

expandIdentity

boolean

결과 WebApiTeam 개체에서 ID 정보를 확장할지 여부를 나타내는 값입니다.

top

number

반환할 최대 팀 수입니다.

skip

number

건너뛸 팀 수입니다.

반환

Promise<CategorizedWebApiTeams>

getProxies(string)

function getProxies(proxyUrl?: string): Promise<Proxy[]>

매개 변수

proxyUrl

string

반환

Promise<Proxy[]>

getTeam(string, string, boolean)

특정 팀을 가져옵니다.

function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>

매개 변수

projectId

string

팀이 포함된 팀 프로젝트의 이름 또는 ID(GUID)입니다.

teamId

string

팀의 이름 또는 ID(GUID)입니다.

expandIdentity

boolean

결과 WebApiTeam 개체에서 ID 정보를 확장할지 여부를 나타내는 값입니다.

반환

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

특정 팀의 멤버 목록을 가져옵니다.

function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>

매개 변수

projectId

string

팀이 속한 팀 프로젝트의 이름 또는 ID(GUID)입니다.

teamId

string

팀의 이름 또는 ID(GUID)입니다.

top

number

skip

number

반환

Promise<TeamMember[]>

getTeams(string, boolean, number, number, boolean)

팀 목록을 가져옵니다.

function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

매개 변수

projectId

string

mine

boolean

true이면 사용자를 요청하는 모든 팀이 구성원이면 모든 팀 사용자에게 읽기 권한이 있는 것을 반환합니다.

top

number

반환할 최대 팀 수입니다.

skip

number

건너뛸 팀 수입니다.

expandIdentity

boolean

결과 WebApiTeam 개체에서 ID 정보를 확장할지 여부를 나타내는 값입니다.

반환

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

만들 프로젝트를 큐에 대기합니다. GetOperation을 사용하여 프로젝트 상태 만들기 위해 주기적으로 검사.

function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>

매개 변수

projectToCreate

TeamProject

만들 프로젝트입니다.

반환

Promise<OperationReference>

queueDeleteProject(string)

삭제할 프로젝트를 큐에 대기합니다. GetOperation을 사용하여 프로젝트 상태 삭제하기 위해 주기적으로 검사.

function queueDeleteProject(projectId: string): Promise<OperationReference>

매개 변수

projectId

string

삭제할 프로젝트의 프로젝트 ID입니다.

반환

Promise<OperationReference>

removeProjectAvatar(string)

프로젝트의 아바타를 제거합니다.

function removeProjectAvatar(projectId: string): Promise<void>

매개 변수

projectId

string

프로젝트의 ID 또는 이름입니다.

반환

Promise<void>

setProjectAvatar(ProjectAvatar, string)

프로젝트의 아바타를 설정합니다.

function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>

매개 변수

avatarBlob

ProjectAvatar

업로드할 아바타 Blob 데이터 개체입니다.

projectId

string

프로젝트의 ID 또는 이름입니다.

반환

Promise<void>

setProjectProperties(string, JsonPatchDocument)

팀 프로젝트 속성을 만들고 업데이트하고 삭제합니다.

function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>

매개 변수

projectId

string

팀 프로젝트 ID입니다.

patchDocument

JsonPatchDocument

속성 작업의 배열을 나타내는 JSON 패치 문서입니다. JSON 패치에 대한 자세한 내용은 RFC 6902를 참조하세요. 허용되는 작업 동사는 추가 및 제거입니다. 여기서 Add는 속성을 만들고 업데이트하는 데 사용됩니다. 경로는 슬래시와 속성 이름으로 구성됩니다.

반환

Promise<void>

updateIdentityMru(IdentityData, string)

function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

매개 변수

mruData

IdentityData

mruName

string

반환

Promise<void>

updateProject(TeamProject, string)

기존 프로젝트의 이름, 약어, 설명 또는 프로젝트 복원을 업데이트합니다.

function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>

매개 변수

projectUpdate

TeamProject

프로젝트의 업데이트입니다. 프로젝트를 복원하려면 상태를 wellFormed로 설정해야 합니다.

projectId

string

업데이트할 프로젝트의 프로젝트 ID입니다.

반환

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

팀의 이름 및/또는 설명을 업데이트합니다.

function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>

매개 변수

teamData

WebApiTeam

projectId

string

업데이트할 팀이 포함된 팀 프로젝트의 이름 또는 ID(GUID)입니다.

teamId

string

업데이트할 팀의 ID 이름입니다.

반환

Promise<WebApiTeam>