ReleaseRestClient class

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends: RestClientBase

Construtores

ReleaseRestClient(IVssRestClientOptions)

Propriedades

Métodos

addDefinitionTag(string, number, string)	Adiciona uma tag a uma definição
addDefinitionTags(string[], string, number)	Adiciona várias tags a uma definição
addReleaseTag(string, number, string)	Adiciona uma tag a um releaseId
addReleaseTags(string[], string, number)	Adiciona tag a uma versão
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Cria um modelo de ambiente de definição
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Cria uma nova pasta.
createRelease(ReleaseStartMetadata, string)	Crie uma versão.
createReleaseDefinition(ReleaseDefinition, string)	Criar uma definição de versão
deleteDefinitionEnvironmentTemplate(string, string)	Excluir um modelo de ambiente de definição
deleteDefinitionTag(string, number, string)	Exclui uma tag de uma definição
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Exclui uma pasta de definição para determinado nome de pasta e caminho e todas as definições existentes.
deleteRelease(string, number, string)	Excluir suavemente uma versão
deleteReleaseDefinition(string, number, string, boolean)	Exclua uma definição de versão.
deleteReleaseTag(string, number, string)	Exclui uma tag de uma versão
getAgentArtifactDefinitions(string, number)	Retorna os detalhes do artefato que o agente de automação requer
getApproval(string, number, boolean)	Obtenha uma aprovação.
getApprovalHistory(string, number)	Obtenha o histórico de aprovação.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Obter uma lista de aprovações
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Obtém um modelo de ambiente de definição
getDefinitionRevision(string, number, number)	Obter definição de versão para uma determinada definitionId e revisão
getDefinitionTags(string, number)	Obtém as tags para uma definição
getDeploymentBadge(string, number, number, string)	Obtém um selo que indica o status da implantação mais recente para um ambiente.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Obter uma lista de implantações
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFolders(string, string, FolderPathQueryOrder)	Obtém pastas.
getGateLog(string, number, number, number, number)	Obtém logs de portão
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Obtém logs
getLogs(string, number)	Obtenha logs para uma ID de versão.
getManualIntervention(string, number, number)	Obtenha intervenção manual para uma determinada liberação e ID de intervenção manual.
getManualInterventions(string, number)	Liste todas as intervenções manuais para uma determinada versão.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Obtém as configurações de liberação do pipeline da organização
getPipelineReleaseSettings(string)	Obtém configurações de liberação de pipeline
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)	Obtenha uma versão
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[], boolean)	Obtenha uma definição de versão.
getReleaseDefinitionHistory(string, number)	Obter histórico de revisões para uma definição de versão
getReleaseDefinitionRevision(string, number, number)	Obtenha a definição de liberação de uma determinada revisão.
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.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Obtenha o resumo da versão de uma determinada definição Id.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Obtenha um ambiente de lançamento.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Obtenha autorização para um determinado número de revisão.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Obtenha uma lista de lançamentos
getReleaseSettings(string)	Obtém as configurações de versão
getReleaseTags(string, number)	Obtém as tags para uma versão
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Obtenha um anexo de tarefa de versão.
getReleaseTaskAttachments(string, number, number, number, string, string)	Obtenha os anexos da tarefa de versão.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Obter um anexo de tarefa.
getTaskAttachments(string, number, number, number, string, string)	Obtenha os anexos da tarefa.
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.
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.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Obtém uma lista de modelos de ambiente de definição
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Cancele a exclusão de uma versão excluída suavemente.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Cancelar a exclusão de uma definição de versão.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Cancele a exclusão de um modelo de ambiente de definição de versão.
updateFolder(Folder, string, string)	Atualiza uma pasta existente em determinado caminho existente.
updateGates(GateUpdateMetadata, string, number)	Atualiza o portão para uma implantação.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Atualizar a intervenção manual.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Atualiza as configurações de liberação do pipeline da organização
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	Atualiza as configurações de liberação do pipeline
updateRelease(Release, string, number)	Atualize um objeto de versão completa.
updateReleaseApproval(ReleaseApproval, string, number)	Atualizar o status de uma aprovação
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string, boolean)	Atualize uma definição de versão.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Atualizar o status de um ambiente de lançamento
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Atualize algumas propriedades de uma versão.
updateReleaseSettings(ReleaseSettings, string)	Atualiza as configurações de versão

Detalhes do Construtor

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addDefinitionTag(string, number, string)

Adiciona uma tag 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 tags 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 tag 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 tag 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 ser criado

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: FavoriteItem[]

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

pasta.

project: string

ID do projeto ou nome do projeto

path: string

Caminho da pasta.

Devoluções

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

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 liberação a ser criado.

project: string

ID do projeto ou nome do projeto

Devoluções

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

Devoluções

Promise<void>

deleteDefinitionTag(string, number, string)

Exclui uma tag 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)

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.

Devoluções

Promise<void>

deleteRelease(string, number, string)

Excluir suavemente 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 do lançamento.

comment: string

Comentário para excluir uma versão.

Devoluções

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

Comentário 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'.

Devoluções

Promise<void>

deleteReleaseTag(string, number, string)

Exclui uma tag 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)

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

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. O padrão é 'false'.

Devoluções

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Obtenha o 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 usuário.

statusFilter: ApprovalStatus

Aprovações com esse status. O padrão é 'pendente'.

releaseIdsFilter: number[]

Aprovações para id(s) de liberação mencionados no filtro. Várias versões podem ser mencionadas separando-as com '', por exemplo, releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Aprovação com este tipo.

top: number

Número de aprovações a obter. 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

"verdadeiro" para incluir as aprovações do meu grupo. O padrã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 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.

Devoluções

Promise<string>

getDefinitionTags(string, number)

Obtém as tags para 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 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

O ID da definição de versão.

environmentId: number

A ID do ambiente.

branchName: string

O nome da filial.

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 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 conforme a 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 determinado status de operação. O padrão é 'Todos'.

latestAttemptsOnly: boolean

'true' para incluir implantações apenas com a tentativa mais recente. 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 determinado topo. O topo padrão é '50' e o topo máximo é '100'.

continuationToken: number

Liste as implantações com deployment id >= continuationToken.

createdFor: string

Liste as implantações para as quais as implantações são solicitadas conforme a 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 que são implantadas a partir de determinado nome de ramo.

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[]>

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 é 'Nenhum'.

Devoluções

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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

gateId: number

Id do portão.

taskId: number

ReleaseTask Id para o log.

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 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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

taskId: number

ReleaseTask Id para o log.

attemptId: number

Id da tentativa.

Devoluções

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 do lançamento.

Devoluções

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Obtenha intervenção manual para uma determinada liberaçã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 do lançamento.

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 do lançamento.

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 configurações de liberação do pipeline da organização

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Devoluções

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Obtém configurações de liberação de 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, boolean)

Obtenha uma versão

function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number, includeDisabledDefinitions?: boolean): Promise<Release>

Parâmetros

project: string

ID do projeto ou nome do projeto

releaseId: number

Id do lançamento.

approvalFilters: ApprovalFilters

Um filtro que permitiria obter etapas de aprovação seletivamente com base no fato de ser automatizado ou manual. Isso também decidiria se deveríamos buscar instantâneos pré e pós-aprovação. Assume Tudo por padrão

propertyFilters: string[]

Uma lista delimitada por vírgulas de propriedades estendidas a serem recuperadas. Se definido, o Release retornado conterá valores para a propriedade especificada Ids (se existirem). Se não forem definidas, 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 porta de liberação para obter. O padrão é 5.

includeDisabledDefinitions: boolean

Incluir definições desabilitadas (se definido como 'false' retorna erro, o padrão é 'true')

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[], boolean)

Obtenha uma definição de versão.

function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): 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 definida, a Definição de Versão retornada conterá valores para as Ids de propriedade especificadas (se existirem). Se não forem definidas, as propriedades não serão incluídas.

includeDisabled: boolean

Sinalizador booleano para incluir definições desativadas.

Devoluções

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Obter 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 liberaçã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 determinado artifactType 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 determinado artifactSourceId serão retornadas. Por exemplo, para build seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefatos de terceiros, por exemplo, TeamCity, BitBucket, você pode consultar 'uniqueSourceIdentifier' dentro 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 na ordem definida. O padrão é 'IdAscending'.

path: string

Obtém as definições de versão no caminho especificado.

isExactNameMatch: boolean

'true'to obtém 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 tags. Somente as definições de versão com essas tags 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 forem definidas, 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 a 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'.

Devoluções

Promise<PagedList<ReleaseDefinition>>

getReleaseDefinitionSummary(string, number, number, boolean, number[])

Obtenha o resumo da versão de uma determinada definição Id.

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 lançamentos a incluir no resumo.

includeArtifact: boolean

Inclua detalhes do artefato. O padrão é 'false'.

definitionEnvironmentIdsFilter: number[]

Devoluções

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 do lançamento.

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 autorizaçã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 do lançamento.

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)

Obtenha 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<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

Lançamentos com nomes contendo searchText.

createdBy: string

Versões criadas por este utilizador.

statusFilter: ReleaseStatus

Versões que têm esse status.

environmentStatusFilter: number

minCreatedTime: Date

Lançamentos que foram criados após esse período.

maxCreatedTime: Date

Lançamentos que foram criados antes desse período.

queryOrder: ReleaseQueryOrder

Obtém os resultados na ordem definida de data de criação para lançamentos. O padrão é decrescente.

top: number

Número de lançamentos a obter. 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 lançamentos.

artifactTypeId: string

As versões com determinado artifactTypeId 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 build seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefatos de terceiros, por exemplo, TeamCity, BitBucket, você pode se referir a 'uniqueSourceIdentifier' dentro vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

As versões com determinado artifactVersionId serão retornadas. Por exemplo, no caso de Build artifactType, é buildId.

sourceBranchFilter: string

Versões com determinado sourceBranchFilter serão retornadas (Não deve ser usado com environmentStatusFilter).

isDeleted: boolean

Obtém as versões excluídas suavemente, se verdadeiro.

tagFilter: string[]

Uma lista delimitada por vírgulas de tags. Somente lançamentos com essas tags serão devolvidos.

propertyFilters: string[]

Uma lista delimitada por vírgulas de propriedades estendidas a serem recuperadas. Se definido, as Liberações retornadas conterão valores para as Ids da propriedade especificada (se existirem). Se não forem definidas, as propriedades não serão incluídas. Observe que isso não filtrará nenhuma versão dos resultados, independentemente de ter a propriedade definida ou não.

releaseIdFilter: number[]

Uma lista delimitada por vírgulas de versões Ids. Apenas as versões com estes Ids serão devolvidas.

path: string

As versões sob este caminho de pasta serão retornadas

Devoluções

Promise<Release[]>

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

Devoluções

Promise<ReleaseSettings>

getReleaseTags(string, number)

Obtém as tags para 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)

Obtenha 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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

attemptId: number

Número da tentativa de implantação.

planId: string

ID do plano da fase de implantaçã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>

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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

attemptId: number

Número da tentativa de implantação.

planId: string

ID do plano da fase de implantaçã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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

attemptId: number

Número da tentativa de implantaçã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 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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

attemptId: number

Número da tentativa de implantaçã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 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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

releaseDeployPhaseId: number

Lançamento da fase de implantação Id.

taskId: number

ReleaseTask Id para o log.

startLine: number

Número da linha inicial para logs

endLine: number

Número de linha final para logs

Devoluções

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 do lançamento.

environmentId: number

Id do ambiente de lançamento.

attemptId: number

timelineId: string

taskId: number

ReleaseTask Id para o log.

startLine: number

Número da linha inicial para logs

endLine: number

Número de linha final para logs

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 excluídos. O padrão é 'false'

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)

Cancele a exclusão de uma versão excluída suavemente.

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 liberação a ser removida.

comment: string

Qualquer comentário para cancelar a exclusão.

Devoluções

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Cancelar a exclusão de uma definição de versão.

function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>

Parâmetros

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Objeto para definição de liberação de undelete.

project: string

ID do projeto ou nome do projeto

definitionId: number

Id da definição de liberação a ser removida

Devoluções

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Cancele a exclusã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 ser retirado

Devoluções

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Atualiza uma pasta existente em determinado caminho existente.

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

Parâmetros

folder: Folder

pasta.

project: string

ID do projeto ou nome do projeto

path: string

Caminho da pasta a ser atualizada.

Devoluções

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Atualiza o portão para uma implantaçã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 do lançamento.

manualInterventionId: number

Id da intervenção manual.

Devoluções

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Atualiza as configurações de liberação do pipeline da organização

function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>

Parâmetros

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Devoluções

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

Atualiza as configurações de liberaçã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 completa.

function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>

Parâmetros

release: Release

Objeto de liberação para atualização.

project: string

ID do projeto ou nome do projeto

releaseId: number

Id da versão a ser atualizada.

Devoluções

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Atualizar o 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.

Devoluções

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>

Parâmetros

approvals: ReleaseApproval[]

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string, boolean)

Atualize uma definição de versão.

function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string, skipTasksValidation?: boolean): Promise<ReleaseDefinition>

Parâmetros

releaseDefinition: ReleaseDefinition

Objeto de definição de liberação a ser atualizado.

project: string

ID do projeto ou nome do projeto

skipTasksValidation: boolean

Ignorar sinalizador booleano de validação de tarefa

Devoluções

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 do ambiente.

project: string

ID do projeto ou nome do projeto

releaseId: number

Id do lançamento.

environmentId: number

Id do ambiente de lançamento.

Devoluções

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 de liberação para atualização.

project: string

ID do projeto ou nome do projeto

releaseId: number

Id da versão a ser atualizada.

Devoluções

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Atualiza 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

Devoluções

Promise<ReleaseSettings>

Comentários

Esta página foi útil?

Partilhar via

ReleaseRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

ReleaseRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

addDefinitionTag(string, number, string)

Parâmetros

Devoluções

addDefinitionTags(string[], string, number)

Parâmetros

Devoluções

addReleaseTag(string, number, string)

Parâmetros

Devoluções

addReleaseTags(string[], string, number)

Parâmetros

Devoluções

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Parâmetros

Devoluções

createFavorites(FavoriteItem[], string, string, string)

Parâmetros

Devoluções

createFolder(Folder, string, string)

Parâmetros

Devoluções

createRelease(ReleaseStartMetadata, string)

Parâmetros

Devoluções

createReleaseDefinition(ReleaseDefinition, string)

Parâmetros

Devoluções

deleteDefinitionEnvironmentTemplate(string, string)

Parâmetros

Devoluções

deleteDefinitionTag(string, number, string)

Parâmetros

Devoluções

deleteFavorites(string, string, string, string)

Parâmetros

Devoluções

deleteFolder(string, string)

Parâmetros

Devoluções

deleteRelease(string, number, string)

Parâmetros

Devoluções

deleteReleaseDefinition(string, number, string, boolean)

Parâmetros

Devoluções

deleteReleaseTag(string, number, string)

Parâmetros

Devoluções

getAgentArtifactDefinitions(string, number)

Parâmetros

Devoluções

getApproval(string, number, boolean)

Parâmetros

Devoluções

getApprovalHistory(string, number)

Parâmetros

Devoluções

getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)

Parâmetros

Devoluções

getArtifactTypeDefinitions(string)

Parâmetros

Devoluções

getArtifactVersions(string, number)

Parâmetros

Devoluções

getArtifactVersionsForSources(Artifact[], string)

Parâmetros