CoreRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends

RestClientBase

Construtores

CoreRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Crie uma equipe em um projeto de equipe.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Excluir uma equipe.
getAllTeams(boolean, number, number, boolean)	Obtenha uma lista de todas as equipas.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Obtenha um processo por ID.
getProcesses()	Obtenha uma lista de processos.
getProject(string, boolean, boolean)	Obtenha o projeto com o id ou nome especificado, opcionalmente incluindo recursos.
getProjectCollection(string)	Obtenha a coleção de projetos com o id ou nome especificado.
getProjectCollections(number, number)	Obtenha referências de coleção de projetos para este aplicativo.
getProjectHistoryEntries(number)	Obtém o histórico de alterações no projeto.
getProjectProperties(string, string[])	Obtenha uma coleção de propriedades do projeto de equipe.
getProjects(any, number, number, number, boolean)	Obtenha todos os projetos na organização aos quais o usuário autenticado tem acesso.
getProjectsProperties(string[], string[])	Obtenha uma coleção de propriedades de projeto de equipe para vários projetos.
getProjectTeamsByCategory(string, boolean, number, number)	Obtém a lista de equipes legíveis pelo usuário em um projeto e as equipes das quais o usuário é membro (excluído da lista legível).
getProxies(string)
getTeam(string, string, boolean)	Obtenha uma equipa específica.
getTeamMembersWithExtendedProperties(string, string, number, number)	Obtenha uma lista de membros para uma equipe específica.
getTeams(string, boolean, number, number, boolean)	Obtenha uma lista de equipas.
queueCreateProject(TeamProject)	Enfileira um projeto a ser criado. Use o GetOperation para verificar periodicamente o status de criação do projeto.
queueDeleteProject(string)	Enfileira um projeto a ser excluído. Use o GetOperation para verificar periodicamente o status do projeto de exclusão.
removeProjectAvatar(string)	Remove o avatar do projeto.
setProjectAvatar(ProjectAvatar, string)	Define o avatar para o projeto.
setProjectProperties(string, JsonPatchDocument)	Crie, atualize e exclua propriedades do projeto de equipe.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Atualize o nome, a abreviatura, a descrição ou restaure um projeto existente.
updateTeam(WebApiTeam, string, string)	Atualize o nome e/ou a descrição de uma equipa.

Detalhes do Construtor

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parâmetros

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Devoluções

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parâmetros

mruData

IdentityData

mruName

string

Devoluções

Promise<void>

createOrUpdateProxy(Proxy)

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

Parâmetros

proxy

Proxy

Devoluções

Promise<Proxy>

createTeam(WebApiTeam, string)

Crie uma equipe em um projeto de equipe.

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

Parâmetros

team

WebApiTeam

Os dados da equipe usados para criar a equipe.

projectId

string

O nome ou ID (GUID) do projeto de equipe no qual criar a equipe.

Devoluções

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parâmetros

mruData

IdentityData

mruName

string

Devoluções

Promise<void>

deleteProxy(string, string)

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

Parâmetros

proxyUrl

string

site

string

Devoluções

Promise<void>

deleteTeam(string, string)

Excluir uma equipe.

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

Parâmetros

projectId

string

O nome ou ID (GUID) do projeto de equipe que contém a equipe a ser excluída.

teamId

string

O nome ou ID da equipa a eliminar.

Devoluções

Promise<void>

getAllTeams(boolean, number, number, boolean)

Obtenha uma lista de todas as equipas.

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

Parâmetros

mine

boolean

Se verdadeiro, retorne todas as equipes que solicitam que o usuário seja membro. Caso contrário, retorne todas as equipes que o usuário tem acesso de leitura.

top

number

Número máximo de equipas a regressar.

skip

number

Número de equipas a ignorar.

expandIdentity

boolean

Um valor que indica se as informações de Identity devem ou não ser expandidas no objeto WebApiTeam resultante.

Devoluções

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parâmetros

projectId

string

name

string

Devoluções

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parâmetros

projectId

string

kind

ConnectedServiceKind

Devoluções

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parâmetros

mruName

string

Devoluções

Promise<IdentityRef[]>

getProcessById(string)

Obtenha um processo por ID.

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

Parâmetros

processId

string

ID de um processo.

Devoluções

Promise<Process>

getProcesses()

Obtenha uma lista de processos.

function getProcesses(): Promise<Process[]>

Devoluções

Promise<Process[]>

getProject(string, boolean, boolean)

Obtenha o projeto com o id ou nome especificado, opcionalmente incluindo recursos.

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

Parâmetros

projectId

string

includeCapabilities

boolean

Inclua recursos (como controle do código-fonte) no resultado do projeto de equipe (padrão: false).

includeHistory

boolean

Pesquise dentro de projetos renomeados (que tinham esse nome no passado).

Devoluções

Promise<TeamProject>

getProjectCollection(string)

Obtenha a coleção de projetos com o id ou nome especificado.

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

Parâmetros

collectionId

string

Devoluções

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Obtenha referências de coleção de projetos para este aplicativo.

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

Parâmetros

top

number

skip

number

Devoluções

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

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

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

Parâmetros

minRevision

number

O número mínimo de revisão a ser retornado no histórico.

Devoluções

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

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

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

Parâmetros

projectId

string

O ID do projeto de equipe.

keys

string[]

Uma cadeia de caracteres delimitada por vírgulas de nomes de propriedades de projeto de equipe. Caracteres curinga ("?" e "*") são suportados. Se nenhuma chave for especificada, todas as propriedades serão retornadas.

Devoluções

Promise<ProjectProperty[]>

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

Obtenha todos os projetos na organização aos quais o usuário autenticado tem acesso.

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

Parâmetros

stateFilter

any

Filtre em projetos de equipe em um estado de projeto de equipe específico (padrão: WellFormed).

top

number

skip

number

continuationToken

number

Ponteiro que mostra quantos projetos já foram buscados.

getDefaultTeamImageUrl

boolean

Devoluções

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

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

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

Parâmetros

projectIds

string[]

Uma cadeia de caracteres delimitada por vírgulas de IDs de projeto de equipe

properties

string[]

Devoluções

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Obtém a lista de equipes legíveis pelo usuário em um projeto e as equipes das quais o usuário é membro (excluído da lista legível).

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

Parâmetros

projectId

string

O nome ou ID (GUID) do projeto de equipe que contém as equipes a serem recuperadas.

expandIdentity

boolean

Um valor que indica se as informações de Identity devem ou não ser expandidas no objeto WebApiTeam resultante.

top

number

Número máximo de equipas a regressar.

skip

number

Número de equipas a ignorar.

Devoluções

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parâmetros

proxyUrl

string

Devoluções

Promise<Proxy[]>

getTeam(string, string, boolean)

Obtenha uma equipa específica.

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

Parâmetros

projectId

string

O nome ou ID (GUID) do projeto de equipe que contém a equipe.

teamId

string

O nome ou ID (GUID) da equipe.

expandIdentity

boolean

Um valor que indica se as informações de Identity devem ou não ser expandidas no objeto WebApiTeam resultante.

Devoluções

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

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

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

Parâmetros

projectId

string

O nome ou ID (GUID) do projeto de equipe ao qual a equipe pertence.

teamId

string

O nome ou ID (GUID) da equipe.

top

number

skip

number

Devoluções

Promise<TeamMember[]>

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

Obtenha uma lista de equipas.

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

Parâmetros

projectId

string

mine

boolean

Se true retornar todas as equipes que solicitam usuário é membro, caso contrário, retornar todas as equipes usuário tem acesso de leitura.

top

number

Número máximo de equipas a regressar.

skip

number

Número de equipas a ignorar.

expandIdentity

boolean

Um valor que indica se as informações de Identity devem ou não ser expandidas no objeto WebApiTeam resultante.

Devoluções

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Enfileira um projeto a ser criado. Use o GetOperation para verificar periodicamente o status de criação do projeto.

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

Parâmetros

projectToCreate

TeamProject

O projeto a criar.

Devoluções

Promise<OperationReference>

queueDeleteProject(string)

Enfileira um projeto a ser excluído. Use o GetOperation para verificar periodicamente o status do projeto de exclusão.

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

Parâmetros

projectId

string

A id do projeto a ser excluído.

Devoluções

Promise<OperationReference>

removeProjectAvatar(string)

Remove o avatar do projeto.

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

Parâmetros

projectId

string

O ID ou nome do projeto.

Devoluções

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Define o avatar para o projeto.

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

Parâmetros

avatarBlob

ProjectAvatar

O objeto de dados blob avatar para carregar.

projectId

string

O ID ou nome do projeto.

Devoluções

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Crie, atualize e exclua propriedades do projeto de equipe.

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

Parâmetros

projectId

string

O ID do projeto de equipe.

patchDocument

JsonPatchDocument

Um documento de patch JSON que representa uma matriz de operações de propriedade. Consulte RFC 6902 para obter mais detalhes sobre o JSON Patch. Os verbos de operação aceitos são Adicionar e Remover, onde Adicionar é usado para criar e atualizar propriedades. O caminho consiste em uma barra e um nome de propriedade.

Devoluções

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parâmetros

mruData

IdentityData

mruName

string

Devoluções

Promise<void>

updateProject(TeamProject, string)

Atualize o nome, a abreviatura, a descrição ou restaure um projeto existente.

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

Parâmetros

projectUpdate

TeamProject

As atualizações para o projeto. O estado deve ser definido como wellFormed para restaurar o projeto.

projectId

string

A ID do projeto a ser atualizado.

Devoluções

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

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

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

Parâmetros

teamData

WebApiTeam

projectId

string

O nome ou ID (GUID) do projeto de equipe que contém a equipe a ser atualizada.

teamId

string

O nome do ID da equipe a ser atualizada.

Devoluções

Promise<WebApiTeam>