ReleaseRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Release |
Propriedades
| RESOURCE_AREA_ID |
Métodos
Detalhes do construtor
ReleaseRestClient(IVssRestClientOptions)
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do método
addDefinitionTag(string, number, string)
Adiciona uma marca 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
Retornos
Promise<string[]>
addDefinitionTags(string[], string, number)
Adiciona várias marcas 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
Retornos
Promise<string[]>
addReleaseTag(string, number, string)
Adiciona uma marca a uma 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
Retornos
Promise<string[]>
addReleaseTags(string[], string, number)
Adiciona marca 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
Retornos
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 ser criado
- project
-
string
ID do projeto ou nome do projeto
Retornos
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
Retornos
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.
Retornos
Promise<Folder>
createRelease(ReleaseStartMetadata, string)
Crie 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
Retornos
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 ser criado.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
Excluir 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
Retornos
Promise<void>
deleteDefinitionTag(string, number, string)
Exclui uma marca 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
Retornos
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
Retornos
Promise<void>
deleteFolder(string, string)
Exclui uma pasta de definição para determinado nome de pasta e caminho 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 ser excluída.
Retornos
Promise<void>
deleteRelease(string, number, string)
Exclusão temporária de 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
Comente para excluir uma versão.
Retornos
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Exclua 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
Comente para excluir uma definição de versão.
- forceDelete
-
boolean
'true' para cancelar automaticamente todas as implantações de versão em andamento e prosseguir com a exclusão da definição de versão. O padrão é 'false'.
Retornos
Promise<void>
deleteReleaseTag(string, number, string)
Exclui uma marca 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
Retornos
Promise<string[]>
getAgentArtifactDefinitions(string, number)
Retorna os detalhes do artefato que o agente de automação requer
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- releaseId
-
number
Retornos
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
"true" para incluir o histórico da aprovação. O padrão é 'false'.
Retornos
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.
Retornos
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 esse usuário.
- statusFilter
- ApprovalStatus
Aprovações com esse status. O padrão é 'pendente'.
- releaseIdsFilter
-
number[]
Aprovações para ids de versão mencionadas no filtro. Várias versões podem ser mencionadas separando-as com '', por exemplo, releaseIdsFilter=1,2,3,4.
- typeFilter
- ApprovalType
Aprovação com esse tipo.
- top
-
number
Número de aprovações a serem obtidos. O padrã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. O padrão é "decrescente".
- includeMyGroupApprovals
-
boolean
"true" para incluir minhas aprovações de grupo. O padrão é 'false'.
Retornos
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
Retornos
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
Retornos
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
Retornos
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
Retornos
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[]
Retornos
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
Retornos
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Obter a definição de versão para uma determinada 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.
Retornos
Promise<string>
getDefinitionTags(string, number)
Obtém as marcas 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
Retornos
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Obtém um selo que indica o status da implantação mais recente para um ambiente.
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>Parâmetros
- projectId
-
string
A ID do Projeto.
- releaseDefinitionId
-
number
A ID da definição de versão.
- environmentId
-
number
A ID do Ambiente.
- branchName
-
string
O nome do branch.
Retornos
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
Obter uma lista de implantaçõ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 implantações para uma determinada ID de definição.
- definitionEnvironmentId
-
number
Liste as implantações para uma determinada ID de ambiente de definição.
- createdBy
-
string
Liste as implantações para as quais as implantações são criadas como identidade especificada.
- minModifiedTime
-
Date
Liste as implantações com LastModified time >= minModifiedTime.
- maxModifiedTime
-
Date
Liste as implantações com LastModified time <= maxModifiedTime.
- deploymentStatus
- DeploymentStatus
Liste as implantações com determinado status de implantação. O padrão é "Todos".
- operationStatus
- DeploymentOperationStatus
Liste as implantações com determinada operação status. O padrão é "Todos".
- latestAttemptsOnly
-
boolean
'true' para incluir implantações apenas com a última tentativa. O padrão é 'false'.
- queryOrder
- ReleaseQueryOrder
Liste as implantações com determinada ordem de consulta. O padrão é "Decrescente".
- top
-
number
Liste as implantações com a parte superior fornecida. A parte superior padrão é '50' e a parte superior máxima é '100'.
- continuationToken
-
number
Liste as implantações com id >de implantação = continuationToken.
- createdFor
-
string
Liste as implantações para as quais as implantações são solicitadas como identidade especificada.
- minStartedTime
-
Date
Liste as implantações com StartedOn time >= minStartedTime.
- maxStartedTime
-
Date
Liste as implantações com StartedOn time <= maxStartedTime.
- sourceBranch
-
string
Liste as implantações implantadas de determinado nome de branch.
Retornos
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
Retornos
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
Retornos
Promise<FavoriteItem[]>
getFlightAssignments(string)
function getFlightAssignments(flightName?: string): Promise<string[]>Parâmetros
- flightName
-
string
Retornos
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. O padrão é 'None'.
Retornos
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Obtém logs de portão
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 do ReleaseTask para o log.
Retornos
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
Retornos
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
Retornos
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
Obtém logs
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 do ReleaseTask para o log.
- attemptId
-
number
Id da tentativa.
Retornos
Promise<string>
getLogs(string, number)
Obtenha logs para uma 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.
Retornos
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Obtenha intervenção manual para uma determinada versão e id de 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.
Retornos
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.
Retornos
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
Retornos
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Obtém as configurações de versão do pipeline da organização
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>Retornos
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
Obtém as configurações de versão do pipeline
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
Retornos
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 buscar etapas de aprovação seletivamente com base em se ele é automatizado ou manual. Isso também decidiria se devemos buscar instantâneos pré e pós-aprovação. Pressupõe Tudo por padrão
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades estendidas a serem recuperadas. Se definido, a Versão retornada conterá valores para as IDs de propriedade especificadas (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 registros de portão de lançamento a serem obtidos. O padrão é 5.
Retornos
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
Retornos
Promise<Change[]>
getReleaseDefinition(string, number, string[])
Obtenha 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 estendidas a serem recuperadas. Se definido, a Definição de Versão retornada conterá valores para as IDs de propriedade especificadas (se existirem). Se não estiver definido, as propriedades não serão incluídas.
Retornos
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
Obter histórico de revisão 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.
Retornos
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
Obter 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.
Retornos
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 contêm 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 fornecido serão retornadas. Os valores podem ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- artifactSourceId
-
string
As definições de versão com o artifactSourceId fornecido serão retornadas. Por exemplo, para compilação seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefatos de terceiros, por exemplo, TeamCity, BitBucket, você pode referir '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 serem obtidos.
- continuationToken
-
string
Obtém as definições de versão após o token de continuação fornecido.
- queryOrder
- ReleaseDefinitionQueryOrder
Obtém os resultados na ordem definida. O padrã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 correspondência exata, conforme especificado em searchText. O padrão é 'false'.
- tagFilter
-
string[]
Uma lista delimitada por vírgulas de marcas. Somente definições de versão com essas marcas serão retornadas.
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades estendidas a serem recuperadas. Se definido, as Definições de Versão retornadas conterão valores para as IDs de propriedade especificadas (se existirem). Se não estiver definido, as propriedades não serão incluídas. Observe que isso não filtrará nenhuma Definição de Versão dos resultados, independentemente de ter uma propriedade definida ou não.
- definitionIdFilter
-
string[]
Uma lista delimitada por vírgulas de definições de versão a serem recuperadas.
- isDeleted
-
boolean
'true' para obter definições de versão que foram excluídas. O padrão é 'false'
- searchTextContainsFolderName
-
boolean
'true' para obter as definições de versão na pasta com o nome conforme especificado em searchText. O padrão é 'false'.
Retornos
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Obtenha o resumo da versão de uma determinada 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 serem incluídas em resumo.
- includeArtifact
-
boolean
Inclua detalhes do artefato. O padrão é 'false'.
- definitionEnvironmentIdsFilter
-
number[]
Retornos
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
Obtenha um ambiente de lançamento.
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.
Retornos
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
Retornos
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>Parâmetros
- artifactType
-
string
- artifactSourceId
-
string
Retornos
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Obtenha a versão de 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
Definição instantâneo número de revisão.
Retornos
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 versões
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 desta 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 esse usuário.
- statusFilter
- ReleaseStatus
Versões que têm esse status.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Versões que foram criadas após esse tempo.
- maxCreatedTime
-
Date
Versões que foram criadas antes desta vez.
- queryOrder
- ReleaseQueryOrder
Obtém os resultados na ordem definida da data criada para versões. O padrão é decrescente.
- top
-
number
Número de versões a serem obtidos. O padrã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 versões.
- artifactTypeId
-
string
As versões com artifactTypeId fornecidas serão retornadas. Os valores podem ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
- sourceId
-
string
Identificador exclusivo do artefato usado. Por exemplo, para compilação seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefatos de terceiros, por exemplo, TeamCity, BitBucket, você pode referir 'uniqueSourceIdentifier' dentro de vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
- artifactVersionId
-
string
Versões com artifactVersionId fornecidas serão retornadas. Por exemplo, no caso de Build artifactType, ele é buildId.
- sourceBranchFilter
-
string
As versões com origemBranchFilter serão retornadas.
- isDeleted
-
boolean
Obtém as versões excluídas suavemente, se true.
- tagFilter
-
string[]
Uma lista delimitada por vírgulas de marcas. Somente versões com essas marcas serão retornadas.
- propertyFilters
-
string[]
Uma lista delimitada por vírgulas de propriedades estendidas a serem recuperadas. Se definido, as Versões retornadas conterão valores para as IDs de propriedade especificadas (se existirem). Se não estiver definido, as propriedades não serão incluídas. Observe que isso não filtrará nenhuma Versão dos resultados, independentemente de ele ter uma propriedade definida ou não.
- releaseIdFilter
-
number[]
Uma lista delimitada por vírgulas de IDs de versões. Somente as versões com essas IDs serão retornadas.
- path
-
string
As versões nesse caminho de pasta serão retornadas
Retornos
getReleaseSettings(string)
Obtém as configurações de versão
function getReleaseSettings(project: string): Promise<ReleaseSettings>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<ReleaseSettings>
getReleaseTags(string, number)
Obtém as marcas 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
Retornos
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 implantação.
- planId
-
string
ID do plano da fase de implantação.
- timelineId
-
string
ID da linha do tempo da tarefa.
- recordId
-
string
ID de registro do anexo.
- type
-
string
Tipo do anexo.
- name
-
string
Nome do anexo.
Retornos
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
Obtenha os anexos da tarefa de versão.
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 implantação.
- planId
-
string
ID do plano da fase de implantação.
- type
-
string
Tipo do anexo.
Retornos
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
Retornos
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
Retornos
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
Retornos
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
Retornos
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 implantação.
- timelineId
-
string
ID da linha do tempo da tarefa.
- recordId
-
string
ID de registro do anexo.
- type
-
string
Tipo do anexo.
- name
-
string
Nome do anexo.
Retornos
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Obtenha os anexos da tarefa.
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 implantação.
- timelineId
-
string
ID da linha do tempo da tarefa.
- type
-
string
Tipo do anexo.
Retornos
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Obtém o log de tarefas de uma versão como um arquivo de texto sem formatação.
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 implantação da versão.
- taskId
-
number
ID do ReleaseTask para o log.
- startLine
-
number
Número de linha inicial para logs
- endLine
-
number
Número de linha final para logs
Retornos
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Obtém o log de tarefas de uma versão como um arquivo de texto sem formatação.
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 do ReleaseTask para o log.
- startLine
-
number
Número de linha inicial para logs
- endLine
-
number
Número de linha final para logs
Retornos
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
Retornos
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
Retornos
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
Retornos
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 excluídos. O padrão é 'false'
Retornos
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
Retornos
Promise<void>
undeleteRelease(string, number, string)
Desmarque uma versão de exclusão reversí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 ser desmarada.
- comment
-
string
Qualquer comentário para desmarcando.
Retornos
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
Desmarque uma definição de versão.
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>Parâmetros
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
Objeto para desacompletar a definição de versão.
- project
-
string
ID do projeto ou nome do projeto
- definitionId
-
number
ID da definição de versão a ser descompletada
Retornos
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
Desmarque 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 ser desdeletado
Retornos
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
Atualizações uma pasta existente em 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 ser atualizada.
Retornos
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
Atualizações o portão de uma implantação.
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>Parâmetros
- gateUpdateMetadata
- GateUpdateMetadata
Metadados para corrigir os Portões de Liberação.
- project
-
string
ID do projeto ou nome do projeto
- gateStepId
-
number
ID da etapa do portão.
Retornos
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
Atualizar 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.
Retornos
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Atualizações configurações de versão do pipeline da Organização
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>Parâmetros
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Retornos
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
Atualizações configuraçõ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
Retornos
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
Objeto release para atualização.
- project
-
string
ID do projeto ou nome do projeto
- releaseId
-
number
Id da versão a ser atualizada.
Retornos
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Atualizar status de uma aprovação
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>Parâmetros
- approval
- ReleaseApproval
Objeto ReleaseApproval com status, aprovador e comentários.
- project
-
string
ID do projeto ou nome do projeto
- approvalId
-
number
Id da aprovação.
Retornos
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
Retornos
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 ser atualizado.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Atualizar o status de um ambiente de lançamento
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>Parâmetros
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Metadados de atualização de ambiente.
- project
-
string
ID do projeto ou nome do projeto
- releaseId
-
number
Id da versão.
- environmentId
-
number
Id do ambiente de lançamento.
Retornos
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
Atualize algumas propriedades de uma versão.
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>Parâmetros
- releaseUpdateMetadata
- ReleaseUpdateMetadata
Propriedades da versão a ser atualizada.
- project
-
string
ID do projeto ou nome do projeto
- releaseId
-
number
Id da versão a ser atualizada.
Retornos
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Atualizações as configuraçõ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
Retornos
Promise<ReleaseSettings>