ReleaseRestClient class
應該使用 (衍生自) 的基類，向 VSS REST API 提出要求
- Extends
建構函式
| Release |
屬性
| RESOURCE_AREA_ID |
方法
建構函式詳細資料
ReleaseRestClient(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
- 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
取得已建立核准的已定義順序的結果。 默認值為 『descending』。
- 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
列出具有指定部署狀態的部署。 預設值為 『All』。
- operationStatus
- DeploymentOperationStatus
列出具有指定作業狀態的部署。 預設值為 『All』。
- latestAttemptsOnly
-
boolean
'true' 僅包含部署與最新嘗試。 默認值為 『false』。
- queryOrder
- ReleaseQueryOrder
列出具有指定查詢順序的部署。 預設值為 『Descending』。
- 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 識別符。
傳回
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 識別符。
- 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 (外部) 、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild。
- artifactSourceId
-
string
將會傳回具有指定 artifactSourceId 的版本定義。 例如，針對組建，它會是 {projectGuid}：{BuildDefinitionId}，針對 Jenkins，它會是 {JenkinsConnectionId}：{JenkinsDefinitionId}，若為 TfsOnPrem，則為 {TfsOnPremConnectionId}：{ProjectName}：{TfsOnPremDefinitionId}。 針對第三方成品，例如 TeamCity、BitBucket，您可能會在 vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions內參考 'uniqueSourceIdentifier'。
- 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
定義快照集修訂編號。
傳回
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 (外部) 、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild。
- sourceId
-
string
使用之成品的唯一標識符。 例如，針對組建，它會是 {projectGuid}：{BuildDefinitionId}，針對 Jenkins，它會是 {JenkinsConnectionId}：{JenkinsDefinitionId}，若為 TfsOnPrem，則為 {TfsOnPremConnectionId}：{ProjectName}：{TfsOnPremDefinitionId}。 針對第三方成品，例如 TeamCity、BitBucket，您可以在 vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions內參考 'uniqueSourceIdentifier'。
- artifactVersionId
-
string
將會傳回具有指定 artifactVersionId 的版本。 例如，如果是 Build artifactType，它是 buildId。
- sourceBranchFilter
-
string
將會傳回具有指定 sourceBranchFilter 的版本。
- isDeleted
-
boolean
如果為 true，則取得虛刪除的版本。
- tagFilter
-
string[]
以逗號分隔的標籤清單。 只會傳回具有這些標籤的版本。
- propertyFilters
-
string[]
要擷取之擴充屬性的逗號分隔清單。 如果已設定，傳回的 Releases 將會包含指定屬性識別碼的值， (如果它們存在) 。 如果未設定，將不會包含屬性。 請注意，不論其是否已設定屬性，這都不會從結果中篩選出任何 Release。
- releaseIdFilter
-
number[]
發行標識碼的逗號分隔清單。 只會傳回具有這些標識碼的版本。
- path
-
string
此資料夾路徑下的版本將會傳回
傳回
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 識別符。
- 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 識別符。
- 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
要更新的 Release 物件。
- project
-
string
項目識別碼或項目名稱
- releaseId
-
number
要更新的版本識別碼。
傳回
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
更新核准的狀態
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>參數
- approval
- ReleaseApproval
ReleaseApproval 物件具有狀態、核准者和批注。
- project
-
string
項目識別碼或項目名稱
- approvalId
-
number
核准的標識碼。
傳回
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>參數
- approvals
- 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>