CoreRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

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)	Получение процесса по идентификатору.
getProcesses()	Получение списка процессов.
getProject(string, boolean, boolean)	Получите проект с указанным идентификатором или именем, при необходимости включая возможности.
getProjectCollection(string)	Получение коллекции проектов с указанным идентификатором или именем.
getProjectCollections(number, number)	Получение ссылок на коллекцию проектов для этого приложения.
getProjectHistoryEntries(number)	Возвращает журнал изменений проекта.
getProjectProperties(string, string[])	Получение коллекции свойств командного проекта.
getProjects(any, number, number, number, boolean)	Получение всех проектов в организации, к которым у пользователя, прошедшего проверку подлинности, есть доступ.
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

Имя или идентификатор (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

Имя или идентификатор (GUID) командного проекта, содержащего удаляемую команду.

teamId

string

Имя или идентификатор удаляемой команды.

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

Promise<void>

getAllTeams(boolean, number, number, boolean)

Получение списка всех команд.

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

Параметры

mine

boolean

Если задано значение true, возвращаются все команды, запрашивающие, что пользователь является участником. В противном случае верните все пользователи Teams, которые имеют доступ на чтение.

top

number

Максимальное количество команд для возвращения.

skip

number

Количество команд, которые нужно пропустить.

expandIdentity

boolean

Значение, указывающее, следует ли развернуть сведения об удостоверениях в результирующем объекте WebApiTeam.

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

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)

Получение процесса по идентификатору.

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

Параметры

processId

string

Идентификатор процесса.

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

Promise<Process>

getProcesses()

Получение списка процессов.

function getProcesses(): Promise<Process[]>

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

Promise<Process[]>

getProject(string, boolean, boolean)

Получите проект с указанным идентификатором или именем, при необходимости включая возможности.

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

Параметры

projectId

string

includeCapabilities

boolean

Включите возможности (например, систему управления версиями) в результат командного проекта (по умолчанию: false).

includeHistory

boolean

Поиск в переименованных проектах (которые имели такое имя в прошлом).

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

Promise<TeamProject>

getProjectCollection(string)

Получение коллекции проектов с указанным идентификатором или именем.

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

Идентификатор командного проекта.

keys

string[]

Строка с разделителями-запятыми имен свойств командного проекта. Поддерживаются подстановочные знаки ("?" и "*"). Если ключ не указан, возвращаются все свойства.

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

Promise<ProjectProperty[]>

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

Получение всех проектов в организации, к которым у пользователя, прошедшего проверку подлинности, есть доступ.

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

Строка идентификаторов командных проектов с разделителями-запятыми

properties

string[]

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

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Возвращает список доступных для чтения команд в проекте, в которые входит пользователь (исключается из списка для чтения).

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

Параметры

projectId

string

Имя или идентификатор (GUID) командного проекта, содержащего извлекаемую команду.

expandIdentity

boolean

Значение, указывающее, следует ли развернуть сведения об удостоверениях в результирующем объекте WebApiTeam.

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

Имя или идентификатор (GUID) командного проекта, содержащего команду.

teamId

string

Имя или идентификатор (GUID) команды.

expandIdentity

boolean

Значение, указывающее, следует ли развернуть сведения об удостоверениях в результирующем объекте WebApiTeam.

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

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Получение списка участников для определенной команды.

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

Параметры

projectId

string

Имя или идентификатор (GUID) командного проекта, к которому принадлежит команда.

teamId

string

Имя или идентификатор (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, возвращает все команды, запрашивающие пользователя, являются участниками, в противном случае возвращается все пользователи teams, у которого есть доступ на чтение.

top

number

Максимальное количество команд для возвращения.

skip

number

Количество команд, которые нужно пропустить.

expandIdentity

boolean

Значение, указывающее, следует ли развернуть сведения об удостоверениях в результирующем объекте WebApiTeam.

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

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

Идентификатор удаляемого проекта.

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

Promise<OperationReference>

removeProjectAvatar(string)

Удаляет аватар для проекта.

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

Параметры

projectId

string

Идентификатор или имя проекта.

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

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Задает аватар для проекта.

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

Параметры

avatarBlob

ProjectAvatar

Объект данных большого двоичного объекта аватара для отправки.

projectId

string

Идентификатор или имя проекта.

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

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Создание, обновление и удаление свойств командного проекта.

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

Параметры

projectId

string

Идентификатор командного проекта.

patchDocument

JsonPatchDocument

Документ JSON Patch, представляющий массив операций со свойствами. Дополнительные сведения о исправлении JSON см. в документе RFC 6902. Допустимые команды операций: Add и Remove, где 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

Идентификатор проекта для обновления.

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

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Обновите имя и описание команды.

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

Параметры

teamData

WebApiTeam

projectId

string

Имя или идентификатор (GUID) командного проекта, содержащего команду для обновления.

teamId

string

Имя идентификатора обновляемой команды.

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

Promise<WebApiTeam>