CoreRestClient class

new CoreRestClient(options: IVssRestClientOptions)

Parâmetros

static RESOURCE_AREA_ID: string

Valor de Propriedade

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Criar uma equipa num projeto de equipa.

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Eliminar uma equipa.

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

Parâmetros

Devoluções

Obtenha uma lista de todas as equipas.

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Obter um processo por ID.

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

Parâmetros

Devoluções

Obtenha uma lista de processos.

function getProcesses(): Promise<Process[]>

Devoluções

Obtenha o projeto com o ID ou nome especificado, incluindo opcionalmente as capacidades.

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

Parâmetros

Devoluções

Obtenha a coleção de projetos com o ID ou o nome especificados.

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

Parâmetros

Devoluções

Obtenha referências de coleções de projetos para esta aplicação.

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

Parâmetros

Devoluções

Obtém o histórico de alterações ao projeto.

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

Parâmetros

Devoluções

Obtenha uma coleção de propriedades do projeto de equipa.

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

Parâmetros

Devoluções

Obtenha todos os projetos na organização aos quais o utilizador autenticado tem acesso.

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

Parâmetros

Devoluções

Obtenha uma coleção de propriedades do projeto de equipa para vários projetos.

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

Parâmetros

Devoluções

Obtém a lista de equipas legíveis pelo utilizador num projeto e o utilizador do teams é membro (excluído da lista legível).

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Obtenha uma equipa específica.

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

Parâmetros

Devoluções

Obtenha uma lista de membros para uma equipa específica.

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

Parâmetros

Devoluções

Obtenha uma lista de equipas.

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

Parâmetros

Devoluções

Coloca em fila um projeto a ser criado. Utilize GetOperation para verificar periodicamente a criação do estado do projeto.

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

Parâmetros

Devoluções

Coloca em fila um projeto a eliminar. Utilize GetOperation para verificar periodicamente a eliminação do estado do projeto.

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

Parâmetros

Devoluções

Remove o avatar do projeto.

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

Parâmetros

Devoluções

Define o avatar para o projeto.

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

Parâmetros

Devoluções

Criar, atualizar e eliminar propriedades do projeto de equipa.

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Atualize o nome, abreviatura, descrição ou restauro de um projeto existente.

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

Parâmetros

Devoluções

Atualize o nome e/ou a descrição de uma equipa.

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

Parâmetros

Devoluções