ReleaseRestClient class
Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS
- Extends
Construtores
| Release |
Propriedades
| RESOURCE_AREA_ID |
Métodos
Detalhes do Construtor
ReleaseRestClient(IVssRestClientOptions)
Detalhes de Propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de Propriedade
string
Detalhes de Método
addDefinitionTag(string, number, string)
Adiciona uma etiqueta a uma definição
function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseDefinitionId
-
number
- tag
-
string
Devoluções
Promise<string[]>
addDefinitionTags(string[], string, number)
Adiciona várias etiquetas a uma definição
function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>Parâmetros
- tags
-
string[]
- project
-
string
ID do Projeto ou nome do projeto
- releaseDefinitionId
-
number
Devoluções
Promise<string[]>
addReleaseTag(string, number, string)
Adiciona uma etiqueta a um releaseId
function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
- tag
-
string
Devoluções
Promise<string[]>
addReleaseTags(string[], string, number)
Adiciona uma etiqueta a uma versão
function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>Parâmetros
- tags
-
string[]
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
Devoluções
Promise<string[]>
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)
Cria um modelo de ambiente de definição
function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parâmetros
- template
- ReleaseDefinitionEnvironmentTemplate
Modelo de ambiente de definição a criar
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
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 do Projeto ou nome do projeto
- scope
-
string
- identityId
-
string
Devoluções
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
Cria uma nova pasta.
function createFolder(folder: Folder, project: string, path?: string): Promise<Folder>Parâmetros
- folder
- Folder
.
- project
-
string
ID do Projeto ou nome do projeto
- path
-
string
Caminho da pasta.
Devoluções
Promise<Folder>
createRelease(ReleaseStartMetadata, string)
Create uma versão.
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>Parâmetros
- releaseStartMetadata
- ReleaseStartMetadata
Metadados para criar uma versão.
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
Criar uma definição de versão
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Parâmetros
- releaseDefinition
- ReleaseDefinition
objeto de definição de versão a criar.
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
Eliminar um modelo de ambiente de definição
function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- templateId
-
string
ID do modelo de ambiente de definição
Devoluções
Promise<void>
deleteDefinitionTag(string, number, string)
Elimina uma etiqueta de uma definição
function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseDefinitionId
-
number
- tag
-
string
Devoluções
Promise<string[]>
deleteFavorites(string, string, string, string)
function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- scope
-
string
- identityId
-
string
- favoriteItemIds
-
string
Devoluções
Promise<void>
deleteFolder(string, string)
Elimina uma pasta de definições para o nome e caminho da pasta e todas as definições existentes.
function deleteFolder(project: string, path: string): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- path
-
string
Caminho da pasta a eliminar.
Devoluções
Promise<void>
deleteRelease(string, number, string)
Eliminar de forma recuperável uma versão
function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- comment
-
string
Comentário para eliminar uma versão.
Devoluções
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Eliminar uma definição de versão.
function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição de versão.
- comment
-
string
Comentário para eliminar uma definição de versão.
- forceDelete
-
boolean
"true" para cancelar automaticamente quaisquer implementações de versão em curso e prosseguir com a eliminação da definição de versão. A predefinição é "false".
Devoluções
Promise<void>
deleteReleaseTag(string, number, string)
Elimina uma etiqueta de uma versão
function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
- tag
-
string
Devoluções
Promise<string[]>
getAgentArtifactDefinitions(string, number)
Devolve os detalhes do artefacto necessários para o agente de automatização
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
Devoluções
Promise<AgentArtifactDefinition[]>
getApproval(string, number, boolean)
Obtenha uma aprovação.
function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- approvalId
-
number
ID da aprovação.
- includeHistory
-
boolean
"verdadeiro" para incluir o histórico da aprovação. A predefinição é "false".
Devoluções
Promise<ReleaseApproval>
getApprovalHistory(string, number)
Obter histórico de aprovação.
function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- approvalStepId
-
number
ID da aprovação.
Devoluções
Promise<ReleaseApproval>
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)
Obter uma lista de aprovações
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 do Projeto ou nome do projeto
- assignedToFilter
-
string
Aprovações atribuídas a este utilizador.
- statusFilter
- ApprovalStatus
Aprovações com este estado. A predefinição é "pendente".
- releaseIdsFilter
-
number[]
Aprovações para id(s) de versão mencionadas no filtro. Podem ser mencionadas várias versões ao separá-las com "", por exemplo, releaseIdsFilter=1,2,3,4.
- typeFilter
- ApprovalType
Aprovação com este tipo.
- top
-
number
Número de aprovações a obter. A predefinição é 50.
- continuationToken
-
number
Obtém as aprovações após o token de continuação fornecido.
- queryOrder
- ReleaseQueryOrder
Obtém os resultados na ordem definida das aprovações criadas. A predefinição é "descendente".
- includeMyGroupApprovals
-
boolean
"verdadeiro" para incluir as minhas aprovações de grupo. A predefinição é "false".
Devoluções
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ArtifactTypeDefinition[]>
getArtifactVersions(string, number)
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseDefinitionId
-
number
Devoluções
Promise<ArtifactVersionQueryResult>
getArtifactVersionsForSources(Artifact[], string)
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>Parâmetros
- artifacts
-
Artifact[]
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
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 do Projeto ou nome do projeto
Devoluções
Promise<AutoTriggerIssue[]>
getDefinitionEnvironments(string, string, string[])
function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- taskGroupId
-
string
- propertyFilters
-
string[]
Devoluções
Promise<DefinitionEnvironmentReference[]>
getDefinitionEnvironmentTemplate(string, string)
Obtém um modelo de ambiente de definição
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- templateId
-
string
ID do modelo de ambiente de definição
Devoluções
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Obter a definição de versão para um determinado definitionId e revisão
function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição.
- revision
-
number
ID da revisão.
Devoluções
Promise<string>
getDefinitionTags(string, number)
Obtém as etiquetas de uma definição
function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseDefinitionId
-
number
Devoluções
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Obtém um distintivo que indica o estado da implementação mais recente de um ambiente.
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>Parâmetros
- projectId
-
string
O ID do Projeto.
- releaseDefinitionId
-
number
O ID da Definição de Versão.
- environmentId
-
number
O ID do Ambiente.
- branchName
-
string
O nome do ramo.
Devoluções
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
Obter uma lista de implementações
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 do Projeto ou nome do projeto
- definitionId
-
number
Liste as implementações para um determinado ID de definição.
- definitionEnvironmentId
-
number
Liste as implementações de um determinado ID de ambiente de definição.
- createdBy
-
string
Liste as implementações para as quais as implementações são criadas como identidade especificada.
- minModifiedTime
-
Date
Liste as implementações com LastModified time >= minModifiedTime.
- maxModifiedTime
-
Date
Liste as implementações com LastModified time <= maxModifiedTime.
- deploymentStatus
- DeploymentStatus
Liste as implementações com o estado de implementação especificado. A predefinição é "Tudo".
- operationStatus
- DeploymentOperationStatus
Liste as implementações com o estado da operação especificado. A predefinição é "Tudo".
- latestAttemptsOnly
-
boolean
"verdadeiro" para incluir implementações apenas com a última tentativa. A predefinição é "falso".
- queryOrder
- ReleaseQueryOrder
Liste as implementações com a ordem de consulta indicada. A predefinição é "Descendente".
- top
-
number
Liste as implementações com a parte superior indicada. A parte superior predefinida é "50" e a parte superior máxima é "100".
- continuationToken
-
number
Liste as implementações com o ID >de implementação = continuationToken.
- createdFor
-
string
Liste as implementações para as quais as implementações são pedidas como identidade especificada.
- minStartedTime
-
Date
Liste as implementações com a hora >StartedOn = minStartedTime.
- maxStartedTime
-
Date
Liste as implementações com a hora <StartedOn = maxStartedTime.
- sourceBranch
-
string
Liste as implementações implementadas a partir de um nome de ramo especificado.
Devoluções
Promise<PagedList<Deployment>>
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>Parâmetros
- queryParameters
- DeploymentQueryParameters
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<Deployment[]>
getFavorites(string, string, string)
function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- scope
-
string
- identityId
-
string
Devoluções
Promise<FavoriteItem[]>
getFlightAssignments(string)
function getFlightAssignments(flightName?: string): Promise<string[]>Parâmetros
- flightName
-
string
Devoluções
Promise<string[]>
getFolders(string, string, FolderPathQueryOrder)
Obtém pastas.
function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- path
-
string
Caminho da pasta.
- queryOrder
- FolderPathQueryOrder
Obtém os resultados na ordem definida. A predefinição é "Nenhum".
Devoluções
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Obtém registos de porta
function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- gateId
-
number
ID do portão.
- taskId
-
number
ID releaseTask para o registo.
Devoluções
Promise<string>
getInputValues(InputValuesQuery, string)
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>Parâmetros
- query
- InputValuesQuery
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<InputValuesQuery>
getIssues(string, number, string)
function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- buildId
-
number
- sourceId
-
string
Devoluções
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
Obtém registos
function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- taskId
-
number
ID releaseTask para o registo.
- attemptId
-
number
ID da tentativa.
Devoluções
Promise<string>
getLogs(string, number)
Obter registos de um ID de versão.
function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
Devoluções
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Obtenha intervenção manual para um determinado ID de lançamento e intervenção manual.
function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- manualInterventionId
-
number
ID da intervenção manual.
Devoluções
Promise<ManualIntervention>
getManualInterventions(string, number)
Liste todas as intervenções manuais para uma determinada versão.
function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
Devoluções
Promise<ManualIntervention[]>
getMetrics(string, Date)
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- minMetricsTime
-
Date
Devoluções
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Obtém as definições de versão do pipeline org
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Devoluções
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
Obtém as definições de versão do pipeline
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)
Obter uma Versão
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number): Promise<Release>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- approvalFilters
- ApprovalFilters
Um filtro que permitiria obter passos de aprovação seletivamente com base no facto de ser automatizado ou manual. Isto também decidiria se devemos obter instantâneos pré e pós-aprovação. Assume Tudo por predefinição
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades expandidas a obter. Se estiver definida, a Versão devolvida conterá valores para os IDs de propriedade especificados (se existirem). Se não estiver definido, as propriedades não serão incluídas.
- expand
- SingleReleaseExpands
Uma propriedade que deve ser expandida na versão.
- topGateRecords
-
number
Número de registos de porta de lançamento a obter. A predefinição é 5.
Devoluções
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 do Projeto ou nome do projeto
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Devoluções
Promise<Change[]>
getReleaseDefinition(string, number, string[])
Obter uma definição de versão.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseDefinition>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição de versão.
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades expandidas a obter. Se estiver definida, a Definição de Versão devolvida conterá valores para os IDs de propriedade especificados (se existirem). Se não estiver definido, as propriedades não serão incluídas.
Devoluções
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
Obter o histórico de revisões para uma definição de versão
function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição.
Devoluções
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
Obtenha a definição de versão de uma determinada revisão.
function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição de versão.
- revision
-
number
Número de revisão da definição de versão.
Devoluções
Promise<string>
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)
Obtenha uma lista de definições de versão.
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 do Projeto ou nome do projeto
- searchText
-
string
Obtenha definições de versão com nomes que contenham searchText.
- expand
- ReleaseDefinitionExpands
As propriedades que devem ser expandidas na lista de Definições de versão.
- artifactType
-
string
As definições de versão com o artifactType especificado serão devolvidas. Os valores podem ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- artifactSourceId
-
string
Serão devolvidas definições de versão com o artifactSourceId especificado. Por exemplo, para compilação seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefactos de terceiros, por exemplo, TeamCity, o BitBucket pode referir-se a "uniqueSourceIdentifier" dentro de vss-extension.json em https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- top
-
number
Número de definições de versão a obter.
- continuationToken
-
string
Obtém as definições de versão após o token de continuação fornecido.
- queryOrder
- ReleaseDefinitionQueryOrder
Obtém os resultados pela ordem definida. A predefinição é "IdAscending".
- path
-
string
Obtém as definições de versão no caminho especificado.
- isExactNameMatch
-
boolean
"true" para obter as definições de versão com a correspondência exata, conforme especificado em searchText. A predefinição é "false".
- tagFilter
-
string[]
Uma lista delimitada por vírgulas de etiquetas. Só serão devolvidas definições de versão com estas etiquetas.
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades expandidas a obter. Se estiver definido, as Definições de Versão devolvidas conterão valores para os IDs de propriedade especificados (se existirem). Se não for definido, as propriedades não serão incluídas. Tenha em atenção que isto não filtrará qualquer Definição de Versão dos resultados, independentemente de ter ou não uma propriedade definida.
- definitionIdFilter
-
string[]
Uma lista delimitada por vírgulas das definições de versão a obter.
- isDeleted
-
boolean
"true" para obter definições de versão que foram eliminadas. A predefinição é "false"
- searchTextContainsFolderName
-
boolean
"true" para obter as definições de versão na pasta com o nome, conforme especificado em searchText. A predefinição é "false".
Devoluções
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Obtenha o resumo da versão de um determinado ID de definição.
function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição para obter o resumo da versão.
- releaseCount
-
number
Contagem de versões a incluir em resumo.
- includeArtifact
-
boolean
Incluir detalhes do artefacto. A predefinição é "false".
- definitionEnvironmentIdsFilter
-
number[]
Devoluções
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
Obter um ambiente de versão.
function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- expand
- ReleaseEnvironmentExpands
Uma propriedade que deve ser expandida no ambiente.
Devoluções
Promise<ReleaseEnvironment>
getReleaseHistory(string, number)
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
Devoluções
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Parâmetros
- artifactType
-
string
- artifactSourceId
-
string
Devoluções
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Obtenha a versão para um determinado número de revisão.
function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- definitionSnapshotRevision
-
number
Número de revisão do instantâneo de definição.
Devoluções
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)
Obter uma lista de lançamentos
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 do Projeto ou nome do projeto
- definitionId
-
number
Versões deste ID de definição de versão.
- definitionEnvironmentId
-
number
- searchText
-
string
Versões com nomes que contêm searchText.
- createdBy
-
string
Versões criadas por este utilizador.
- statusFilter
- ReleaseStatus
Versões que têm este estado.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Versões que foram criadas após este período de tempo.
- maxCreatedTime
-
Date
Versões que foram criadas antes desta hora.
- queryOrder
- ReleaseQueryOrder
Obtém os resultados na ordem definida da data de criação das versões. A predefinição é descendente.
- top
-
number
Número de lançamentos a obter. A predefinição é 50.
- continuationToken
-
number
Obtém as versões após o token de continuação fornecido.
- expand
- ReleaseExpands
A propriedade que deve ser expandida na lista de lançamentos.
- artifactTypeId
-
string
Serão devolvidas versões com artifactTypeId especificado. Os valores podem ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- sourceId
-
string
Identificador exclusivo do artefacto utilizado. Por exemplo, para compilação seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefactos de terceiros, por exemplo, TeamCity, o BitBucket pode referir-se a "uniqueSourceIdentifier" no vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- artifactVersionId
-
string
Serão devolvidas versões com o artifactVersionId especificado. Por exemplo, no caso de Build artifactType, é buildId.
- sourceBranchFilter
-
string
Serão devolvidas versões com sourceBranchFilter especificado.
- isDeleted
-
boolean
Obtém as versões de eliminação recuperável, se forem verdadeiras.
- tagFilter
-
string[]
Uma lista delimitada por vírgulas de etiquetas. Apenas serão devolvidas versões com estas etiquetas.
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades expandidas a obter. Se estiver definido, as Versões devolvidas irão conter valores para os IDs de propriedade especificados (se existirem). Se não for definido, as propriedades não serão incluídas. Tenha em atenção que isto não filtrará qualquer Versão dos resultados, independentemente de ter ou não uma propriedade definida.
- releaseIdFilter
-
number[]
Uma lista delimitada por vírgulas de IDs de versões. Só serão devolvidas versões com estes IDs.
- path
-
string
Serão devolvidas versões neste caminho de pasta
Devoluções
getReleaseSettings(string)
Obtém as definições de versão
function getReleaseSettings(project: string): Promise<ReleaseSettings>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ReleaseSettings>
getReleaseTags(string, number)
Obtém as etiquetas de uma versão
function getReleaseTags(project: string, releaseId: number): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
Devoluções
Promise<string[]>
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)
Obter um anexo de tarefa de versão.
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 do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- attemptId
-
number
Número de tentativas de implementação.
- planId
-
string
ID do plano da fase de implementação.
- timelineId
-
string
ID da linha cronológica da tarefa.
- recordId
-
string
ID do registo do anexo.
- type
-
string
Tipo de anexo.
- name
-
string
Nome do anexo.
Devoluções
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
Obtenha os anexos da tarefa de lançamento.
function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- attemptId
-
number
Número de tentativas de implementação.
- planId
-
string
ID do plano da fase de implementação.
- type
-
string
Tipo de anexo.
Devoluções
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 do Projeto ou nome do projeto
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Devoluções
Promise<ReleaseWorkItemRef[]>
getSourceBranches(string, number)
function getSourceBranches(project: string, definitionId: number): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
Devoluções
Promise<string[]>
getSummaryMailSections(string, number)
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
Devoluções
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
Obter um anexo de tarefa.
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 do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- attemptId
-
number
Número de tentativas de implementação.
- timelineId
-
string
ID da linha cronológica da tarefa.
- recordId
-
string
ID de registo do anexo.
- type
-
string
Tipo de anexo.
- name
-
string
Nome do anexo.
Devoluções
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Obtenha os anexos de tarefas.
function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- attemptId
-
number
Número de tentativas de implementação.
- timelineId
-
string
ID da linha cronológica da tarefa.
- type
-
string
Tipo de anexo.
Devoluções
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Obtém o registo de tarefas de uma versão como um ficheiro de texto simples.
function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- releaseDeployPhaseId
-
number
ID da fase de implementação da versão.
- taskId
-
number
ID releaseTask para o registo.
- startLine
-
number
Número de linha inicial para registos
- endLine
-
number
Número de linha final para registos
Devoluções
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Obtém o registo de tarefas de uma versão como um ficheiro de texto simples.
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 do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
- attemptId
-
number
- timelineId
-
string
- taskId
-
number
ID releaseTask para o registo.
- startLine
-
number
Número de linha inicial para registos
- endLine
-
number
Número de linha final para registos
Devoluções
Promise<string>
getTasks(string, number, number, number)
function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
Devoluções
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 do Projeto ou nome do projeto
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
- timelineId
-
string
Devoluções
Promise<ReleaseTask[]>
getTasksForTaskGroup(string, number, number, number)
function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
- environmentId
-
number
- releaseDeployPhaseId
-
number
Devoluções
Promise<ReleaseTask[]>
listDefinitionEnvironmentTemplates(string, boolean)
Obtém uma lista de modelos de ambiente de definição
function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- isDeleted
-
boolean
"true" para obter modelos de ambiente de definição que foram eliminados. A predefinição é "falso"
Devoluções
Promise<ReleaseDefinitionEnvironmentTemplate[]>
sendSummaryMail(MailMessage, string, number)
function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>Parâmetros
- mailMessage
- MailMessage
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
Devoluções
Promise<void>
undeleteRelease(string, number, string)
Anular a eliminação de uma versão eliminada de forma recuperável.
function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão a anular.
- comment
-
string
Qualquer comentário para anular a eliminação.
Devoluções
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
Anular a eliminação de uma definição de versão.
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>Parâmetros
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
Objeto para anular a eliminação da definição de versão.
- project
-
string
ID do Projeto ou nome do projeto
- definitionId
-
number
ID da definição de versão a anular
Devoluções
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
Anular a eliminação de um modelo de ambiente de definição de versão.
function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- templateId
-
string
ID do modelo de ambiente de definição a anular
Devoluções
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
Atualizações uma pasta existente num determinado caminho existente.
function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>Parâmetros
- folder
- Folder
.
- project
-
string
ID do Projeto ou nome do projeto
- path
-
string
Caminho da pasta a atualizar.
Devoluções
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
Atualizações a porta para uma implementação.
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>Parâmetros
- gateUpdateMetadata
- GateUpdateMetadata
Metadados para corrigir as Portas de Lançamento.
- project
-
string
ID do Projeto ou nome do projeto
- gateStepId
-
number
ID do passo do portão.
Devoluções
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
Atualizar a intervenção manual.
function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>Parâmetros
- manualInterventionUpdateMetadata
- ManualInterventionUpdateMetadata
Metadados para atualizar a intervenção manual.
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- manualInterventionId
-
number
ID da intervenção manual.
Devoluções
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Atualizações definições de versão do pipeline org
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Parâmetros
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Devoluções
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
Atualizações definições de versão do pipeline
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>Parâmetros
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
Atualize um objeto de versão completo.
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>Parâmetros
- release
- Release
Libertar objeto para atualização.
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão a atualizar.
Devoluções
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Estado da atualização de uma aprovação
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Parâmetros
- approval
- ReleaseApproval
Objeto ReleaseApproval com estado, aprovador e comentários.
- project
-
string
ID do Projeto ou nome do projeto
- approvalId
-
number
ID da aprovação.
Devoluções
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>Parâmetros
- approvals
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string)
Atualizar uma definição de versão.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>Parâmetros
- releaseDefinition
- ReleaseDefinition
Objeto de definição de versão a atualizar.
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Atualizar o estado de um ambiente de versão
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>Parâmetros
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Dados metadados de atualização do ambiente.
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão.
- environmentId
-
number
ID do ambiente de lançamento.
Devoluções
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
Atualizar poucas propriedades de uma versão.
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>Parâmetros
- releaseUpdateMetadata
- ReleaseUpdateMetadata
Propriedades da versão a atualizar.
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
ID da versão a atualizar.
Devoluções
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Atualizações as definições de versão
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>Parâmetros
- releaseSettings
- ReleaseSettings
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ReleaseSettings>