BuildRestClient class

Referencia

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

BuildRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

addBuildTag(string, number, string)	Agrega una etiqueta a una compilación.
addBuildTags(string[], string, number)	Agrega etiquetas a una compilación.
addDefinitionTag(string, number, string)	Agrega una etiqueta a una definición
addDefinitionTags(string[], string, number)	Agrega varias etiquetas a una definición.
addRetentionLeases(NewRetentionLease[], string)	Agrega nuevas concesiones para las ejecuciones de canalización.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Asocia un artefacto a una compilación.
createDefinition(BuildDefinition, string, number, number)	Crea una nueva definición.
createFolder(Folder, string, string)	Crea una nueva carpeta.
deleteBuild(string, number)	Elimina una compilación.
deleteBuildTag(string, number, string)	Quita una etiqueta de una compilación. NOTA: Esta API no funcionará para etiquetas con caracteres especiales. Para quitar etiquetas con caracteres especiales, use el método PATCH en su lugar (en 6.0 y versiones posteriores)
deleteDefinition(string, number)	Elimina una definición y todas las compilaciones asociadas.
deleteDefinitionTag(string, number, string)	Quita una etiqueta de una definición. NOTA: Esta API no funcionará para etiquetas con caracteres especiales. Para quitar etiquetas con caracteres especiales, use el método PATCH en su lugar (en 6.0 y versiones posteriores)
deleteFolder(string, string)	Elimina una carpeta de definición. Las definiciones y sus compilaciones correspondientes también se eliminarán.
deleteRetentionLeasesById(string, number[])	Quita concesiones de retención específicas.
deleteTag(string, string)	Quita una etiqueta de compilaciones, definiciones y del almacén de etiquetas.
deleteTemplate(string, string)	Elimina una plantilla de definición de compilación.
getArtifact(string, number, string)	Obtiene un artefacto específico para una compilación.
getArtifactContentZip(string, number, string)	Obtiene un artefacto específico para una compilación.
getArtifacts(string, number)	Obtiene todos los artefactos de una compilación.
getAttachment(string, number, string, string, string, string)	Obtiene datos adjuntos específicos.
getAttachments(string, number, string)	Obtiene la lista de datos adjuntos de un tipo específico asociado a una compilación.
getBadge(string, number, string)	Obtiene un distintivo que indica el estado de la compilación más reciente de una definición. Tenga en cuenta que esta API está en desuso. Prefiere StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Obtiene una compilación.
getBuildBadge(string, string, string, string)	Obtiene un distintivo que indica el estado de la compilación más reciente para la rama especificada.
getBuildBadgeData(string, string, string, string)	Obtiene un distintivo que indica el estado de la compilación más reciente para la rama especificada.
getBuildChanges(string, number, string, number, boolean)	Obtiene los cambios asociados a una compilación.
getBuildController(number)	Obtiene un controlador.
getBuildControllers(string)	Obtiene el controlador, filtrado opcionalmente por nombre.
getBuildGeneralSettings(string)	Obtiene la configuración general de la canalización.
getBuildLog(string, number, number, number, number)	Obtiene un archivo de registro individual para una compilación.
getBuildLogLines(string, number, number, number, number)	Obtiene un archivo de registro individual para una compilación.
getBuildLogs(string, number)	Obtiene los registros de una compilación.
getBuildLogsZip(string, number)	Obtiene los registros de una compilación.
getBuildLogZip(string, number, number, number, number)	Obtiene un archivo de registro individual para una compilación.
getBuildOptionDefinitions(string)	Obtiene todas las opciones de definición de compilación admitidas por el sistema.
getBuildProperties(string, number, string[])	Obtiene las propiedades de una compilación.
getBuildReport(string, number, string)	Obtiene un informe de compilación.
getBuildReportHtmlContent(string, number, string)	Obtiene un informe de compilación.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Obtiene una lista de compilaciones.
getBuildSettings(string)	Obtiene la configuración de compilación.
getBuildTags(string, number)	Obtiene las etiquetas de una compilación.
getBuildTimeline(string, number, string, number, string)	Obtiene los detalles de una compilación.
getBuildWorkItemsRefs(string, number, number)	Obtiene los elementos de trabajo asociados a una compilación. Solo se devuelven los elementos de trabajo del mismo proyecto.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Obtiene los elementos de trabajo asociados a una compilación, filtrados por confirmaciones específicas.
getChangesBetweenBuilds(string, number, number, number)	Obtiene los cambios realizados en el repositorio entre dos compilaciones dadas.
getDefinition(string, number, number, Date, string[], boolean)	Obtiene una definición, opcionalmente en una revisión específica.
getDefinitionMetrics(string, number, Date)	Obtiene las métricas de compilación de una definición.
getDefinitionProperties(string, number, string[])	Obtiene las propiedades de una definición.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Obtiene todas las revisiones de una definición.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Obtiene una lista de definiciones.
getDefinitionTags(string, number, number)	Obtiene las etiquetas de una definición.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Convierte una definición en YAML, opcionalmente en una revisión específica.
getFile(string, number, string, string, string)	Obtiene un archivo de la compilación.
getFileContents(string, string, string, string, string, string)	Obtiene el contenido de un archivo en el repositorio de código fuente especificado.
getFolders(string, string, FolderQueryOrder)	Obtiene una lista de carpetas de definición de compilación.
getLatestBuild(string, string, string)	Obtiene la compilación más reciente de una definición, cuyo ámbito opcional es una rama específica.
getPathContents(string, string, string, string, string, string)	Obtiene el contenido de un directorio en el repositorio de código fuente especificado.
getProjectMetrics(string, string, Date)	Obtiene las métricas de compilación de un proyecto.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Obtiene un objeto de solicitud de incorporación de cambios del proveedor de origen.
getResourceUsage()	Obtiene información sobre los recursos de compilación en el sistema.
getRetentionHistory(number)	Devuelve el historial de retención de la colección de proyectos. Esto incluye canalizaciones que tienen reglas de retención personalizadas que pueden impedir que el trabajo de retención los limpie, se ejecute por canalización con tipo de retención, archivos asociados a canalizaciones propiedad de la colección con tipo de retención y el número de archivos por canalización.
getRetentionLease(string, number)	Devuelve los detalles de la concesión de retención según un identificador de concesión.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Devuelve todas las concesiones que coincidan con minimalRetentionLeases especificadas.
getRetentionLeasesByOwnerId(string, string, number, number)	Devuelve las concesiones que pertenecen a la entidad especificada, que opcionalmente tienen como ámbito una única definición de canalización y se ejecutan.
getRetentionLeasesByUserId(string, string, number, number)	Devuelve las concesiones que pertenecen al usuario especificado, que opcionalmente tiene como ámbito una única definición de canalización y se ejecuta.
getRetentionLeasesForBuild(string, number)	Obtiene todas las concesiones de retención que se aplican a una compilación específica.
getRetentionSettings(string)	Obtiene la configuración de retención del proyecto.
getStatusBadge(string, string, string, string, string, string, string)	<p>Obtiene el estado de compilación de una definición, que opcionalmente tiene como ámbito una rama, una fase, un trabajo y una configuración específicos.< /p><p>Si hay más de uno, se requiere pasar un valor stageName al especificar un jobName y la misma regla se aplica a ambos si se pasa un parámetro de configuración.< /P>
getTags(string)	Obtiene una lista de todas las etiquetas de compilación del proyecto.
getTemplate(string, string)	Obtiene una plantilla de definición de compilación específica.
getTemplates(string)	Obtiene todas las plantillas de definición.
getWorkItemsBetweenBuilds(string, number, number, number)	Obtiene todos los elementos de trabajo entre dos compilaciones.
listBranches(string, string, string, string, string)	Obtiene una lista de ramas para el repositorio de código fuente determinado.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Obtiene una lista de repositorios de código fuente.
listSourceProviders(string)	Obtenga una lista de proveedores de origen y sus funcionalidades.
listWebhooks(string, string, string, string)	Obtiene una lista de webhooks instalados en el repositorio de código fuente especificado.
queueBuild(Build, string, boolean, string, number, number)	Pone en cola una compilación
restoreDefinition(string, number, boolean)	Restaura una definición eliminada.
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Vuelve a crear los webhooks para los desencadenadores especificados en el repositorio de código fuente especificado.
saveTemplate(BuildDefinitionTemplate, string, string)	Novedades una plantilla de definición de compilación existente.
updateBuild(Build, string, number, boolean)	Novedades una compilación.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Novedades configuración general de canalización.
updateBuildProperties(JsonPatchDocument, string, number)	Novedades propiedades de una compilación.
updateBuilds(Build[], string)	Novedades varias compilaciones.
updateBuildSettings(BuildSettings, string)	Novedades la configuración de compilación.
updateBuildTags(UpdateTagParameters, string, number)	Agrega o quita etiquetas de una compilación.
updateDefinition(BuildDefinition, string, number, number, number)	Novedades una definición de compilación existente. Para que esta operación se realice correctamente, el valor de la propiedad "Revision" del cuerpo de la solicitud debe coincidir con el de la definición de compilación existente. Se recomienda obtener la definición de compilación existente mediante GET, modificar la definición de compilación según sea necesario y, a continuación, enviar la definición modificada con PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Novedades propiedades de una definición.
updateDefinitionTags(UpdateTagParameters, string, number)	Agrega o quita etiquetas de una definición.
updateFolder(Folder, string, string)	Novedades una carpeta existente en una ruta de acceso existente determinada
updateRetentionLease(RetentionLeaseUpdate, string, number)	Novedades el estado de protección de la canalización o duración de una concesión de retención.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Novedades la configuración de retención del proyecto.
updateStage(UpdateStageParameters, number, string, string)	Actualizar una fase de compilación

Detalles del constructor

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(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

addBuildTag(string, number, string)

Agrega una etiqueta a una compilación.

function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

tag: string

Etiqueta que se va a agregar.

Devoluciones

Promise<string[]>

addBuildTags(string[], string, number)

Agrega etiquetas a una compilación.

function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>

Parámetros

tags: string[]

Etiquetas que se van a agregar. El cuerpo de la solicitud se compone directamente de las etiquetas enumeradas.

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<string[]>

addDefinitionTag(string, number, string)

Agrega una etiqueta a una definición

function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

tag: string

Etiqueta que se va a agregar.

Devoluciones

Promise<string[]>

addDefinitionTags(string[], string, number)

Agrega varias etiquetas a una definición.

function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>

Parámetros

tags: string[]

Etiquetas que se van a agregar.

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

Devoluciones

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Agrega nuevas concesiones para las ejecuciones de canalización.

function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>

Parámetros

newLeases: NewRetentionLease[]

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Parámetros

resources: DefinitionResourceReference[]

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Devoluciones

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>

Parámetros

resources: DefinitionResourceReference[]

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Asocia un artefacto a una compilación.

function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>

Parámetros

artifact: BuildArtifact

Artefacto.

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Crea una nueva definición.

function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>

Parámetros

definition: BuildDefinition

Definición.

project: string

Id. de proyecto o nombre del proyecto

definitionToCloneId: number

definitionToCloneRevision: number

Devoluciones

Promise<BuildDefinition>

createFolder(Folder, string, string)

Crea una nueva carpeta.

function createFolder(folder: Folder, project: string, path: string): Promise<Folder>

Parámetros

folder: Folder

La carpeta.

project: string

Id. de proyecto o nombre del proyecto

path: string

Ruta de acceso completa de la carpeta.

Devoluciones

Promise<Folder>

deleteBuild(string, number)

Elimina una compilación.

function deleteBuild(project: string, buildId: number): Promise<void>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<void>

deleteBuildTag(string, number, string)

Quita una etiqueta de una compilación. NOTA: Esta API no funcionará para etiquetas con caracteres especiales. Para quitar etiquetas con caracteres especiales, use el método PATCH en su lugar (en 6.0 y versiones posteriores)

function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

tag: string

Etiqueta que se va a quitar.

Devoluciones

Promise<string[]>

deleteDefinition(string, number)

Elimina una definición y todas las compilaciones asociadas.

function deleteDefinition(project: string, definitionId: number): Promise<void>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

Devoluciones

Promise<void>

deleteDefinitionTag(string, number, string)

Quita una etiqueta de una definición. NOTA: Esta API no funcionará para etiquetas con caracteres especiales. Para quitar etiquetas con caracteres especiales, use el método PATCH en su lugar (en 6.0 y versiones posteriores)

function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

tag: string

Etiqueta que se va a quitar.

Devoluciones

Promise<string[]>

deleteFolder(string, string)

Elimina una carpeta de definición. Las definiciones y sus compilaciones correspondientes también se eliminarán.

function deleteFolder(project: string, path: string): Promise<void>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

path: string

Ruta de acceso completa a la carpeta.

Devoluciones

Promise<void>

deleteRetentionLeasesById(string, number[])

Quita concesiones de retención específicas.

function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

ids: number[]

Devoluciones

Promise<void>

deleteTag(string, string)

Quita una etiqueta de compilaciones, definiciones y del almacén de etiquetas.

function deleteTag(project: string, tag: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

tag: string

Etiqueta que se va a quitar.

Devoluciones

Promise<string[]>

deleteTemplate(string, string)

Elimina una plantilla de definición de compilación.

function deleteTemplate(project: string, templateId: string): Promise<void>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

templateId: string

Identificador de la plantilla.

Devoluciones

Promise<void>

getArtifact(string, number, string)

Obtiene un artefacto específico para una compilación.

function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

artifactName: string

Nombre del artefacto.

Devoluciones

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Obtiene un artefacto específico para una compilación.

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

artifactName: string

Nombre del artefacto.

Devoluciones

Promise<ArrayBuffer>

getArtifacts(string, number)

Obtiene todos los artefactos de una compilación.

function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<BuildArtifact[]>

getAttachment(string, number, string, string, string, string)

Obtiene datos adjuntos específicos.

function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

timelineId: string

Identificador de la escala de tiempo.

recordId: string

Identificador del registro de escala de tiempo.

type: string

Tipo de los datos adjuntos.

name: string

El nombre de los datos adjuntos.

Devoluciones

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtiene la lista de datos adjuntos de un tipo específico asociado a una compilación.

function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

type: string

Tipo de datos adjuntos.

Devoluciones

Promise<Attachment[]>

getBadge(string, number, string)

Obtiene un distintivo que indica el estado de la compilación más reciente de una definición. Tenga en cuenta que esta API está en desuso. Prefiere StatusBadgeController.GetStatusBadge.

function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>

Parámetros

project: string

Identificador o nombre del proyecto.

definitionId: number

Identificador de la definición.

branchName: string

Nombre de la rama.

Devoluciones

Promise<string>

getBuild(string, number, string)

Obtiene una compilación.

function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

propertyFilters: string

Devoluciones

Promise<Build>

getBuildBadge(string, string, string, string)

Obtiene un distintivo que indica el estado de la compilación más reciente para la rama especificada.

function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repoType: string

Tipo de repositorio.

repoId: string

Identificador del repositorio.

branchName: string

El nombre de la bifurcación.

Devoluciones

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Obtiene un distintivo que indica el estado de la compilación más reciente para la rama especificada.

function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repoType: string

Tipo de repositorio.

repoId: string

Identificador del repositorio.

branchName: string

El nombre de la bifurcación.

Devoluciones

Promise<string>

getBuildChanges(string, number, string, number, boolean)

Obtiene los cambios asociados a una compilación.

function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

continuationToken: string

top: number

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

includeSourceChange: boolean

Devoluciones

Promise<PagedList<Change>>

getBuildController(number)

Obtiene un controlador.

function getBuildController(controllerId: number): Promise<BuildController>

Parámetros

controllerId: number

Devoluciones

Promise<BuildController>

getBuildControllers(string)

Obtiene el controlador, filtrado opcionalmente por nombre.

function getBuildControllers(name?: string): Promise<BuildController[]>

Parámetros

name: string

Devoluciones

Promise<BuildController[]>

getBuildGeneralSettings(string)

Obtiene la configuración general de la canalización.

function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

Obtiene un archivo de registro individual para una compilación.

function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

logId: number

Identificador del archivo de registro.

startLine: number

Línea de inicio.

endLine: number

Línea final.

Devoluciones

Promise<string>

getBuildLogLines(string, number, number, number, number)

Obtiene un archivo de registro individual para una compilación.

function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

logId: number

Identificador del archivo de registro.

startLine: number

Línea de inicio.

endLine: number

Línea final.

Devoluciones

Promise<string[]>

getBuildLogs(string, number)

Obtiene los registros de una compilación.

function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Obtiene los registros de una compilación.

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

Obtiene un archivo de registro individual para una compilación.

function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

logId: number

Identificador del archivo de registro.

startLine: number

Línea de inicio.

endLine: number

Línea final.

Devoluciones

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Obtiene todas las opciones de definición de compilación admitidas por el sistema.

function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Obtiene las propiedades de una compilación.

function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

filter: string[]

Lista de propiedades delimitada por comas. Si se especifica, filtra por estas propiedades específicas.

Devoluciones

Promise<any>

getBuildReport(string, number, string)

Obtiene un informe de compilación.

function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

type: string

Devoluciones

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Obtiene un informe de compilación.

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

type: string

Devoluciones

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

Obtiene una lista de compilaciones.

function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitions: number[]

Lista delimitada por comas de identificadores de definición. Si se especifica, filtra las compilaciones para estas definiciones.

queues: number[]

Lista delimitada por comas de identificadores de cola. Si se especifica, filtra las compilaciones que se ejecutaron en estas colas.

buildNumber: string

Si se especifica, filtra las compilaciones que coinciden con este número de compilación. Anexar * para realizar una búsqueda de prefijos.

minTime: Date

Si se especifica, filtra las compilaciones finalizadas, iniciadas o en cola después de esta fecha según el parámetro queryOrder especificado.

maxTime: Date

Si se especifica, filtra las compilaciones finalizadas, iniciadas o en cola antes de esta fecha en función del parámetro queryOrder especificado.

requestedFor: string

Si se especifica, filtra las compilaciones solicitadas para el usuario especificado.

reasonFilter: BuildReason

Si se especifica, filtra las compilaciones que coinciden con este motivo.

statusFilter: BuildStatus

Si se especifica, filtra las compilaciones que coinciden con este estado.

resultFilter: BuildResult

Si se especifica, filtra las compilaciones que coinciden con este resultado.

tagFilters: string[]

Una lista delimitada por comas de etiquetas. Si se especifica, filtra las compilaciones que tienen las etiquetas especificadas.

properties: string[]

Lista delimitada por comas de propiedades que se van a recuperar.

top: number

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

continuationToken: string

Token de continuación, devuelto por una llamada anterior a este método, que se puede usar para devolver el siguiente conjunto de compilaciones.

maxBuildsPerDefinition: number

Número máximo de compilaciones que se devolverán por definición.

deletedFilter: QueryDeletedOption

Indica si se van a excluir, incluir o devolver solo compilaciones eliminadas.

queryOrder: BuildQueryOrder

Orden en el que se deben devolver las compilaciones.

branchName: string

Si se especifica, filtra las compilaciones que generaron las ramas que crearon esta rama.

buildIds: number[]

Lista delimitada por comas que especifica los identificadores de las compilaciones que se van a recuperar.

repositoryId: string

Si se especifica, filtra las compilaciones compiladas a partir de este repositorio.

repositoryType: string

Si se especifica, filtra las compilaciones creadas a partir de repositorios de este tipo.

Devoluciones

Promise<PagedList<Build>>

getBuildSettings(string)

Obtiene la configuración de compilación.

function getBuildSettings(project?: string): Promise<BuildSettings>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BuildSettings>

getBuildTags(string, number)

Obtiene las etiquetas de una compilación.

function getBuildTags(project: string, buildId: number): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

Obtiene los detalles de una compilación.

function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

timelineId: string

changeId: number

planId: string

Devoluciones

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Obtiene los elementos de trabajo asociados a una compilación. Solo se devuelven los elementos de trabajo del mismo proyecto.

function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

top: number

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

Devoluciones

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

Obtiene los elementos de trabajo asociados a una compilación, filtrados por confirmaciones específicas.

function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Parámetros

commitIds: string[]

Lista delimitada por comas de identificadores de confirmación.

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

top: number

Número máximo de elementos de trabajo que se van a devolver o el número de confirmaciones que se deben tener en cuenta si no se especifican identificadores de confirmación.

Devoluciones

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Obtiene los cambios realizados en el repositorio entre dos compilaciones dadas.

function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

fromBuildId: number

Identificador de la primera compilación.

toBuildId: number

Identificador de la última compilación.

top: number

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

Devoluciones

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

Obtiene una definición, opcionalmente en una revisión específica.

function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

revision: number

Número de revisión que se va a recuperar. Si no se especifica, se devolverá la versión más reciente.

minMetricsTime: Date

Si se especifica, indica la fecha a partir de la cual se deben incluir las métricas.

propertyFilters: string[]

Lista delimitada por comas de propiedades que se van a incluir en los resultados.

includeLatestBuilds: boolean

Devoluciones

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Obtiene las métricas de compilación de una definición.

function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

minMetricsTime: Date

Fecha a partir de la cual se van a calcular las métricas.

Devoluciones

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Obtiene las propiedades de una definición.

function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

filter: string[]

Lista de propiedades delimitada por comas. Si se especifica, filtra por estas propiedades específicas.

Devoluciones

Promise<any>

getDefinitionResources(string, number)

function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Devoluciones

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Obtiene todas las revisiones de una definición.

function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

Devoluciones

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

Obtiene una lista de definiciones.

function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

name: string

Si se especifica, filtra por definiciones cuyos nombres coinciden con este patrón.

repositoryId: string

Un identificador de repositorio. Si se especifica, filtra por definiciones que usan este repositorio.

repositoryType: string

Si se especifica, filtra por definiciones que tienen un repositorio de este tipo.

queryOrder: DefinitionQueryOrder

Indica el orden en el que se deben devolver las definiciones.

top: number

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

continuationToken: string

Token de continuación, devuelto por una llamada anterior a este método, que se puede usar para devolver el siguiente conjunto de definiciones.

minMetricsTime: Date

Si se especifica, indica la fecha a partir de la cual se deben incluir las métricas.

definitionIds: number[]

Lista delimitada por comas que especifica los identificadores de las definiciones que se van a recuperar.

path: string

Si se especifica, filtra por definiciones en esta carpeta.

builtAfter: Date

Si se especifica, filtra por definiciones que tienen compilaciones después de esta fecha.

notBuiltAfter: Date

Si se especifica, filtra por definiciones que no tienen compilaciones después de esta fecha.

includeAllProperties: boolean

Indica si se deben devolver las definiciones completas. De forma predeterminada, se devuelven representaciones poco profundas de las definiciones.

includeLatestBuilds: boolean

Indica si se deben devolver las compilaciones completadas más recientes y más recientes para esta definición.

taskIdFilter: string

Si se especifica, filtra por definiciones que usan la tarea especificada.

processType: number

Si se especifica, filtra las definiciones con el tipo de proceso especificado.

yamlFilename: string

Si se especifica, filtra las definiciones de YAML que coinciden con el nombre de archivo especificado. Para usar este filtro includeAllProperties debe establecerse en true

Devoluciones

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Obtiene las etiquetas de una definición.

function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

revision: number

Número de revisión de definición. Si no se especifica, usa la revisión más reciente de la definición.

Devoluciones

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

Convierte una definición en YAML, opcionalmente en una revisión específica.

function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

revision: number

Número de revisión que se va a recuperar. Si no se especifica, se devolverá la versión más reciente.

minMetricsTime: Date

Si se especifica, indica la fecha a partir de la cual se deben incluir las métricas.

propertyFilters: string[]

Lista delimitada por comas de propiedades que se van a incluir en los resultados.

includeLatestBuilds: boolean

Devoluciones

Promise<YamlBuild>

getFile(string, number, string, string, string)

Obtiene un archivo de la compilación.

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

artifactName: string

Nombre del artefacto.

fileId: string

Clave principal del archivo.

fileName: string

Nombre en el que se establecerá el archivo.

Devoluciones

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

Obtiene el contenido de un archivo en el repositorio de código fuente especificado.

function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

serviceEndpointId: string

Si se especifica, el identificador del punto de conexión de servicio que se va a consultar. Solo se puede omitir para los proveedores que no usan puntos de conexión de servicio, por ejemplo, TFVC o TFGit.

repository: string

Si se especifica, el identificador específico del proveedor o el nombre del repositorio para obtener ramas. Solo se puede omitir para los proveedores que no admiten varios repositorios.

commitOrBranch: string

Identificador de la confirmación o rama desde la que se recupera el contenido de un archivo.

path: string

Ruta de acceso al archivo que se va a recuperar, en relación con la raíz del repositorio.

Devoluciones

Promise<string>

getFolders(string, string, FolderQueryOrder)

Obtiene una lista de carpetas de definición de compilación.

function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

path: string

Ruta de acceso con la que empezar.

queryOrder: FolderQueryOrder

Orden en el que se deben devolver las carpetas.

Devoluciones

Promise<Folder[]>

getLatestBuild(string, string, string)

Obtiene la compilación más reciente de una definición, cuyo ámbito opcional es una rama específica.

function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definition: string

nombre de definición con la ruta de acceso de carpeta inicial opcional o el identificador de definición

branchName: string

parámetro opcional que indica la rama específica que se va a usar. Si no se especifica, se usa la rama predeterminada.

Devoluciones

Promise<Build>

getPathContents(string, string, string, string, string, string)

Obtiene el contenido de un directorio en el repositorio de código fuente especificado.

function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

serviceEndpointId: string

repository: string

Si se especifica, el identificador específico del proveedor o el nombre del repositorio para obtener ramas. Solo se puede omitir para los proveedores que no admiten varios repositorios.

commitOrBranch: string

Identificador de la confirmación o rama desde la que se recupera el contenido de un archivo.

path: string

El contenido de la ruta de acceso que se va a enumerar, en relación con la raíz del repositorio.

Devoluciones

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Obtiene las métricas de compilación de un proyecto.

function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

metricAggregationType: string

Tipo de agregación que se va a usar (cada hora, día).

minMetricsTime: Date

Fecha a partir de la cual se van a calcular las métricas.

Devoluciones

Promise<BuildMetric[]>

getProjectResources(string, string, string)

function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

type: string

id: string

Devoluciones

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

Obtiene un objeto de solicitud de incorporación de cambios del proveedor de origen.

function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

pullRequestId: string

Identificador específico del proveedor de la solicitud de incorporación de cambios.

repositoryId: string

Identificador específico del proveedor o el nombre del repositorio que contiene la solicitud de incorporación de cambios.

serviceEndpointId: string

Devoluciones

Promise<PullRequest>

getResourceUsage()

Obtiene información sobre los recursos de compilación en el sistema.

function getResourceUsage(): Promise<BuildResourceUsage>

Devoluciones

Promise<BuildResourceUsage>

getRetentionHistory(number)

Devuelve el historial de retención de la colección de proyectos. Esto incluye canalizaciones que tienen reglas de retención personalizadas que pueden impedir que el trabajo de retención los limpie, se ejecute por canalización con tipo de retención, archivos asociados a canalizaciones propiedad de la colección con tipo de retención y el número de archivos por canalización.

function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

Parámetros

daysToLookback: number

Devoluciones

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Devuelve los detalles de la concesión de retención según un identificador de concesión.

function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

leaseId: number

Devoluciones

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Devuelve todas las concesiones que coincidan con minimalRetentionLeases especificadas.

function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

leasesToFetch: MinimalRetentionLease[]

Lista de elementos MinimalRetentionLeases serializados por JSON separados por '|'

Devoluciones

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Devuelve las concesiones que pertenecen a la entidad especificada, que opcionalmente tienen como ámbito una única definición de canalización y se ejecutan.

function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

ownerId: string

definitionId: number

Parámetro opcional para limitar la búsqueda a una definición de canalización específica.

runId: number

Parámetro opcional para limitar la búsqueda a una sola ejecución de canalización. Requiere definitionId.

Devoluciones

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Devuelve las concesiones que pertenecen al usuario especificado, que opcionalmente tiene como ámbito una única definición de canalización y se ejecuta.

function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

userOwnerId: string

Identificador de usuario que se va a buscar.

definitionId: number

Parámetro opcional para limitar la búsqueda a una definición de canalización específica.

runId: number

Parámetro opcional para limitar la búsqueda a una sola ejecución de canalización. Requiere definitionId.

Devoluciones

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Obtiene todas las concesiones de retención que se aplican a una compilación específica.

function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<RetentionLease[]>

getRetentionSettings(string)

Obtiene la configuración de retención del proyecto.

function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p>Obtiene el estado de compilación de una definición, que opcionalmente tiene como ámbito una rama, una fase, un trabajo y una configuración específicos.< /p><p>Si hay más de uno, se requiere pasar un valor stageName al especificar un jobName y la misma regla se aplica a ambos si se pasa un parámetro de configuración.< /P>

function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definition: string

El nombre de la definición con la ruta de acceso de carpeta inicial opcional o el identificador de definición.

branchName: string

Solo tenga en cuenta la compilación más reciente de esta rama. Si no se especifica, se usa la rama predeterminada.

stageName: string

Use esta fase dentro de la canalización para representar el estado.

jobName: string

Use este trabajo en una fase de la canalización para representar el estado.

configuration: string

Use esta configuración de trabajo para representar el estado

label: string

Reemplaza el texto predeterminado en el lado izquierdo del distintivo.

Devoluciones

Promise<string>

getTags(string)

Obtiene una lista de todas las etiquetas de compilación del proyecto.

function getTags(project: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<string[]>

getTemplate(string, string)

Obtiene una plantilla de definición de compilación específica.

function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

templateId: string

Identificador de la plantilla solicitada.

Devoluciones

Promise<BuildDefinitionTemplate>

getTemplates(string)

Obtiene todas las plantillas de definición.

function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Obtiene todos los elementos de trabajo entre dos compilaciones.

function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

fromBuildId: number

Identificador de la primera compilación.

toBuildId: number

Identificador de la última compilación.

top: number

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

Devoluciones

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

Obtiene una lista de ramas para el repositorio de código fuente determinado.

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

serviceEndpointId: string

repository: string

Identificador específico del proveedor o el nombre del repositorio para obtener ramas. Solo se puede omitir para los proveedores que no admiten varios repositorios.

branchName: string

Si se proporciona, el nombre de la rama que se va a comprobar específicamente.

Devoluciones

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

Obtiene una lista de repositorios de código fuente.

function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

serviceEndpointId: string

repository: string

Si se especifica, el identificador específico del proveedor o el nombre de un único repositorio que se va a obtener.

resultSet: ResultSet

"top" para los repositorios más relevantes para el punto de conexión. Si no se establece, se devuelven todos los repositorios. Se omite si se establece 'repository'.

pageResults: boolean

Si se establece en true, esto limitará el conjunto de resultados y devolverá un token de continuación para continuar la consulta.

continuationToken: string

Al paginar los resultados, se trata de un token de continuación, devuelto por una llamada anterior a este método, que se puede usar para devolver el siguiente conjunto de repositorios.

Devoluciones

Promise<SourceRepositories>

listSourceProviders(string)

Obtenga una lista de proveedores de origen y sus funcionalidades.

function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Obtiene una lista de webhooks instalados en el repositorio de código fuente especificado.

function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

serviceEndpointId: string

repository: string

Si se especifica, el identificador específico del proveedor o el nombre del repositorio para obtener webhooks. Solo se puede omitir para los proveedores que no admiten varios repositorios.

Devoluciones

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

Pone en cola una compilación

function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>

Parámetros

build: Build

project: string

Id. de proyecto o nombre del proyecto

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Identificador de definición opcional para poner en cola una compilación sin un cuerpo. Se omite si hay un cuerpo válido

Devoluciones

Promise<Build>

restoreDefinition(string, number, boolean)

Restaura una definición eliminada.

function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>

Parámetros

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición que se va a restaurar.

deleted: boolean

Cuando es false, restaura una definición eliminada.

Devoluciones

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

Vuelve a crear los webhooks para los desencadenadores especificados en el repositorio de código fuente especificado.

function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>

Parámetros

triggerTypes: DefinitionTriggerType[]

Los tipos de desencadenadores para los que restaurar webhooks.

project: string

Id. de proyecto o nombre del proyecto

providerName: string

Nombre del proveedor de origen.

serviceEndpointId: string

repository: string

Si se especifica, el identificador específico del proveedor o el nombre del repositorio para obtener webhooks. Solo se puede omitir para los proveedores que no admiten varios repositorios.

Devoluciones

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Novedades una plantilla de definición de compilación existente.

function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>

Parámetros

template: BuildDefinitionTemplate

Nueva versión de la plantilla.

project: string

Id. de proyecto o nombre del proyecto

templateId: string

Identificador de la plantilla.

Devoluciones

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Novedades una compilación.

function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>

Parámetros

build: Build

Compilación.

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

retry: boolean

Devoluciones

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Novedades configuración general de canalización.

function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>

Parámetros

newSettings: PipelineGeneralSettings

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Novedades propiedades de una compilación.

function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>

Parámetros

document: JsonPatchDocument

Documento json-patch que describe las propiedades que se van a actualizar.

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<any>

updateBuilds(Build[], string)

Novedades varias compilaciones.

function updateBuilds(builds: Build[], project: string): Promise<Build[]>

Parámetros

builds: Build[]

Compilaciones que se van a actualizar.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Novedades la configuración de compilación.

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

Parámetros

settings: BuildSettings

Nueva configuración.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Agrega o quita etiquetas de una compilación.

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

Parámetros

updateParameters: UpdateTagParameters

Etiquetas que se van a agregar o quitar.

project: string

Id. de proyecto o nombre del proyecto

buildId: number

Identificador de la compilación.

Devoluciones

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number)

Novedades una definición de compilación existente. Para que esta operación se realice correctamente, el valor de la propiedad "Revision" del cuerpo de la solicitud debe coincidir con el de la definición de compilación existente. Se recomienda obtener la definición de compilación existente mediante GET, modificar la definición de compilación según sea necesario y, a continuación, enviar la definición modificada con PUT.

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>

Parámetros

definition: BuildDefinition

Nueva versión de la definición. Su propiedad "Revision" debe coincidir con la definición existente para que se acepte la actualización.

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Devoluciones

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Novedades propiedades de una definición.

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

Parámetros

document: JsonPatchDocument

Documento json-patch que describe las propiedades que se van a actualizar.

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

Devoluciones

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Agrega o quita etiquetas de una definición.

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

Parámetros

updateParameters: UpdateTagParameters

Etiquetas que se van a agregar o quitar.

project: string

Id. de proyecto o nombre del proyecto

definitionId: number

Identificador de la definición.

Devoluciones

Promise<string[]>

updateFolder(Folder, string, string)

Novedades una carpeta existente en una ruta de acceso existente determinada

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

Parámetros

folder: Folder

Nueva versión de la carpeta.

project: string

Id. de proyecto o nombre del proyecto

path: string

Ruta de acceso completa a la carpeta.

Devoluciones

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Novedades el estado de protección de la canalización o duración de una concesión de retención.

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

Parámetros

leaseUpdate: RetentionLeaseUpdate

Los nuevos datos de la concesión de retención.

project: string

Id. de proyecto o nombre del proyecto

leaseId: number

Identificador de la concesión que se va a actualizar.

Devoluciones

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Novedades la configuración de retención del proyecto.

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

Parámetros

updateModel: UpdateProjectRetentionSettingModel

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Actualizar una fase de compilación

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

Parámetros

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

Compartir a través de

BuildRestClient class

Constructores

Propiedades

Métodos

Detalles del constructor

BuildRestClient(IVssRestClientOptions)

Parámetros

Detalles de las propiedades

RESOURCE_AREA_ID

Valor de propiedad

Detalles del método

addBuildTag(string, number, string)

Parámetros

Devoluciones

addBuildTags(string[], string, number)

Parámetros

Devoluciones

addDefinitionTag(string, number, string)

Parámetros

Devoluciones

addDefinitionTags(string[], string, number)

Parámetros

Devoluciones

addRetentionLeases(NewRetentionLease[], string)

Parámetros

Devoluciones

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parámetros

Devoluciones

authorizeProjectResources(DefinitionResourceReference[], string)

Parámetros

Devoluciones

createArtifact(BuildArtifact, string, number)

Parámetros

Devoluciones

createDefinition(BuildDefinition, string, number, number)

Parámetros

Devoluciones

createFolder(Folder, string, string)

Parámetros

Devoluciones

deleteBuild(string, number)

Parámetros

Devoluciones

deleteBuildTag(string, number, string)

Parámetros

Devoluciones

deleteDefinition(string, number)

Parámetros

Devoluciones

deleteDefinitionTag(string, number, string)

Parámetros

Devoluciones

deleteFolder(string, string)

Parámetros

Devoluciones

deleteRetentionLeasesById(string, number[])

Parámetros

Devoluciones

deleteTag(string, string)

Parámetros

Devoluciones

deleteTemplate(string, string)

Parámetros

Devoluciones

getArtifact(string, number, string)

Parámetros

Devoluciones

getArtifactContentZip(string, number, string)

Parámetros

Devoluciones

getArtifacts(string, number)

Parámetros

Devoluciones

getAttachment(string, number, string, string, string, string)

Parámetros

Devoluciones

getAttachments(string, number, string)

Parámetros