CoreRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às 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)	Criar uma equipa num projeto de equipa.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Eliminar uma equipa.
getAllTeams(boolean, number, number, boolean)	Obtenha uma lista de todas as equipas.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Obter um processo por ID.
getProcesses()	Obtenha uma lista de processos.
getProject(string, boolean, boolean)	Obtenha o projeto com o ID ou nome especificado, incluindo opcionalmente as capacidades.
getProjectCollection(string)	Obtenha a coleção de projetos com o ID ou o nome especificados.
getProjectCollections(number, number)	Obtenha referências de coleções de projetos para esta aplicação.
getProjectHistoryEntries(number)	Obtém o histórico de alterações ao projeto.
getProjectProperties(string, string[])	Obtenha uma coleção de propriedades do projeto de equipa.
getProjects(any, number, number, number, boolean)	Obtenha todos os projetos na organização aos quais o utilizador autenticado tem acesso.
getProjectsProperties(string[], string[])	Obtenha uma coleção de propriedades do projeto de equipa para vários projetos.
getProjectTeamsByCategory(string, boolean, number, number)	Obtém a lista de equipas legíveis pelo utilizador num projeto e o utilizador do teams é 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 equipa específica.
getTeams(string, boolean, number, number, boolean)	Obtenha uma lista de equipas.
queueCreateProject(TeamProject)	Coloca em fila um projeto a ser criado. Utilize GetOperation para verificar periodicamente a criação do estado do projeto.
queueDeleteProject(string)	Coloca em fila um projeto a eliminar. Utilize GetOperation para verificar periodicamente a eliminação do estado do projeto.
removeProjectAvatar(string)	Remove o avatar do projeto.
setProjectAvatar(ProjectAvatar, string)	Define o avatar para o projeto.
setProjectProperties(string, JsonPatchDocument)	Criar, atualizar e eliminar propriedades do projeto de equipa.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Atualize o nome, abreviatura, descrição ou restauro de 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)

Criar uma equipa num projeto de equipa.

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

Parâmetros

team

WebApiTeam

Os dados da equipa utilizados para criar a equipa.

projectId

string

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

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)

Eliminar uma equipa.

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

Parâmetros

projectId

string

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

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 for verdade, devolva todas as equipas que pedem que o utilizador seja membro. Caso contrário, devolva que todos os utilizadores de equipas têm acesso de leitura.

top

number

Número máximo de equipas a devolver.

skip

number

Número de equipas a ignorar.

expandIdentity

boolean

Um valor que indica se pretende ou não expandir as informações de Identidade no objeto WebApiTeam do resultado.

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)

Obter um processo por ID.

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

Parâmetros

processId

string

ID para 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, incluindo opcionalmente as capacidades.

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

Parâmetros

projectId

string

includeCapabilities

boolean

Inclua capacidades (como o controlo de origem) no resultado do projeto de equipa (predefinição: falso).

includeHistory

boolean

Pesquise em projetos com o nome mudado (que tinham esse nome no passado).

Devoluções

Promise<TeamProject>

getProjectCollection(string)

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

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

Parâmetros

collectionId

string

Devoluções

Promise<TeamProjectCollection>

getProjectCollections(number, number)

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

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 ao projeto.

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

Parâmetros

minRevision

number

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

Devoluções

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

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

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

Parâmetros

projectId

string

O ID do projeto de equipa.

keys

string[]

Uma cadeia delimitada por vírgulas de nomes de propriedades de projeto de equipa. São suportados carateres universais ("?" e "*"). Se não for especificada nenhuma chave, todas as propriedades serão devolvidas.

Devoluções

Promise<ProjectProperty[]>

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

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

stateFilter

any

Filtre em projetos de equipa num estado de projeto de equipa específico (predefinição: Bem Formatado).

top

number

skip

number

continuationToken

number

Ponteiro que mostra quantos projetos já foram obtidos.

getDefaultTeamImageUrl

boolean

Devoluções

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

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

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

Parâmetros

projectIds

string[]

Uma cadeia delimitada por vírgulas de IDs de projeto de equipa

properties

string[]

Devoluções

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

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

projectId

string

O nome ou ID (GUID) do projeto de equipa que contém as equipas a obter.

expandIdentity

boolean

Um valor que indica se pretende ou não expandir as informações de Identidade no objeto WebApiTeam do resultado.

top

number

Número máximo de equipas a devolver.

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 equipa que contém a equipa.

teamId

string

O nome ou ID (GUID) da equipa.

expandIdentity

boolean

Um valor que indica se pretende ou não expandir as informações de Identidade no objeto WebApiTeam do resultado.

Devoluções

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Obtenha uma lista de membros para uma equipa 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 equipa a que a equipa pertence.

teamId

string

O nome ou ID (GUID) da equipa .

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 a devolução verdadeira de todas as equipas que solicitam o utilizador for membro, caso contrário, devolverá todo o acesso de leitura a todos os utilizadores das equipas.

top

number

Número máximo de equipas a devolver.

skip

number

Número de equipas a ignorar.

expandIdentity

boolean

Um valor que indica se pretende ou não expandir as informações de Identidade no objeto WebApiTeam do resultado.

Devoluções

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

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

projectToCreate

TeamProject

O projeto a criar.

Devoluções

Promise<OperationReference>

queueDeleteProject(string)

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

projectId

string

O ID do projeto a eliminar.

Devoluções

Promise<OperationReference>

removeProjectAvatar(string)

Remove o avatar do projeto.

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

Parâmetros

projectId

string

O ID ou o 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 de blob do avatar a carregar.

projectId

string

O ID ou o nome do projeto.

Devoluções

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Criar, atualizar e eliminar propriedades do projeto de equipa.

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

Parâmetros

projectId

string

O ID do projeto de equipa.

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 Patch JSON. Os verbos de operação aceites são Adicionar e Remover, em que Adicionar é utilizado para criar e atualizar propriedades. O caminho consiste numa barra reencaminhada e num 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, abreviatura, descrição ou restauro de um projeto existente.

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

Parâmetros

projectUpdate

TeamProject

As atualizações do projeto. O estado tem de estar definido como bemFormado para restaurar o projeto.

projectId

string

O ID do projeto a atualizar.

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 equipa que contém a equipa a atualizar.

teamId

string

O nome do ID da equipa a atualizar.

Devoluções

Promise<WebApiTeam>