ReleaseRestClient class

Ссылка

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends: RestClientBase

Конструкторы

ReleaseRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addDefinitionTag(string, number, string)	Добавление тега в определение
addDefinitionTags(string[], string, number)	Добавление нескольких тегов в определение
addReleaseTag(string, number, string)	Добавление тега в releaseId
addReleaseTags(string[], string, number)	Добавление тега в выпуск
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	Создает шаблон среды определения
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	Создает новую папку.
createRelease(ReleaseStartMetadata, string)	Создадите выпуск.
createReleaseDefinition(ReleaseDefinition, string)	Создание определения выпуска
deleteDefinitionEnvironmentTemplate(string, string)	Удаление шаблона среды определения
deleteDefinitionTag(string, number, string)	Удаляет тег из определения.
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	Удаляет папку определения для заданного имени и пути к папке, а также всех существующих определений.
deleteRelease(string, number, string)	Обратимое удаление выпуска
deleteReleaseDefinition(string, number, string, boolean)	Удаление определения выпуска.
deleteReleaseTag(string, number, string)	Удаляет тег из выпуска
getAgentArtifactDefinitions(string, number)	Возвращает сведения об артефакте, необходимые агенту автоматизации.
getApproval(string, number, boolean)	Получите утверждение.
getApprovalHistory(string, number)	Получение журнала утверждений.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	Получение списка утверждений
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	Возвращает шаблон среды определения.
getDefinitionRevision(string, number, number)	Получение определения выпуска для заданного definitionId и редакции
getDefinitionTags(string, number)	Возвращает теги для определения.
getDeploymentBadge(string, number, number, string)	Получает значок, указывающий состояние последнего развертывания для среды.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	Получение списка развертываний
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)	Получает папки.
getGateLog(string, number, number, number, number)	Возвращает журналы шлюза.
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	Возвращает журналы.
getLogs(string, number)	Получение журналов для идентификатора выпуска.
getManualIntervention(string, number, number)	Получите ручное вмешательство для заданного выпуска и идентификатора ручного вмешательства.
getManualInterventions(string, number)	Перечисление всех ручных действий для конкретного выпуска.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	Возвращает параметры выпуска конвейера организации
getPipelineReleaseSettings(string)	Возвращает параметры выпуска конвейера.
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)	Получение выпуска
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[])	Получение определения выпуска.
getReleaseDefinitionHistory(string, number)	Получение журнала редакций для определения выпуска
getReleaseDefinitionRevision(string, number, number)	Получение определения выпуска данной редакции.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	Получение списка определений выпусков.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	Получение сводки по выпуску заданного идентификатора определения.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	Получение среды выпуска.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	Получение выпуска для заданного номера редакции.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	Получение списка выпусков
getReleaseSettings(string)	Возвращает параметры выпуска.
getReleaseTags(string, number)	Возвращает теги для выпуска.
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	Получение вложения задачи выпуска.
getReleaseTaskAttachments(string, number, number, number, string, string)	Получение вложений задачи выпуска.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	Получение вложения задачи.
getTaskAttachments(string, number, number, number, string, string)	Получение вложений задачи.
getTaskLog(string, number, number, number, number, number, number)	Возвращает журнал задач выпуска в виде обычного текстового файла.
getTaskLog2(string, number, number, number, string, number, number, number)	Возвращает журнал задач выпуска в виде обычного текстового файла.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	Возвращает список шаблонов среды определения.
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	Отмена обратимо удаленного выпуска.
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	Отмена удаления определения выпуска.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	Отмена удаления шаблона среды определения выпуска.
updateFolder(Folder, string, string)	Обновления существующую папку по указанному пути.
updateGates(GateUpdateMetadata, string, number)	Обновления шлюз для развертывания.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	Обновление ручного вмешательства.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	Параметры выпуска конвейера Обновления организации
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	параметры выпуска конвейера Обновления
updateRelease(Release, string, number)	Обновите полный объект выпуска.
updateReleaseApproval(ReleaseApproval, string, number)	Обновление состояния утверждения
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string)	Обновление определения выпуска.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	Обновление состояния среды выпуска
updateReleaseResource(ReleaseUpdateMetadata, string, number)	Обновление нескольких свойств выпуска.
updateReleaseSettings(ReleaseSettings, string)	Обновления параметров выпуска

Сведения о конструкторе

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addDefinitionTag(string, number, string)

Добавление тега в определение

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

Параметры

project: string

Идентификатор проекта или имя проекта

releaseDefinitionId: number

tag: string

Возвращаемое значение

Promise<string[]>

addDefinitionTags(string[], string, number)

Добавление нескольких тегов в определение

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

Параметры

tags: string[]

project: string

Идентификатор проекта или имя проекта

releaseDefinitionId: number

Возвращаемое значение

Promise<string[]>

addReleaseTag(string, number, string)

Добавление тега в releaseId

function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

tag: string

Возвращаемое значение

Promise<string[]>

addReleaseTags(string[], string, number)

Добавление тега в выпуск

function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>

Параметры

tags: string[]

project: string

Идентификатор проекта или имя проекта

releaseId: number

Возвращаемое значение

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Создает шаблон среды определения

function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>

Параметры

template: ReleaseDefinitionEnvironmentTemplate

Шаблон среды определения для создания

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ReleaseDefinitionEnvironmentTemplate>

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

function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>

Параметры

favoriteItems: FavoriteItem[]

project: string

Идентификатор проекта или имя проекта

scope: string

identityId: string

Возвращаемое значение

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

Создает новую папку.

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

Параметры

folder: Folder

project: string

Идентификатор проекта или имя проекта

path: string

Путь к папке.

Возвращаемое значение

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

Создадите выпуск.

function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>

Параметры

releaseStartMetadata: ReleaseStartMetadata

Метаданные для создания выпуска.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

Создание определения выпуска

function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>

Параметры

releaseDefinition: ReleaseDefinition

объект определения выпуска, который требуется создать.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

Удаление шаблона среды определения

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

Параметры

project: string

Идентификатор проекта или имя проекта

templateId: string

Идентификатор шаблона среды определения

Возвращаемое значение

Promise<void>

deleteDefinitionTag(string, number, string)

Удаляет тег из определения.

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

Параметры

project: string

Идентификатор проекта или имя проекта

releaseDefinitionId: number

tag: string

Возвращаемое значение

Promise<string[]>

deleteFavorites(string, string, string, string)

function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

scope: string

identityId: string

favoriteItemIds: string

Возвращаемое значение

Promise<void>

deleteFolder(string, string)

Удаляет папку определения для заданного имени и пути к папке, а также всех существующих определений.

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

Параметры

project: string

Идентификатор проекта или имя проекта

path: string

Путь к удаляемой папке.

Возвращаемое значение

Promise<void>

deleteRelease(string, number, string)

Обратимое удаление выпуска

function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска.

comment: string

Комментарий к удалению выпуска.

Возвращаемое значение

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

Удаление определения выпуска.

function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения выпуска.

comment: string

Комментарий к удалению определения выпуска.

forceDelete: boolean

"true", чтобы автоматически отменить все выполняющиеся развертывания выпуска и продолжить удаление определения выпуска . Значение по умолчанию — false.

Возвращаемое значение

Promise<void>

deleteReleaseTag(string, number, string)

Удаляет тег из выпуска

function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

tag: string

Возвращаемое значение

Promise<string[]>

getAgentArtifactDefinitions(string, number)

Возвращает сведения об артефакте, необходимые агенту автоматизации.

function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Возвращаемое значение

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

Получите утверждение.

function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>

Параметры

project: string

Идентификатор проекта или имя проекта

approvalId: number

Идентификатор утверждения.

includeHistory: boolean

"true", чтобы включить журнал утверждения. Значение по умолчанию — false.

Возвращаемое значение

Promise<ReleaseApproval>

getApprovalHistory(string, number)

Получение журнала утверждений.

function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>

Параметры

project: string

Идентификатор проекта или имя проекта

approvalStepId: number

Идентификатор утверждения.

Возвращаемое значение

Promise<ReleaseApproval>

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

Получение списка утверждений

function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>

Параметры

project: string

Идентификатор проекта или имя проекта

assignedToFilter: string

Утверждения, назначенные этому пользователю.

statusFilter: ApprovalStatus

Утверждения с таким состоянием. Значение по умолчанию — pending.

releaseIdsFilter: number[]

Утверждения для идентификаторов выпуска, указанных в фильтре. Несколько выпусков можно упомянуть, разделив их с помощью , например releaseIdsFilter=1,2,3,4.

typeFilter: ApprovalType

Утверждение с этим типом.

top: number

Количество утверждений для получения. Значение по умолчанию — 50.

continuationToken: number

Возвращает утверждения после предоставления маркера продолжения.

queryOrder: ReleaseQueryOrder

Возвращает результаты в определенном порядке созданных утверждений. Значение по умолчанию — "по убыванию".

includeMyGroupApprovals: boolean

"true", чтобы включить утверждения моей группы. Значение по умолчанию — false.

Возвращаемое значение

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseDefinitionId: number

Возвращаемое значение

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>

Параметры

artifacts: Artifact[]

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>

Параметры

artifactType: string

sourceId: string

artifactVersionId: string

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>

Параметры

project: string

Идентификатор или имя проекта

taskGroupId: string

propertyFilters: string[]

Возвращаемое значение

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

Возвращает шаблон среды определения.

function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>

Параметры

project: string

Идентификатор или имя проекта

templateId: string

Идентификатор шаблона среды определения

Возвращаемое значение

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

Получение определения выпуска для заданного definitionId и редакции

function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Идентификатор определения.

revision: number

Идентификатор редакции.

Возвращаемое значение

Promise<string>

getDefinitionTags(string, number)

Возвращает теги для определения.

function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>

Параметры

project: string

Идентификатор или имя проекта

releaseDefinitionId: number

Возвращаемое значение

Promise<string[]>

getDeploymentBadge(string, number, number, string)

Получает значок, указывающий состояние последнего развертывания для среды.

function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>

Параметры

projectId: string

Идентификатор проекта.

releaseDefinitionId: number

Идентификатор определения выпуска.

environmentId: number

Идентификатор среды.

branchName: string

Имя ветви.

Возвращаемое значение

Promise<string>

getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)

Получение списка развертываний

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

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Перечисление развертываний для заданного идентификатора определения.

definitionEnvironmentId: number

Перечисление развертываний для заданного идентификатора среды определения.

createdBy: string

Список развертываний, для которых создаются развертывания в соответствии с указанным удостоверением.

minModifiedTime: Date

Выведите список развертываний с параметром LastModified time >= minModifiedTime.

maxModifiedTime: Date

Выведите список развертываний с параметром LastModified time <= maxModifiedTime.

deploymentStatus: DeploymentStatus

Вывод списка развертываний с заданным состоянием развертывания. Значение по умолчанию — "Все".

operationStatus: DeploymentOperationStatus

Вывод списка развертываний с заданным состоянием операции. Значение по умолчанию — "Все".

latestAttemptsOnly: boolean

"true", чтобы включить развертывания только с последней попыткой. Значение по умолчанию — false.

queryOrder: ReleaseQueryOrder

Вывод списка развертываний с заданным порядком запроса. Значение по умолчанию — "По убыванию".

top: number

Вывод списка развертываний с заданным сверху. По умолчанию верхний — "50", а максимальный — "100".

continuationToken: number

Выведите список развертываний с идентификатором >развертывания = continuationToken.

createdFor: string

Список развертываний, для которых запрашиваются развертывания в соответствии с указанным удостоверением.

minStartedTime: Date

Выведите список развертываний с параметром StartedOn Time >= minStartedTime.

maxStartedTime: Date

Выведите список развертываний с параметром StartedOn time <= maxStartedTime.

sourceBranch: string

Выведите список развертываний, развертываемых из заданного имени ветви.

Возвращаемое значение

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>

Параметры

queryParameters: DeploymentQueryParameters

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<Deployment[]>

getFavorites(string, string, string)

function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>

Параметры

project: string

Идентификатор или имя проекта

scope: string

identityId: string

Возвращаемое значение

Promise<FavoriteItem[]>

getFlightAssignments(string)

function getFlightAssignments(flightName?: string): Promise<string[]>

Параметры

flightName: string

Возвращаемое значение

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

Получает папки.

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

Параметры

project: string

Идентификатор или имя проекта

path: string

Путь к папке.

queryOrder: FolderPathQueryOrder

Возвращает результаты в определенном порядке. Значение по умолчанию — None.

Возвращаемое значение

Promise<Folder[]>

getGateLog(string, number, number, number, number)

Возвращает журналы шлюза.

function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

gateId: number

Идентификатор ворот.

taskId: number

ReleaseTask Id для журнала.

Возвращаемое значение

Promise<string>

getInputValues(InputValuesQuery, string)

function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>

Параметры

query: InputValuesQuery

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<InputValuesQuery>

getIssues(string, number, string)

function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>

Параметры

project: string

Идентификатор или имя проекта

buildId: number

sourceId: string

Возвращаемое значение

Promise<AutoTriggerIssue[]>

getLog(string, number, number, number, number)

Возвращает журналы.

function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

taskId: number

ReleaseTask Id для журнала.

attemptId: number

Идентификатор попытки.

Возвращаемое значение

Promise<string>

getLogs(string, number)

Получение журналов для идентификатора выпуска.

function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

Возвращаемое значение

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

Получите ручное вмешательство для заданного выпуска и идентификатора ручного вмешательства.

function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

manualInterventionId: number

Идентификатор ручного вмешательства.

Возвращаемое значение

Promise<ManualIntervention>

getManualInterventions(string, number)

Перечисление всех ручных действий для конкретного выпуска.

function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

Возвращаемое значение

Promise<ManualIntervention[]>

getMetrics(string, Date)

function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>

Параметры

project: string

Идентификатор или имя проекта

minMetricsTime: Date

Возвращаемое значение

Promise<Metric[]>

getOrgPipelineReleaseSettings()

Возвращает параметры выпуска конвейера организации

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Возвращаемое значение

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

Возвращает параметры выпуска конвейера.

function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>

Параметры

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<ProjectPipelineReleaseSettings>

getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)

Получение выпуска

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

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

approvalFilters: ApprovalFilters

Фильтр, позволяющий выборочно получить шаги утверждения в зависимости от того, является ли он автоматизированным или ручным. Это также позволит решить, следует ли выбирать моментальные снимки предварительного и последующего утверждения. Предполагается, что все по умолчанию

propertyFilters: string[]

Список извлекаемых расширенных свойств с разделителями-запятыми. Если этот параметр задан, возвращаемый release будет содержать значения для указанных идентификаторов свойств (если они существуют). Если значение не задано, свойства не будут включены.

expand: SingleReleaseExpands

Свойство, которое должно быть развернуто в выпуске.

topGateRecords: number

Количество записей шлюза выпуска, которые требуется получить. Значение по умолчанию — 5.

Возвращаемое значение

Promise<Release>

getReleaseChanges(string, number, number, number, string)

function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Возвращаемое значение

Promise<Change[]>

getReleaseDefinition(string, number, string[])

Получение определения выпуска.

function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseDefinition>

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Идентификатор определения выпуска.

propertyFilters: string[]

Список извлекаемых расширенных свойств с разделителями-запятыми. Если этот параметр задан, возвращенное определение выпуска будет содержать значения для указанных идентификаторов свойств (если они существуют). Если значение не задано, свойства не будут включены.

Возвращаемое значение

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

Получение журнала редакций для определения выпуска

function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Идентификатор определения.

Возвращаемое значение

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

Получение определения выпуска данной редакции.

function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Идентификатор определения выпуска.

revision: number

Номер редакции определения выпуска.

Возвращаемое значение

Promise<string>

getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)

Получение списка определений выпусков.

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

Параметры

project: string

Идентификатор или имя проекта

searchText: string

Получение определений выпуска с именами, содержащими searchText.

expand: ReleaseDefinitionExpands

Свойства, которые следует развернуть в списке определений выпусков.

artifactType: string

Будут возвращены определения выпуска с заданным artifactType. Возможные значения: Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

artifactSourceId: string

Будут возвращены определения выпуска с заданным artifactSourceId. Например, для сборки это будет {projectGuid}:{BuildDefinitionId}, для Jenkins — {JenkinsConnectionId}:{JenkinsDefinitionId}, для TfsOnPrem — {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Для сторонних артефактов, например TeamCity, BitBucket, вы можете ссылаться на uniqueSourceIdentifier внутри vss-extension.json по адресу https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

top: number

Количество определений выпусков, которые требуется получить.

continuationToken: string

Возвращает определения выпуска после предоставленного маркера продолжения.

queryOrder: ReleaseDefinitionQueryOrder

Возвращает результаты в определенном порядке. Значение по умолчанию — "IdAscending".

path: string

Возвращает определения выпуска по указанному пути.

isExactNameMatch: boolean

"true", чтобы получить определения выпуска с точным соответствием, как указано в searchText. Значение по умолчанию — false.

tagFilter: string[]

Список тегов с разделителями-запятыми. Будут возвращены только определения выпуска с этими тегами.

propertyFilters: string[]

Список извлекаемых расширенных свойств с разделителями-запятыми. Если этот параметр задан, возвращаемые определения выпуска будут содержать значения для указанных идентификаторов свойств (если они существуют). Если значение не задано, свойства не будут включены. Обратите внимание, что это не будет отфильтровывать определение выпуска из результатов независимо от того, задано ли свойство или нет.

definitionIdFilter: string[]

Список определений выпусков, которые необходимо получить с разделителями-запятыми.

isDeleted: boolean

Значение true для получения удаленных определений выпусков. Значение по умолчанию — false.

searchTextContainsFolderName: boolean

"true", чтобы получить определения выпуска в папке с именем, указанным в searchText. Значение по умолчанию — false.

Возвращаемое значение

Promise<PagedList<ReleaseDefinition>>

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

Получение сводки по выпуску заданного идентификатора определения.

function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Идентификатор определения для получения сводки о выпуске.

releaseCount: number

Количество выпусков, которые будут включены в сводку.

includeArtifact: boolean

Включите сведения об артефакте. Значение по умолчанию — false.

definitionEnvironmentIdsFilter: number[]

Возвращаемое значение

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

Получение среды выпуска.

function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

expand: ReleaseEnvironmentExpands

Свойство, которое должно быть развернуто в среде.

Возвращаемое значение

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Возвращаемое значение

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>

Параметры

artifactType: string

artifactSourceId: string

Возвращаемое значение

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

Получение выпуска для заданного номера редакции.

function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

definitionSnapshotRevision: number

Определение snapshot номер редакции.

Возвращаемое значение

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)

Получение списка выпусков

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

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Выпуски из этого идентификатора определения выпуска.

definitionEnvironmentId: number

searchText: string

Выпуски с именами, содержащими searchText.

createdBy: string

Выпуски, созданные этим пользователем.

statusFilter: ReleaseStatus

Выпуски с таким состоянием.

environmentStatusFilter: number

minCreatedTime: Date

Выпуски, созданные после этого времени.

maxCreatedTime: Date

Выпуски, созданные до этого времени.

queryOrder: ReleaseQueryOrder

Возвращает результаты в определенном порядке даты создания для выпусков. Значение по умолчанию — по убыванию.

top: number

Количество выпусков для получения. Значение по умолчанию — 50.

continuationToken: number

Возвращает выпуски после предоставленного маркера продолжения.

expand: ReleaseExpands

Свойство, которое должно быть развернуто в списке выпусков.

artifactTypeId: string

Будут возвращены выпуски с заданным artifactTypeId. Возможные значения: Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

sourceId: string

Уникальный идентификатор используемого артефакта. Например, для сборки это будет {projectGuid}:{BuildDefinitionId}, для Jenkins — {JenkinsConnectionId}:{JenkinsDefinitionId}, для TfsOnPrem — {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Для сторонних артефактов, например TeamCity, BitBucket, можно ссылаться на uniqueSourceIdentifier внутри vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.

artifactVersionId: string

Будут возвращены выпуски с заданным artifactVersionId. Например, в случае build artifactType это buildId.

sourceBranchFilter: string

Будут возвращены выпуски с заданным sourceBranchFilter.

isDeleted: boolean

Возвращает обратимо удаленные выпуски, если задано значение true.

tagFilter: string[]

Список тегов с разделителями-запятыми. Будут возвращены только выпуски с этими тегами.

propertyFilters: string[]

Список извлекаемых расширенных свойств с разделителями-запятыми. Если этот параметр задан, возвращаемые выпуски будут содержать значения для указанных идентификаторов свойств (если они существуют). Если значение не задано, свойства не будут включены. Обратите внимание, что это не будет отфильтровывать все выпуски из результатов независимо от того, задано ли свойство или нет.

releaseIdFilter: number[]

Разделенный запятыми список идентификаторов выпусков. Будут возвращены только выпуски с этими идентификаторами.

path: string

Выпуски по этому пути к папке будут возвращены

Возвращаемое значение

Promise<PagedList<Release>>

getReleaseSettings(string)

Возвращает параметры выпуска.

function getReleaseSettings(project: string): Promise<ReleaseSettings>

Параметры

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<ReleaseSettings>

getReleaseTags(string, number)

Возвращает теги для выпуска.

function getReleaseTags(project: string, releaseId: number): Promise<string[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Возвращаемое значение

Promise<string[]>

getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)

Получение вложения задачи выпуска.

function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

attemptId: number

Число попыток развертывания.

planId: string

Идентификатор плана этапа развертывания.

timelineId: string

Идентификатор временной шкалы задачи.

recordId: string

Идентификатор записи вложения.

type: string

Тип вложения.

name: string

Имя вложения.

Возвращаемое значение

Promise<ArrayBuffer>

getReleaseTaskAttachments(string, number, number, number, string, string)

Получение вложений задачи выпуска.

function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

attemptId: number

Число попыток развертывания.

planId: string

Идентификатор плана этапа развертывания.

type: string

Тип вложения.

Возвращаемое значение

Promise<ReleaseTaskAttachment[]>

getReleaseWorkItemsRefs(string, number, number, number, string)

function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Возвращаемое значение

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

Параметры

project: string

Идентификатор или имя проекта

definitionId: number

Возвращаемое значение

Promise<string[]>

getSummaryMailSections(string, number)

function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Возвращаемое значение

Promise<SummaryMailSection[]>

getTags(string)

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

Параметры

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<string[]>

getTaskAttachmentContent(string, number, number, number, string, string, string, string)

Получение вложения задачи.

function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

attemptId: number

Число попыток развертывания.

timelineId: string

Идентификатор временной шкалы задачи.

recordId: string

Идентификатор записи вложения.

type: string

Тип вложения.

name: string

Имя вложения.

Возвращаемое значение

Promise<ArrayBuffer>

getTaskAttachments(string, number, number, number, string, string)

Получение вложений задачи.

function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

attemptId: number

Число попыток развертывания.

timelineId: string

Идентификатор временной шкалы задачи.

type: string

Тип вложения.

Возвращаемое значение

Promise<ReleaseTaskAttachment[]>

getTaskLog(string, number, number, number, number, number, number)

Возвращает журнал задач выпуска в виде обычного текстового файла.

function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

releaseDeployPhaseId: number

Идентификатор этапа развертывания выпуска.

taskId: number

ReleaseTask Id для журнала.

startLine: number

Номер начальной строки для журналов

endLine: number

Номер конечной строки для журналов

Возвращаемое значение

Promise<string>

getTaskLog2(string, number, number, number, string, number, number, number)

Возвращает журнал задач выпуска в виде обычного текстового файла.

function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

attemptId: number

timelineId: string

taskId: number

ReleaseTask Id для журнала.

startLine: number

Номер начальной строки для журналов

endLine: number

Номер конечной строки для журналов

Возвращаемое значение

Promise<string>

getTasks(string, number, number, number)

function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

environmentId: number

attemptId: number

Возвращаемое значение

Promise<ReleaseTask[]>

getTasks2(string, number, number, number, string)

function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Возвращаемое значение

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Возвращаемое значение

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

Возвращает список шаблонов среды определения.

function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>

Параметры

project: string

Идентификатор проекта или имя проекта

isDeleted: boolean

"true", чтобы получить удаленные шаблоны среды определения. Значение по умолчанию — false.

Возвращаемое значение

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>

Параметры

mailMessage: MailMessage

project: string

Идентификатор проекта или имя проекта

releaseId: number

Возвращаемое значение

Promise<void>

undeleteRelease(string, number, string)

Отмена обратимо удаленного выпуска.

function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска для отмены.

comment: string

Любой комментарий для удаления.

Возвращаемое значение

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

Отмена удаления определения выпуска.

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

Параметры

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

Объект для определения выпуска отмены удаления.

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения выпуска для отмены

Возвращаемое значение

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

Отмена удаления шаблона среды определения выпуска.

function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>

Параметры

project: string

Идентификатор проекта или имя проекта

templateId: string

Идентификатор шаблона среды определения для отмены

Возвращаемое значение

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

Обновления существующую папку по указанному пути.

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

Параметры

folder: Folder

project: string

Идентификатор проекта или имя проекта

path: string

Путь к обновляемой папке.

Возвращаемое значение

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

Обновления шлюз для развертывания.

function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>

Параметры

gateUpdateMetadata: GateUpdateMetadata

Метаданные для исправления шлюзов выпуска.

project: string

Идентификатор проекта или имя проекта

gateStepId: number

Идентификатор шага шлюза.

Возвращаемое значение

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

Обновление ручного вмешательства.

function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>

Параметры

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

Метаданные для обновления ручного вмешательства.

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска.

manualInterventionId: number

Идентификатор ручного вмешательства.

Возвращаемое значение

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

Параметры выпуска конвейера Обновления организации

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

Параметры

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Возвращаемое значение

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

параметры выпуска конвейера Обновления

function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>

Параметры

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

Обновите полный объект выпуска.

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

Параметры

release: Release

Освободить объект для обновления.

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска для обновления.

Возвращаемое значение

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

Обновление состояния утверждения

function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>

Параметры

approval: ReleaseApproval

ReleaseApproval object с состоянием, утверждающего и комментариями.

project: string

Идентификатор проекта или имя проекта

approvalId: number

Идентификатор утверждения.

Возвращаемое значение

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

Параметры

approvals: ReleaseApproval[]

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string)

Обновление определения выпуска.

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

Параметры

releaseDefinition: ReleaseDefinition

Объект определения выпуска для обновления.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

Обновление состояния среды выпуска

function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>

Параметры

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

Метаданные обновления среды.

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска.

environmentId: number

Идентификатор среды выпуска.

Возвращаемое значение

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

Обновление нескольких свойств выпуска.

function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>

Параметры

releaseUpdateMetadata: ReleaseUpdateMetadata

Свойства выпуска для обновления.

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска для обновления.

Возвращаемое значение

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

Обновления параметров выпуска

function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>

Параметры

releaseSettings: ReleaseSettings

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ReleaseSettings>

Поделиться через

ReleaseRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

ReleaseRestClient(IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

addDefinitionTag(string, number, string)

Параметры

Возвращаемое значение

addDefinitionTags(string[], string, number)

Параметры

Возвращаемое значение

addReleaseTag(string, number, string)

Параметры

Возвращаемое значение

addReleaseTags(string[], string, number)

Параметры

Возвращаемое значение

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

createFolder(Folder, string, string)

Параметры

Возвращаемое значение

createRelease(ReleaseStartMetadata, string)

Параметры

Возвращаемое значение

createReleaseDefinition(ReleaseDefinition, string)

Параметры

Возвращаемое значение

deleteDefinitionEnvironmentTemplate(string, string)

Параметры

Возвращаемое значение

deleteDefinitionTag(string, number, string)

Параметры

Возвращаемое значение

deleteFavorites(string, string, string, string)

Параметры

Возвращаемое значение

deleteFolder(string, string)

Параметры

Возвращаемое значение

deleteRelease(string, number, string)

Параметры

Возвращаемое значение

deleteReleaseDefinition(string, number, string, boolean)

Параметры

Возвращаемое значение

deleteReleaseTag(string, number, string)

Параметры

Возвращаемое значение

getAgentArtifactDefinitions(string, number)

Параметры

Возвращаемое значение

getApproval(string, number, boolean)

Параметры

Возвращаемое значение

getApprovalHistory(string, number)

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

getArtifactTypeDefinitions(string)

Параметры

Возвращаемое значение

getArtifactVersions(string, number)

Параметры

Возвращаемое значение

getArtifactVersionsForSources(Artifact[], string)

Параметры