ReleaseRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Release |
Propiedades
| RESOURCE_AREA_ID |
Métodos
Detalles del constructor
ReleaseRestClient(IVssRestClientOptions)
Detalles de las propiedades
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de propiedad
string
Detalles del método
addDefinitionTag(string, number, string)
Agrega una etiqueta a una definición
function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseDefinitionId
-
number
- tag
-
string
Devoluciones
Promise<string[]>
addDefinitionTags(string[], string, number)
Agrega varias etiquetas a una definición
function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>Parámetros
- tags
-
string[]
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseDefinitionId
-
number
Devoluciones
Promise<string[]>
addReleaseTag(string, number, string)
Agrega una etiqueta a un releaseId
function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- tag
-
string
Devoluciones
Promise<string[]>
addReleaseTags(string[], string, number)
Agrega una etiqueta a una versión
function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>Parámetros
- tags
-
string[]
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Devoluciones
Promise<string[]>
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)
Crea una plantilla de entorno de definición
function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parámetros
- template
- ReleaseDefinitionEnvironmentTemplate
Plantilla de entorno de definición para crear
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ReleaseDefinitionEnvironmentTemplate>
createFavorites(FavoriteItem[], string, string, string)
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parámetros
- favoriteItems
- project
-
string
Id. de proyecto o nombre del proyecto
- scope
-
string
- identityId
-
string
Devoluciones
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
Crea una nueva carpeta.
function createFolder(folder: Folder, project: string, path?: string): Promise<Folder>Parámetros
- folder
- Folder
.
- project
-
string
Id. de proyecto o nombre del proyecto
- path
-
string
Ruta de acceso de la carpeta.
Devoluciones
Promise<Folder>
createRelease(ReleaseStartMetadata, string)
Crear una versión.
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>Parámetros
- releaseStartMetadata
- ReleaseStartMetadata
Metadatos para crear una versión.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
Creación de una definición de versión
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Parámetros
- releaseDefinition
- ReleaseDefinition
objeto de definición de versión que se va a crear.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
Eliminación de una plantilla de entorno de definición
function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- templateId
-
string
Identificador de la plantilla de entorno de definición
Devoluciones
Promise<void>
deleteDefinitionTag(string, number, string)
Elimina una etiqueta de una definición.
function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseDefinitionId
-
number
- tag
-
string
Devoluciones
Promise<string[]>
deleteFavorites(string, string, string, string)
function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- scope
-
string
- identityId
-
string
- favoriteItemIds
-
string
Devoluciones
Promise<void>
deleteFolder(string, string)
Elimina una carpeta de definición para el nombre y la ruta de acceso de carpeta especificados y todas las definiciones existentes.
function deleteFolder(project: string, path: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- path
-
string
Ruta de acceso de la carpeta que se va a eliminar.
Devoluciones
Promise<void>
deleteRelease(string, number, string)
Eliminación temporal de una versión
function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- comment
-
string
Comentario para eliminar una versión.
Devoluciones
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Elimine una definición de versión.
function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Id. de la definición de versión.
- comment
-
string
Comentario para eliminar una definición de versión.
- forceDelete
-
boolean
'true' para cancelar automáticamente las implementaciones de versión en curso y continuar con la eliminación de la definición de versión . El valor predeterminado es "false".
Devoluciones
Promise<void>
deleteReleaseTag(string, number, string)
Elimina una etiqueta de una versión.
function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- tag
-
string
Devoluciones
Promise<string[]>
getAgentArtifactDefinitions(string, number)
Devuelve los detalles del artefacto que requiere el agente de automatización.
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Devoluciones
Promise<AgentArtifactDefinition[]>
getApproval(string, number, boolean)
Obtener una aprobación.
function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- approvalId
-
number
Id. de la aprobación.
- includeHistory
-
boolean
'true' para incluir el historial de la aprobación. El valor predeterminado es "false".
Devoluciones
Promise<ReleaseApproval>
getApprovalHistory(string, number)
Obtiene el historial de aprobaciones.
function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- approvalStepId
-
number
Id. de la aprobación.
Devoluciones
Promise<ReleaseApproval>
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)
Obtener una lista de aprobaciones
function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- assignedToFilter
-
string
Aprobaciones asignadas a este usuario.
- statusFilter
- ApprovalStatus
Aprobaciones con este estado. El valor predeterminado es "pendiente".
- releaseIdsFilter
-
number[]
Aprobaciones para identificadores de versión mencionados en el filtro. Se pueden mencionar varias versiones separandolas con "", por ejemplo, releaseIdsFilter=1,2,3,4.
- typeFilter
- ApprovalType
Aprobación con este tipo.
- top
-
number
Número de aprobaciones que se van a obtener. Valor predeterminado: 50
- continuationToken
-
number
Obtiene las aprobaciones después del token de continuación proporcionado.
- queryOrder
- ReleaseQueryOrder
Obtiene los resultados en el orden definido de aprobaciones creadas. El valor predeterminado es "descendente".
- includeMyGroupApprovals
-
boolean
"true" para incluir mis aprobaciones de grupo. El valor predeterminado es "false".
Devoluciones
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ArtifactTypeDefinition[]>
getArtifactVersions(string, number)
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseDefinitionId
-
number
Devoluciones
Promise<ArtifactVersionQueryResult>
getArtifactVersionsForSources(Artifact[], string)
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>Parámetros
- artifacts
-
Artifact[]
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ArtifactVersionQueryResult>
getAutoTriggerIssues(string, string, string, string)
function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>Parámetros
- artifactType
-
string
- sourceId
-
string
- artifactVersionId
-
string
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<AutoTriggerIssue[]>
getDefinitionEnvironments(string, string, string[])
function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- taskGroupId
-
string
- propertyFilters
-
string[]
Devoluciones
Promise<DefinitionEnvironmentReference[]>
getDefinitionEnvironmentTemplate(string, string)
Obtiene una plantilla de entorno de definición.
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- templateId
-
string
Identificador de la plantilla de entorno de definición
Devoluciones
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Obtención de la definición de versión para un definitionId y una revisión determinados
function getDefinitionRevision(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
Identificador de la revisión.
Devoluciones
Promise<string>
getDefinitionTags(string, number)
Obtiene las etiquetas de una definición.
function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseDefinitionId
-
number
Devoluciones
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Obtiene un distintivo que indica el estado de la implementación más reciente de un entorno.
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>Parámetros
- projectId
-
string
Identificador del proyecto.
- releaseDefinitionId
-
number
Identificador de la definición de versión.
- environmentId
-
number
Identificador del entorno.
- branchName
-
string
Nombre de la rama.
Devoluciones
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
Obtener una lista de implementaciones
function getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: DeploymentStatus, operationStatus?: DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<PagedList<Deployment>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Enumere las implementaciones de un identificador de definición determinado.
- definitionEnvironmentId
-
number
Enumere las implementaciones de un identificador de entorno de definición determinado.
- createdBy
-
string
Enumere las implementaciones para las que se crean las implementaciones como identidad especificadas.
- minModifiedTime
-
Date
Enumere las implementaciones con lastModified time >= minModifiedTime.
- maxModifiedTime
-
Date
Enumere las implementaciones con lastModified time <= maxModifiedTime.
- deploymentStatus
- DeploymentStatus
Enumere las implementaciones con un estado de implementación determinado. El valor predeterminado es "All".
- operationStatus
- DeploymentOperationStatus
Enumere las implementaciones con el estado de operación especificado. El valor predeterminado es "All".
- latestAttemptsOnly
-
boolean
'true' para incluir implementaciones solo con el último intento. El valor predeterminado es "false".
- queryOrder
- ReleaseQueryOrder
Enumere las implementaciones con un orden de consulta determinado. El valor predeterminado es "Descendente".
- top
-
number
Enumere las implementaciones con la parte superior especificada. La parte superior predeterminada es "50" y la parte superior máxima es "100".
- continuationToken
-
number
Enumere las implementaciones con id >. de implementación = continuationToken.
- createdFor
-
string
Enumere las implementaciones para las que se solicitan las implementaciones como identidad especificadas.
- minStartedTime
-
Date
Enumere las implementaciones con startedOn time >= minStartedTime.
- maxStartedTime
-
Date
Enumere las implementaciones con startedOn time <= maxStartedTime.
- sourceBranch
-
string
Enumere las implementaciones que se implementan a partir de un nombre de rama determinado.
Devoluciones
Promise<PagedList<Deployment>>
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>Parámetros
- queryParameters
- DeploymentQueryParameters
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<Deployment[]>
getFavorites(string, string, string)
function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- scope
-
string
- identityId
-
string
Devoluciones
Promise<FavoriteItem[]>
getFlightAssignments(string)
function getFlightAssignments(flightName?: string): Promise<string[]>Parámetros
- flightName
-
string
Devoluciones
Promise<string[]>
getFolders(string, string, FolderPathQueryOrder)
Obtiene carpetas.
function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- path
-
string
Ruta de acceso de la carpeta.
- queryOrder
- FolderPathQueryOrder
Obtiene los resultados en el orden definido. El valor predeterminado es "None".
Devoluciones
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Obtiene los registros de puerta.
function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión.
- environmentId
-
number
Identificador del entorno de versión.
- gateId
-
number
Id. de la puerta.
- taskId
-
number
ReleaseTask Id para el registro.
Devoluciones
Promise<string>
getInputValues(InputValuesQuery, string)
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>Parámetros
- query
- InputValuesQuery
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<InputValuesQuery>
getIssues(string, number, string)
function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
- sourceId
-
string
Devoluciones
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
Obtiene registros.
function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión.
- environmentId
-
number
Identificador del entorno de versión.
- taskId
-
number
ReleaseTask Id para el registro.
- attemptId
-
number
Identificador del intento.
Devoluciones
Promise<string>
getLogs(string, number)
Obtiene los registros de un identificador de versión.
function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión.
Devoluciones
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Obtenga la intervención manual para una versión determinada y el identificador de intervención manual.
function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión.
- manualInterventionId
-
number
Id. de la intervención manual.
Devoluciones
Promise<ManualIntervention>
getManualInterventions(string, number)
Enumera todas las intervenciones manuales para una versión determinada.
function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión.
Devoluciones
Promise<ManualIntervention[]>
getMetrics(string, Date)
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- minMetricsTime
-
Date
Devoluciones
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Obtiene la configuración de la versión de canalización de la organización.
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Devoluciones
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
Obtiene la configuración de la versión de canalización.
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)
Obtener una versión
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number): Promise<Release>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión.
- approvalFilters
- ApprovalFilters
Filtro que permitiría capturar pasos de aprobación de forma selectiva en función de si está automatizado o manual. Esto también decidiría si deberíamos capturar instantáneas previas y posteriores a la aprobación. Presupone todo de forma predeterminada
- propertyFilters
-
string[]
Lista delimitada por comas de propiedades extendidas que se van a recuperar. Si se establece, la versión devuelta contendrá valores para los identificadores de propiedad especificados (si existen). Si no se establece, no se incluirán las propiedades.
- expand
- SingleReleaseExpands
Propiedad que se debe expandir en la versión.
- topGateRecords
-
number
Número de registros de la puerta de liberación que se van a obtener. El valor predeterminado es 5.
Devoluciones
Promise<Release>
getReleaseChanges(string, number, number, number, string)
function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Devoluciones
Promise<Change[]>
getReleaseDefinition(string, number, string[])
Obtenga una definición de versión.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseDefinition>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Identificador de la definición de versión.
- propertyFilters
-
string[]
Lista delimitada por comas de propiedades extendidas que se van a recuperar. Si se establece, la definición de versión devuelta contendrá valores para los identificadores de propiedad especificados (si existen). Si no se establece, no se incluirán las propiedades.
Devoluciones
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
Obtención del historial de revisiones para una definición de versión
function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Identificador de la definición.
Devoluciones
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
Obtiene la definición de versión de una revisión determinada.
function getReleaseDefinitionRevision(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 de versión.
- revision
-
number
Número de revisión de la definición de versión.
Devoluciones
Promise<string>
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)
Obtenga una lista de definiciones de versión.
function getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<PagedList<ReleaseDefinition>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- searchText
-
string
Obtenga definiciones de versión con nombres que contengan searchText.
- expand
- ReleaseDefinitionExpands
Las propiedades que se deben expandir en la lista de definiciones de versión.
- artifactType
-
string
Se devolverán definiciones de versión con artifactType dado. Los valores pueden ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- artifactSourceId
-
string
Se devolverán definiciones de versión con artifactSourceId dado. Por ejemplo, para la compilación sería {projectGuid}:{BuildDefinitionId}, para Jenkins sería {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem sería {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefactos de terceros, por ejemplo, TeamCity, BitBucket puede hacer referencia a "uniqueSourceIdentifier" dentro de vss-extension.json en https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- top
-
number
Número de definiciones de versión que se van a obtener.
- continuationToken
-
string
Obtiene las definiciones de versión después del token de continuación proporcionado.
- queryOrder
- ReleaseDefinitionQueryOrder
Obtiene los resultados en el orden definido. El valor predeterminado es "IdAscending".
- path
-
string
Obtiene las definiciones de versión en la ruta de acceso especificada.
- isExactNameMatch
-
boolean
'true'to obtiene las definiciones de versión con coincidencia exacta como se especifica en searchText. El valor predeterminado es "false".
- tagFilter
-
string[]
Una lista delimitada por comas de etiquetas. Solo se devolverán las definiciones de versión con estas etiquetas.
- propertyFilters
-
string[]
Lista delimitada por comas de propiedades extendidas que se van a recuperar. Si se establece, las definiciones de versión devueltas contendrán valores para los identificadores de propiedad especificados (si existen). Si no se establece, no se incluirán las propiedades. Tenga en cuenta que esto no filtrará ninguna definición de versión de los resultados independientemente de si tiene la propiedad establecida o no.
- definitionIdFilter
-
string[]
Lista delimitada por comas de definiciones de versión que se van a recuperar.
- isDeleted
-
boolean
'true' para obtener definiciones de versión que se han eliminado. El valor predeterminado es 'false'
- searchTextContainsFolderName
-
boolean
'true' para obtener las definiciones de versión en la carpeta con el nombre especificado en searchText. El valor predeterminado es "false".
Devoluciones
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Obtenga el resumen de la versión de un identificador de definición determinado.
function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Identificador de la definición para obtener el resumen de la versión.
- releaseCount
-
number
Recuento de versiones que se incluirán en resumen.
- includeArtifact
-
boolean
Incluya los detalles del artefacto. El valor predeterminado es "false".
- definitionEnvironmentIdsFilter
-
number[]
Devoluciones
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
Obtenga un entorno de versión.
function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- expand
- ReleaseEnvironmentExpands
Propiedad que se debe expandir en el entorno.
Devoluciones
Promise<ReleaseEnvironment>
getReleaseHistory(string, number)
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Devoluciones
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Parámetros
- artifactType
-
string
- artifactSourceId
-
string
Devoluciones
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Obtiene la versión de un número de revisión determinado.
function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- definitionSnapshotRevision
-
number
Número de revisión de instantánea de definición.
Devoluciones
Promise<string>
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)
Obtener una lista de versiones
function getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<PagedList<Release>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Versiones de este identificador de definición de versión.
- definitionEnvironmentId
-
number
- searchText
-
string
Libera con nombres que contienen searchText.
- createdBy
-
string
Versiones creadas por este usuario.
- statusFilter
- ReleaseStatus
Versiones que tienen este estado.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Versiones que se crearon después de este tiempo.
- maxCreatedTime
-
Date
Versiones que se crearon antes de esta hora.
- queryOrder
- ReleaseQueryOrder
Obtiene los resultados en el orden definido de la fecha de creación de las versiones. El valor predeterminado es descendente.
- top
-
number
Número de versiones que se van a obtener. Valor predeterminado: 50
- continuationToken
-
number
Obtiene las versiones después del token de continuación proporcionado.
- expand
- ReleaseExpands
Propiedad que se debe expandir en la lista de versiones.
- artifactTypeId
-
string
Se devolverán las versiones con artifactTypeId especificado. Los valores pueden ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- sourceId
-
string
Identificador único del artefacto usado. Por ejemplo, para la compilación sería {projectGuid}:{BuildDefinitionId}, para Jenkins sería {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem sería {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefactos de terceros, por ejemplo, TeamCity, BitBucket puede hacer referencia a "uniqueSourceIdentifier" dentro de vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- artifactVersionId
-
string
Se devolverán las versiones con artifactVersionId dados. Por ejemplo, en el caso de Build artifactType, es buildId.
- sourceBranchFilter
-
string
Se devolverán las versiones con sourceBranchFilter especificado.
- isDeleted
-
boolean
Obtiene las versiones eliminadas temporalmente, si es true.
- tagFilter
-
string[]
Una lista delimitada por comas de etiquetas. Solo se devolverán las versiones con estas etiquetas.
- propertyFilters
-
string[]
Lista delimitada por comas de propiedades extendidas que se van a recuperar. Si se establece, las versiones devueltas contendrán valores para los identificadores de propiedad especificados (si existen). Si no se establece, no se incluirán las propiedades. Tenga en cuenta que esto no filtrará ninguna versión de los resultados independientemente de si tiene la propiedad establecida o no.
- releaseIdFilter
-
number[]
Lista delimitada por comas de identificadores de versión. Solo se devolverán las versiones con estos identificadores.
- path
-
string
Se devolverán las versiones de esta ruta de acceso de carpeta.
Devoluciones
getReleaseSettings(string)
Obtiene la configuración de versión.
function getReleaseSettings(project: string): Promise<ReleaseSettings>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ReleaseSettings>
getReleaseTags(string, number)
Obtiene las etiquetas de una versión.
function getReleaseTags(project: string, releaseId: number): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Devoluciones
Promise<string[]>
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)
Obtener datos adjuntos de la tarea de versión.
function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- attemptId
-
number
Número de intentos de implementación.
- planId
-
string
Identificador del plan de la fase de implementación.
- timelineId
-
string
Id. de escala de tiempo de la tarea.
- recordId
-
string
Identificador de registro de datos adjuntos.
- type
-
string
Tipo de los datos adjuntos.
- name
-
string
Nombre de los datos adjuntos.
Devoluciones
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
Obtenga los datos adjuntos de la tarea de versión.
function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- attemptId
-
number
Número de intentos de implementación.
- planId
-
string
Identificador del plan de la fase de implementación.
- type
-
string
Tipo de los datos adjuntos.
Devoluciones
Promise<ReleaseTaskAttachment[]>
getReleaseWorkItemsRefs(string, number, number, number, string)
function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Devoluciones
Promise<ReleaseWorkItemRef[]>
getSourceBranches(string, number)
function getSourceBranches(project: string, definitionId: number): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Devoluciones
Promise<string[]>
getSummaryMailSections(string, number)
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Devoluciones
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
Obtener datos adjuntos de una tarea.
function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- attemptId
-
number
Número de intentos de implementación.
- timelineId
-
string
Id. de escala de tiempo de la tarea.
- recordId
-
string
Identificador de registro de datos adjuntos.
- type
-
string
Tipo de los datos adjuntos.
- name
-
string
Nombre de los datos adjuntos.
Devoluciones
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Obtenga los datos adjuntos de la tarea.
function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- attemptId
-
number
Número de intentos de implementación.
- timelineId
-
string
Id. de escala de tiempo de la tarea.
- type
-
string
Tipo de los datos adjuntos.
Devoluciones
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Obtiene el registro de tareas de una versión como un archivo de texto sin formato.
function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- releaseDeployPhaseId
-
number
Id. de fase de implementación de versión.
- taskId
-
number
ReleaseTask Id. del registro.
- startLine
-
number
Número de línea inicial de los registros
- endLine
-
number
Número de línea final de los registros
Devoluciones
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Obtiene el registro de tareas de una versión como un archivo de texto sin formato.
function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
- attemptId
-
number
- timelineId
-
string
- taskId
-
number
ReleaseTask Id. del registro.
- startLine
-
number
Número de línea inicial de los registros
- endLine
-
number
Número de línea final de los registros
Devoluciones
Promise<string>
getTasks(string, number, number, number)
function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
Devoluciones
Promise<ReleaseTask[]>
getTasks2(string, number, number, number, string)
function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
- timelineId
-
string
Devoluciones
Promise<ReleaseTask[]>
getTasksForTaskGroup(string, number, number, number)
function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- environmentId
-
number
- releaseDeployPhaseId
-
number
Devoluciones
Promise<ReleaseTask[]>
listDefinitionEnvironmentTemplates(string, boolean)
Obtiene una lista de plantillas de entorno de definición.
function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- isDeleted
-
boolean
'true' para obtener las plantillas de entorno de definición que se han eliminado. El valor predeterminado es 'false'
Devoluciones
Promise<ReleaseDefinitionEnvironmentTemplate[]>
sendSummaryMail(MailMessage, string, number)
function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>Parámetros
- mailMessage
- MailMessage
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Devoluciones
Promise<void>
undeleteRelease(string, number, string)
Recuperar una versión eliminada temporalmente.
function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión que se va a deshacer.
- comment
-
string
Cualquier comentario para eliminarlo.
Devoluciones
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
Recuperar una definición de versión.
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>Parámetros
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
Objeto para la definición de liberación de desdelete.
- project
-
string
Id. de proyecto o nombre del proyecto
- definitionId
-
number
Identificador de la definición de versión que se va a deshacer
Devoluciones
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
Recuperar una plantilla de entorno de definición de versión.
function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- templateId
-
string
Identificador de la plantilla de entorno de definición que se va a deshacer
Devoluciones
Promise<ReleaseDefinitionEnvironmentTemplate>
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
.
- project
-
string
Id. de proyecto o nombre del proyecto
- path
-
string
Ruta de acceso de la carpeta que se va a actualizar.
Devoluciones
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
Novedades la puerta de una implementación.
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>Parámetros
- gateUpdateMetadata
- GateUpdateMetadata
Metadatos para aplicar revisiones a las puertas de lanzamiento.
- project
-
string
Id. de proyecto o nombre del proyecto
- gateStepId
-
number
Identificador del paso de puerta.
Devoluciones
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
Actualizar la intervención manual.
function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parámetros
- manualInterventionUpdateMetadata
- ManualInterventionUpdateMetadata
Metadatos para actualizar la intervención manual.
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- manualInterventionId
-
number
Id. de la intervención manual.
Devoluciones
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
configuración de la versión de canalización de Novedades organización
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Parámetros
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Devoluciones
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
Novedades configuración de versión de canalización
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>Parámetros
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
Actualice un objeto de versión completo.
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>Parámetros
- release
- Release
Objeto release para la actualización.
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión que se va a actualizar.
Devoluciones
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Estado de actualización de una aprobación
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Parámetros
- approval
- ReleaseApproval
ReleaseApproval objeto que tiene el estado, el aprobador y los comentarios.
- project
-
string
Id. de proyecto o nombre del proyecto
- approvalId
-
number
Id. de la aprobación.
Devoluciones
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>Parámetros
- approvals
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string)
Actualice una definición de versión.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Parámetros
- releaseDefinition
- ReleaseDefinition
Objeto de definición de versión que se va a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Actualización del estado de un entorno de versión
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>Parámetros
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Metadatos de actualización del entorno.
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Id. de la versión.
- environmentId
-
number
Id. del entorno de versión.
Devoluciones
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
Actualice algunas propiedades de una versión.
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>Parámetros
- releaseUpdateMetadata
- ReleaseUpdateMetadata
Propiedades de la versión que se va a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
Identificador de la versión que se va a actualizar.
Devoluciones
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Novedades la configuración de versión
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>Parámetros
- releaseSettings
- ReleaseSettings
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ReleaseSettings>