CoreRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

CoreRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Crear un equipo en un proyecto de equipo.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Eliminar un equipo.
getAllTeams(boolean, number, number, boolean)	Obtén una lista de todos los equipos.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Obtener un proceso por ID.
getProcesses()	Obtenga una lista de procesos.
getProject(string, boolean, boolean)	Obtenga el proyecto con el identificador o el nombre especificados, que opcionalmente incluyen funcionalidades.
getProjectCollection(string)	Obtenga la colección de proyectos con el identificador o el nombre especificados.
getProjectCollections(number, number)	Obtenga referencias de colección de proyectos para esta aplicación.
getProjectHistoryEntries(number)	Obtiene el historial de cambios en el proyecto.
getProjectProperties(string, string[])	Obtenga una colección de propiedades de proyecto de equipo.
getProjects(any, number, number, number, boolean)	Obtenga todos los proyectos de la organización a los que tiene acceso el usuario autenticado.
getProjectsProperties(string[], string[])	Obtenga una colección de propiedades de proyecto de equipo para varios proyectos.
getProjectTeamsByCategory(string, boolean, number, number)	Obtiene una lista de equipos legibles por el usuario en un proyecto y equipos de los que es miembro el usuario (excluido de la lista legible).
getProxies(string)
getTeam(string, string, boolean)	Consigue un equipo específico.
getTeamMembersWithExtendedProperties(string, string, number, number)	Obtén una lista de miembros para un equipo específico.
getTeams(string, boolean, number, number, boolean)	Obtén una lista de equipos.
queueCreateProject(TeamProject)	Pone en cola un proyecto que se va a crear. Use GetOperation para comprobar periódicamente el estado de creación del proyecto.
queueDeleteProject(string)	Pone en cola un proyecto para que se elimine. Use GetOperation para comprobar periódicamente el estado de eliminación del proyecto.
removeProjectAvatar(string)	Elimina el avatar del proyecto.
setProjectAvatar(ProjectAvatar, string)	Establece el avatar del proyecto.
setProjectProperties(string, JsonPatchDocument)	Crear, actualizar y eliminar propiedades del proyecto de equipo.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Actualice el nombre, la abreviatura, la descripción de un proyecto existente o restaure un proyecto.
updateTeam(WebApiTeam, string, string)	Actualizar el nombre y/o la descripción de un equipo.

Detalles del constructor

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parámetros

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Devoluciones

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parámetros

mruData

IdentityData

mruName

string

Devoluciones

Promise<void>

createOrUpdateProxy(Proxy)

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

Parámetros

proxy

Proxy

Devoluciones

Promise<Proxy>

createTeam(WebApiTeam, string)

Crear un equipo en un proyecto de equipo.

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

Parámetros

team

WebApiTeam

Los datos del equipo utilizados para crear el equipo.

projectId

string

Nombre o identificador (GUID) del proyecto de equipo en el que se va a crear el equipo.

Devoluciones

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parámetros

mruData

IdentityData

mruName

string

Devoluciones

Promise<void>

deleteProxy(string, string)

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

Parámetros

proxyUrl

string

site

string

Devoluciones

Promise<void>

deleteTeam(string, string)

Eliminar un equipo.

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

Parámetros

projectId

string

Nombre o identificador (GUID) del proyecto de equipo que contiene el equipo que se va a eliminar.

teamId

string

El nombre o ID del equipo que se va a eliminar.

Devoluciones

Promise<void>

getAllTeams(boolean, number, number, boolean)

Obtén una lista de todos los equipos.

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

Parámetros

mine

boolean

Si es true, devuelve todos los equipos que solicitan que el usuario sea miembro. De lo contrario, devuelve todos los equipos que el usuario tiene acceso de lectura.

top

number

Número máximo de equipos que se van a devolver.

skip

number

Número de equipos que se deben omitir.

expandIdentity

boolean

Valor que indica si se va a expandir o no la información de identidad en el objeto WebApiTeam de resultado.

Devoluciones

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parámetros

projectId

string

name

string

Devoluciones

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parámetros

projectId

string

kind

ConnectedServiceKind

Devoluciones

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parámetros

mruName

string

Devoluciones

Promise<IdentityRef[]>

getProcessById(string)

Obtener un proceso por ID.

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

Parámetros

processId

string

ID de un proceso.

Devoluciones

Promise<Process>

getProcesses()

Obtenga una lista de procesos.

function getProcesses(): Promise<Process[]>

Devoluciones

Promise<Process[]>

getProject(string, boolean, boolean)

Obtenga el proyecto con el identificador o el nombre especificados, que opcionalmente incluyen funcionalidades.

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

Parámetros

projectId

string

includeCapabilities

boolean

Incluya funcionalidades (como el control de código fuente) en el resultado del proyecto de equipo (valor predeterminado: false).

includeHistory

boolean

Busque dentro de proyectos renombrados (que tenían ese nombre en el pasado).

Devoluciones

Promise<TeamProject>

getProjectCollection(string)

Obtenga la colección de proyectos con el identificador o el nombre especificados.

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

Parámetros

collectionId

string

Devoluciones

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Obtenga referencias de colección de proyectos para esta aplicación.

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

Parámetros

top

number

skip

number

Devoluciones

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Obtiene el historial de cambios en el proyecto.

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

Parámetros

minRevision

number

El número mínimo de revisión que se devolverá en el historial.

Devoluciones

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Obtenga una colección de propiedades de proyecto de equipo.

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

Parámetros

projectId

string

El identificador del proyecto de equipo.

keys

string[]

Cadena delimitada por comas de nombres de propiedad de proyecto de equipo. Se admiten caracteres comodín ("?" y "*"). Si no se especifica ninguna clave, se devolverán todas las propiedades.

Devoluciones

Promise<ProjectProperty[]>

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

Obtenga todos los proyectos de la organización a los que tiene acceso el usuario autenticado.

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

Parámetros

stateFilter

any

Filtrar por proyectos de equipo en un estado de proyecto de equipo específico (predeterminado: WellFormed).

top

number

skip

number

continuationToken

number

Puntero que muestra cuántos proyectos ya se han capturado.

getDefaultTeamImageUrl

boolean

Devoluciones

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Obtenga una colección de propiedades de proyecto de equipo para varios proyectos.

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

Parámetros

projectIds

string[]

Una cadena delimitada por comas de identificadores de proyecto de equipo

properties

string[]

Devoluciones

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Obtiene una lista de equipos legibles por el usuario en un proyecto y equipos de los que es miembro el usuario (excluido de la lista legible).

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

Parámetros

projectId

string

Nombre o identificador (GUID) del proyecto de equipo que contiene los equipos que se van a recuperar.

expandIdentity

boolean

Valor que indica si se va a expandir o no la información de identidad en el objeto WebApiTeam de resultado.

top

number

Número máximo de equipos que se van a devolver.

skip

number

Número de equipos que se deben omitir.

Devoluciones

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parámetros

proxyUrl

string

Devoluciones

Promise<Proxy[]>

getTeam(string, string, boolean)

Consigue un equipo específico.

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

Parámetros

projectId

string

Nombre o identificador (GUID) del proyecto de equipo que contiene el equipo.

teamId

string

El nombre o identificador (GUID) del equipo.

expandIdentity

boolean

Valor que indica si se va a expandir o no la información de identidad en el objeto WebApiTeam de resultado.

Devoluciones

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Obtén una lista de miembros para un equipo específico.

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

Parámetros

projectId

string

El nombre o identificador (GUID) del proyecto de equipo al que pertenece el equipo.

teamId

string

El nombre o identificador (GUID) del equipo.

top

number

skip

number

Devoluciones

Promise<TeamMember[]>

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

Obtén una lista de equipos.

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

Parámetros

projectId

string

mine

boolean

Si es true, devuelve todos los equipos que solicitan que el usuario sea miembro, de lo contrario, devuelve todos los equipos que el usuario tiene acceso de lectura.

top

number

Número máximo de equipos que se van a devolver.

skip

number

Número de equipos que se deben omitir.

expandIdentity

boolean

Valor que indica si se va a expandir o no la información de identidad en el objeto WebApiTeam de resultado.

Devoluciones

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Pone en cola un proyecto que se va a crear. Use GetOperation para comprobar periódicamente el estado de creación del proyecto.

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

Parámetros

projectToCreate

TeamProject

El proyecto a crear.

Devoluciones

Promise<OperationReference>

queueDeleteProject(string)

Pone en cola un proyecto para que se elimine. Use GetOperation para comprobar periódicamente el estado de eliminación del proyecto.

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

Parámetros

projectId

string

El identificador del proyecto que se va a eliminar.

Devoluciones

Promise<OperationReference>

removeProjectAvatar(string)

Elimina el avatar del proyecto.

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

Parámetros

projectId

string

El ID o el nombre del proyecto.

Devoluciones

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Establece el avatar del proyecto.

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

Parámetros

avatarBlob

ProjectAvatar

El objeto de datos de blob de avatar que se va a cargar.

projectId

string

El ID o el nombre del proyecto.

Devoluciones

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Crear, actualizar y eliminar propiedades del proyecto de equipo.

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

Parámetros

projectId

string

El identificador del proyecto de equipo.

patchDocument

JsonPatchDocument

Un documento de revisión JSON que representa una matriz de operaciones de propiedad. Consulte RFC 6902 para obtener más detalles sobre el parche JSON. Los verbos de operación aceptados son Add y Remove, donde Add se usa para crear y actualizar propiedades. La ruta de acceso consta de una barra diagonal y un nombre de propiedad.

Devoluciones

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parámetros

mruData

IdentityData

mruName

string

Devoluciones

Promise<void>

updateProject(TeamProject, string)

Actualice el nombre, la abreviatura, la descripción de un proyecto existente o restaure un proyecto.

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

Parámetros

projectUpdate

TeamProject

Las actualizaciones del proyecto. El estado debe establecerse en wellFormed para restaurar el proyecto.

projectId

string

El identificador del proyecto que se va a actualizar.

Devoluciones

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Actualizar el nombre y/o la descripción de un equipo.

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

Parámetros

teamData

WebApiTeam

projectId

string

Nombre o identificador (GUID) del proyecto de equipo que contiene el equipo que se va a actualizar.

teamId

string

El nombre del identificador del equipo que se va a actualizar.

Devoluciones

Promise<WebApiTeam>