BuildRestClient class

リファレンス

パッケージ:: azure-devops-extension-api

VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス

Extends: RestClientBase

コンストラクター

BuildRestClient(IVssRestClientOptions)

プロパティ

RESOURCE_AREA_ID

メソッド

addBuildTag(string, number, string)	ビルドにタグを追加します。
addBuildTags(string[], string, number)	ビルドにタグを追加します。
addDefinitionTag(string, number, string)	定義にタグを追加します
addDefinitionTags(string[], string, number)	1 つの定義に複数のタグを追加します。
addRetentionLeases(NewRetentionLease[], string)	パイプライン実行の新しいリースを追加します。
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	成果物をビルドに関連付けます。
createDefinition(BuildDefinition, string, number, number)	新しい定義を作成します。
createFolder(Folder, string, string)	新しいフォルダーを作成します。
deleteBuild(string, number)	ビルドを削除します。
deleteBuildTag(string, number, string)	ビルドからタグを削除します。注: この API は、特殊文字を含むタグでは機能しません。特殊文字を含むタグを削除するには、代わりに PATCH メソッドを使用します (6.0 以降)
deleteDefinition(string, number)	定義と、関連付けられているすべてのビルドを削除します。
deleteDefinitionTag(string, number, string)	定義からタグを削除します。注: この API は、特殊文字を含むタグでは機能しません。特殊文字を含むタグを削除するには、代わりに PATCH メソッドを使用します (6.0 以降)
deleteFolder(string, string)	定義フォルダーを削除します。定義とそれに対応するビルドも削除されます。
deleteRetentionLeasesById(string, number[])	特定の保持リースを削除します。
deleteTag(string, string)	ビルド、定義、タグストアからタグを削除します
deleteTemplate(string, string)	ビルド定義テンプレートを削除します。
getArtifact(string, number, string)	ビルドの特定の成果物を取得します。
getArtifactContentZip(string, number, string)	ビルドの特定の成果物を取得します。
getArtifacts(string, number)	ビルドのすべての成果物を取得します。
getAttachment(string, number, string, string, string, string)	特定の添付ファイルを取得します。
getAttachments(string, number, string)	ビルドに関連付けられている特定の種類の添付ファイルの一覧を取得します。
getBadge(string, number, string)	定義の最新のビルドの状態を示すバッジを取得します。この API は非推奨であることに注意してください。 StatusBadgeController.GetStatusBadge を優先します。
getBuild(string, number, string)	ビルドを取得します
getBuildBadge(string, string, string, string)	指定したブランチの最新のビルドの状態を示すバッジを取得します。
getBuildBadgeData(string, string, string, string)	指定したブランチの最新のビルドの状態を示すバッジを取得します。
getBuildChanges(string, number, string, number, boolean)	ビルドに関連付けられている変更を取得します
getBuildController(number)	コントローラーを取得します
getBuildControllers(string)	コントローラー (必要に応じて名前でフィルター処理) を取得します
getBuildGeneralSettings(string)	パイプラインの全般設定を取得します。
getBuildLog(string, number, number, number, number)	ビルドの個々のログファイルを取得します。
getBuildLogLines(string, number, number, number, number)	ビルドの個々のログファイルを取得します。
getBuildLogs(string, number)	ビルドのログを取得します。
getBuildLogsZip(string, number)	ビルドのログを取得します。
getBuildLogZip(string, number, number, number, number)	ビルドの個々のログファイルを取得します。
getBuildOptionDefinitions(string)	システムでサポートされているすべてのビルド定義オプションを取得します。
getBuildProperties(string, number, string[])	ビルドのプロパティを取得します。
getBuildReport(string, number, string)	ビルドレポートを取得します。
getBuildReportHtmlContent(string, number, string)	ビルドレポートを取得します。
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	ビルドの一覧を取得します。
getBuildSettings(string)	ビルド設定を取得します。
getBuildTags(string, number)	ビルドのタグを取得します。
getBuildTimeline(string, number, string, number, string)	ビルドの詳細を取得します
getBuildWorkItemsRefs(string, number, number)	ビルドに関連付けられている作業項目を取得します。同じプロジェクト内の作業項目のみが返されます。
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	特定のコミットにフィルター処理されたビルドに関連付けられている作業項目を取得します。
getChangesBetweenBuilds(string, number, number, number)	指定された 2 つのビルド間でリポジトリに加えられた変更を取得します。
getDefinition(string, number, number, Date, string[], boolean)	必要に応じて、特定のリビジョンで定義を取得します。
getDefinitionMetrics(string, number, Date)	定義のビルドメトリックを取得します。
getDefinitionProperties(string, number, string[])	定義のプロパティを取得します。
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	定義のすべてのリビジョンを取得します。
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	定義の一覧を取得します。
getDefinitionTags(string, number, number)	定義のタグを取得します。
getDefinitionYaml(string, number, number, Date, string[], boolean)	定義を YAML に変換します(必要に応じて、特定のリビジョンで)。
getFile(string, number, string, string, string)	ビルドからファイルを取得します。
getFileContents(string, string, string, string, string, string)	指定されたソースコードリポジトリ内のファイルの内容を取得します。
getFolders(string, string, FolderQueryOrder)	ビルド定義フォルダーの一覧を取得します。
getLatestBuild(string, string, string)	定義の最新のビルドを取得します。必要に応じて、特定のブランチにスコープを設定します。
getPathContents(string, string, string, string, string, string)	指定されたソースコードリポジトリ内のディレクトリの内容を取得します。
getProjectMetrics(string, string, Date)	プロジェクトのビルドメトリックを取得します。
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	ソースプロバイダーから pull request オブジェクトを取得します。
getResourceUsage()	システム内のビルドリソースに関する情報を取得します。
getRetentionHistory(number)	プロジェクトコレクションの保持履歴を返します。これには、保持ジョブのクリーンアップを妨げる可能性があるカスタム保持ルールを持つパイプライン、保持の種類を持つパイプラインごとに実行される、保持の種類を持つコレクションが所有するパイプラインに関連付けられているファイル、パイプラインごとのファイルの数が含まれます。
getRetentionLease(string, number)	リース ID を指定して、保持リースの詳細を返します。
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	指定した MinimalRetentionLeases に一致するすべてのリースを返します
getRetentionLeasesByOwnerId(string, string, number, number)	指定したエンティティが所有するリースを返します。必要に応じて、1 つのパイプライン定義にスコープを設定して実行します。
getRetentionLeasesByUserId(string, string, number, number)	指定したユーザーが所有するリースを返します。必要に応じて、1 つのパイプライン定義にスコープを設定して実行します。
getRetentionLeasesForBuild(string, number)	特定のビルドに適用されるすべての保持リースを取得します。
getRetentionSettings(string)	プロジェクトの保持設定を取得します。
getStatusBadge(string, string, string, string, string, string, string)	<p>定義のビルド状態を取得します。必要に応じて、特定のブランチ、ステージ、ジョブ、および構成をスコープとします。</p p><>複数ある場合は、jobName を指定するときに stageName 値を渡す必要があり、構成パラメーターを渡す場合は両方に同じ規則が適用されます。</P>
getTags(string)	プロジェクト内のすべてのビルドタグの一覧を取得します。
getTemplate(string, string)	特定のビルド定義テンプレートを取得します。
getTemplates(string)	すべての定義テンプレートを取得します。
getWorkItemsBetweenBuilds(string, number, number, number)	2 つのビルド間のすべての作業項目を取得します。
listBranches(string, string, string, string, string)	指定されたソースコードリポジトリのブランチの一覧を取得します。
listRepositories(string, string, string, string, ResultSet, boolean, string)	ソースコードリポジトリの一覧を取得します。
listSourceProviders(string)	ソースプロバイダーとその機能の一覧を取得します。
listWebhooks(string, string, string, string)	指定されたソースコードリポジトリにインストールされている Webhook の一覧を取得します。
queueBuild(Build, string, boolean, string, number, number)	ビルドをキューに入れます
restoreDefinition(string, number, boolean)	削除された定義を復元します
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	指定したソースコードリポジトリ内の指定したトリガーの Webhook を再作成します。
saveTemplate(BuildDefinitionTemplate, string, string)	既存のビルド定義テンプレートを更新します。
updateBuild(Build, string, number, boolean)	ビルドを更新します。
updateBuildGeneralSettings(PipelineGeneralSettings, string)	パイプラインの全般設定を更新します。
updateBuildProperties(JsonPatchDocument, string, number)	ビルドのプロパティを更新します。
updateBuilds(Build[], string)	複数のビルドを更新します。
updateBuildSettings(BuildSettings, string)	ビルド設定を更新します。
updateBuildTags(UpdateTagParameters, string, number)	ビルドからタグを追加または削除します。
updateDefinition(BuildDefinition, string, number, number, number)	既存のビルド定義を更新します。この操作を成功させるには、要求本文の "Revision" プロパティの値が既存のビルド定義と一致している必要があります。 GET を使用して既存のビルド定義を取得し、必要に応じてビルド定義を変更してから、PUT を使用して変更された定義を送信することをお勧めします。
updateDefinitionProperties(JsonPatchDocument, string, number)	定義のプロパティを更新します。
updateDefinitionTags(UpdateTagParameters, string, number)	定義からタグを追加または削除します。
updateFolder(Folder, string, string)	指定された既存のパスにある既存のフォルダーを更新する
updateRetentionLease(RetentionLeaseUpdate, string, number)	保持リースの期間またはパイプライン保護の状態を更新します。
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	プロジェクトの保持設定を更新します。
updateStage(UpdateStageParameters, number, string, string)	ビルドステージを更新する

コンストラクターの詳細

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

パラメーター

options: IVssRestClientOptions

プロパティの詳細

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

プロパティ値

string

メソッドの詳細

addBuildTag(string, number, string)

ビルドにタグを追加します。

function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

tag: string

追加するタグ。

戻り値

Promise<string[]>

addBuildTags(string[], string, number)

ビルドにタグを追加します。

function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>

パラメーター

tags: string[]

追加するタグ。要求本文は、一覧表示されているタグから直接構成されます。

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<string[]>

addDefinitionTag(string, number, string)

定義にタグを追加します

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

tag: string

追加するタグ。

戻り値

Promise<string[]>

addDefinitionTags(string[], string, number)

1 つの定義に複数のタグを追加します。

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

パラメーター

tags: string[]

追加するタグ。

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

戻り値

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

パイプライン実行の新しいリースを追加します。

function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>

パラメーター

newLeases: NewRetentionLease[]

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>

パラメーター

resources: DefinitionResourceReference[]

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

戻り値

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>

パラメーター

resources: DefinitionResourceReference[]

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

成果物をビルドに関連付けます。

function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>

パラメーター

artifact: BuildArtifact

成果物。

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

新しい定義を作成します。

function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>

パラメーター

definition: BuildDefinition

定義。

project: string

プロジェクト ID またはプロジェクト名

definitionToCloneId: number

definitionToCloneRevision: number

戻り値

Promise<BuildDefinition>

createFolder(Folder, string, string)

新しいフォルダーを作成します。

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

パラメーター

folder: Folder

フォルダー。

project: string

プロジェクト ID またはプロジェクト名

path: string

フォルダーの完全パス。

戻り値

Promise<Folder>

deleteBuild(string, number)

ビルドを削除します。

function deleteBuild(project: string, buildId: number): Promise<void>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<void>

deleteBuildTag(string, number, string)

ビルドからタグを削除します。注: この API は、特殊文字を含むタグでは機能しません。特殊文字を含むタグを削除するには、代わりに PATCH メソッドを使用します (6.0 以降)

function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

tag: string

削除するタグ。

戻り値

Promise<string[]>

deleteDefinition(string, number)

定義と、関連付けられているすべてのビルドを削除します。

function deleteDefinition(project: string, definitionId: number): Promise<void>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

戻り値

Promise<void>

deleteDefinitionTag(string, number, string)

定義からタグを削除します。注: この API は、特殊文字を含むタグでは機能しません。特殊文字を含むタグを削除するには、代わりに PATCH メソッドを使用します (6.0 以降)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

tag: string

削除するタグ。

戻り値

Promise<string[]>

deleteFolder(string, string)

定義フォルダーを削除します。定義とそれに対応するビルドも削除されます。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

path: string

フォルダーへの完全なパス。

戻り値

Promise<void>

deleteRetentionLeasesById(string, number[])

特定の保持リースを削除します。

function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

ids: number[]

戻り値

Promise<void>

deleteTag(string, string)

ビルド、定義、タグストアからタグを削除します

function deleteTag(project: string, tag: string): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

tag: string

削除するタグ。

戻り値

Promise<string[]>

deleteTemplate(string, string)

ビルド定義テンプレートを削除します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

templateId: string

テンプレートの ID。

戻り値

Promise<void>

getArtifact(string, number, string)

ビルドの特定の成果物を取得します。

function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

artifactName: string

成果物の名前。

戻り値

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

ビルドの特定の成果物を取得します。

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

artifactName: string

成果物の名前。

戻り値

Promise<ArrayBuffer>

getArtifacts(string, number)

ビルドのすべての成果物を取得します。

function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<BuildArtifact[]>

getAttachment(string, number, string, string, string, string)

特定の添付ファイルを取得します。

function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

timelineId: string

タイムラインの ID。

recordId: string

タイムラインレコードの ID。

type: string

添付ファイルの種類。

name: string

添付ファイルの名前。

戻り値

Promise<ArrayBuffer>

getAttachments(string, number, string)

ビルドに関連付けられている特定の種類の添付ファイルの一覧を取得します。

function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

type: string

添付ファイルの種類。

戻り値

Promise<Attachment[]>

getBadge(string, number, string)

定義の最新のビルドの状態を示すバッジを取得します。この API は非推奨であることに注意してください。 StatusBadgeController.GetStatusBadge を優先します。

function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>

パラメーター

project: string

プロジェクト ID または名前。

definitionId: number

定義の ID。

branchName: string

ブランチの名前。

戻り値

Promise<string>

getBuild(string, number, string)

ビルドを取得します

function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

propertyFilters: string

戻り値

Promise<Build>

getBuildBadge(string, string, string, string)

指定したブランチの最新のビルドの状態を示すバッジを取得します。

function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repoType: string

リポジトリの種類。

repoId: string

リポジトリ ID。

branchName: string

分岐名。

戻り値

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

指定したブランチの最新のビルドの状態を示すバッジを取得します。

function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

repoType: string

リポジトリの種類。

repoId: string

リポジトリ ID。

branchName: string

分岐名。

戻り値

Promise<string>

getBuildChanges(string, number, string, number, boolean)

ビルドに関連付けられている変更を取得します

function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

continuationToken: string

top: number

返される変更の最大数

includeSourceChange: boolean

戻り値

Promise<PagedList<Change>>

getBuildController(number)

コントローラーを取得します

function getBuildController(controllerId: number): Promise<BuildController>

パラメーター

controllerId: number

戻り値

Promise<BuildController>

getBuildControllers(string)

コントローラー (必要に応じて名前でフィルター処理) を取得します

function getBuildControllers(name?: string): Promise<BuildController[]>

パラメーター

name: string

戻り値

Promise<BuildController[]>

getBuildGeneralSettings(string)

パイプラインの全般設定を取得します。

function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

ビルドの個々のログファイルを取得します。

function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

logId: number

ログファイルの ID。

startLine: number

開始行です。

endLine: number

最終行。

戻り値

Promise<string>

getBuildLogLines(string, number, number, number, number)

ビルドの個々のログファイルを取得します。

function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

logId: number

ログファイルの ID。

startLine: number

開始行です。

endLine: number

最終行。

戻り値

Promise<string[]>

getBuildLogs(string, number)

ビルドのログを取得します。

function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<BuildLog[]>

getBuildLogsZip(string, number)

ビルドのログを取得します。

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

ビルドの個々のログファイルを取得します。

function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

logId: number

ログファイルの ID。

startLine: number

開始行です。

endLine: number

最終行。

戻り値

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

システムでサポートされているすべてのビルド定義オプションを取得します。

function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

ビルドのプロパティを取得します。

function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

filter: string[]

プロパティのコンマ区切りのリスト。指定した場合は、これらの特定のプロパティにフィルター処理します。

戻り値

Promise<any>

getBuildReport(string, number, string)

ビルドレポートを取得します。

function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

type: string

戻り値

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

ビルドレポートを取得します。

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

type: string

戻り値

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

ビルドの一覧を取得します。

function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitions: number[]

定義 ID のコンマ区切りのリスト。指定した場合、これらの定義のビルドをフィルター処理します。

queues: number[]

キュー ID のコンマ区切りのリスト。指定した場合、これらのキューに対して実行されたビルドをフィルター処理します。

buildNumber: string

指定した場合、このビルド番号に一致するビルドをフィルター処理します。プレフィックス検索を行うには、 * を追加します。

minTime: Date

指定した場合、指定された queryOrder に基づいて、この日付より後に完了/開始/キューに登録されたビルドにフィルター処理します。

maxTime: Date

指定した場合は、指定された queryOrder に基づいて、この日付より前に完了/開始/キューに登録されたビルドにフィルターが適用されます。

requestedFor: string

指定した場合は、指定したユーザーに対して要求されたビルドにフィルター処理します。

reasonFilter: BuildReason

指定した場合、この理由に一致するビルドをフィルター処理します。

statusFilter: BuildStatus

指定した場合、この状態に一致するビルドをフィルター処理します。

resultFilter: BuildResult

指定した場合、この結果に一致するビルドをフィルター処理します。

tagFilters: string[]

タグのコンマ区切りのリスト。指定した場合、指定したタグを持つビルドにフィルター処理します。

properties: string[]

取得するプロパティのコンマ区切りのリスト。

top: number

返されるビルドの最大数。

continuationToken: string

このメソッドの以前の呼び出しによって返される継続トークン。これは、次のビルドセットを返すために使用できます。

maxBuildsPerDefinition: number

定義ごとに返されるビルドの最大数。

deletedFilter: QueryDeletedOption

削除されたビルドを除外するか、含めるか、またはのみ返すかを示します。

queryOrder: BuildQueryOrder

ビルドを返す順序。

branchName: string

指定した場合は、このブランチを構築したブランチをビルドするようにフィルター処理します。

buildIds: number[]

取得するビルドの ID を指定するコンマ区切りのリスト。

repositoryId: string

指定した場合、このリポジトリからビルドされたビルドにフィルターが適用されます。

repositoryType: string

指定した場合、この型のリポジトリからビルドされたビルドにフィルターが適用されます。

戻り値

Promise<PagedList<Build>>

getBuildSettings(string)

ビルド設定を取得します。

function getBuildSettings(project?: string): Promise<BuildSettings>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<BuildSettings>

getBuildTags(string, number)

ビルドのタグを取得します。

function getBuildTags(project: string, buildId: number): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

ビルドの詳細を取得します

function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

timelineId: string

changeId: number

planId: string

戻り値

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

ビルドに関連付けられている作業項目を取得します。同じプロジェクト内の作業項目のみが返されます。

function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

top: number

返される作業項目の最大数。

戻り値

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

特定のコミットにフィルター処理されたビルドに関連付けられている作業項目を取得します。

function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>

パラメーター

commitIds: string[]

コミット ID のコンマ区切りのリスト。

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

top: number

返される作業項目の最大数、またはコミット ID が指定されていない場合に考慮するコミットの数。

戻り値

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

指定された 2 つのビルド間でリポジトリに加えられた変更を取得します。

function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

fromBuildId: number

最初のビルドの ID。

toBuildId: number

最後のビルドの ID。

top: number

返される変更の最大数。

戻り値

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

必要に応じて、特定のリビジョンで定義を取得します。

function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

revision: number

取得するリビジョン番号。これが指定されていない場合は、最新バージョンが返されます。

minMetricsTime: Date

指定した場合は、メトリックを含める日付を示します。

propertyFilters: string[]

結果に含めるプロパティのコンマ区切りのリスト。

includeLatestBuilds: boolean

戻り値

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

定義のビルドメトリックを取得します。

function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

minMetricsTime: Date

メトリックの計算元となる日付。

戻り値

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

定義のプロパティを取得します。

function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

filter: string[]

プロパティのコンマ区切りのリスト。指定した場合は、これらの特定のプロパティにフィルター処理します。

戻り値

Promise<any>

getDefinitionResources(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

戻り値

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

定義のすべてのリビジョンを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

戻り値

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

定義の一覧を取得します。

function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

name: string

指定した場合、名前がこのパターンと一致する定義にフィルター処理されます。

repositoryId: string

リポジトリ ID。指定した場合、このリポジトリを使用する定義にフィルター処理します。

repositoryType: string

指定した場合、この型のリポジトリを持つ定義にフィルター処理します。

queryOrder: DefinitionQueryOrder

定義を返す順序を示します。

top: number

返される定義の最大数。

continuationToken: string

このメソッドの以前の呼び出しによって返される継続トークン。これは、次の定義セットを返すために使用できます。

minMetricsTime: Date

指定した場合は、メトリックを含める日付を示します。

definitionIds: number[]

取得する定義の ID を指定するコンマ区切りのリスト。

path: string

指定した場合、このフォルダーの下の定義にフィルター処理されます。

builtAfter: Date

指定した場合、この日付より後のビルドを持つ定義にフィルター処理します。

notBuiltAfter: Date

指定した場合、この日付以降にビルドがない定義にフィルター処理されます。

includeAllProperties: boolean

完全な定義を返す必要があるかどうかを示します。既定では、定義のシャロー表現が返されます。

includeLatestBuilds: boolean

この定義に対して、完了した最新のビルドを返すかどうかを示します。

taskIdFilter: string

指定した場合、指定したタスクを使用する定義にフィルター処理します。

processType: number

指定した場合は、指定されたプロセスの種類を持つ定義にフィルター処理します。

yamlFilename: string

指定した場合は、指定されたファイル名と一致する YAML 定義にフィルター処理されます。このフィルター includeAllProperties を使用するには、true に設定する必要があります

戻り値

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

定義のタグを取得します。

function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

revision: number

定義リビジョン番号。指定しない場合は、定義の最新のリビジョンを使用します。

戻り値

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

定義を YAML に変換します(必要に応じて、特定のリビジョンで)。

function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

revision: number

取得するリビジョン番号。これが指定されていない場合は、最新バージョンが返されます。

minMetricsTime: Date

指定した場合は、メトリックを含める日付を示します。

propertyFilters: string[]

結果に含めるプロパティのコンマ区切りのリスト。

includeLatestBuilds: boolean

戻り値

Promise<YamlBuild>

getFile(string, number, string, string, string)

ビルドからファイルを取得します。

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

artifactName: string

成果物の名前。

fileId: string

ファイルの主キー。

fileName: string

ファイルが設定される名前。

戻り値

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

指定されたソースコードリポジトリ内のファイルの内容を取得します。

function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

serviceEndpointId: string

指定した場合、クエリを実行するサービスエンドポイントの ID。 TFVC や TFGit など、サービスエンドポイントを使用しないプロバイダーの場合にのみ省略できます。

repository: string

指定した場合、ブランチを取得するベンダー固有の識別子またはリポジトリの名前。複数のリポジトリをサポートしていないプロバイダーの場合にのみ省略できます。

commitOrBranch: string

ファイルの内容の取得元のコミットまたはブランチの識別子。

path: string

リポジトリのルートを基準とした、取得するファイルへのパス。

戻り値

Promise<string>

getFolders(string, string, FolderQueryOrder)

ビルド定義フォルダーの一覧を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

path: string

開始するパス。

queryOrder: FolderQueryOrder

フォルダーを返す順序。

戻り値

Promise<Folder[]>

getLatestBuild(string, string, string)

定義の最新のビルドを取得します。必要に応じて、特定のブランチにスコープを設定します。

function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definition: string

省略可能な先頭のフォルダーパスを持つ定義名、または定義 ID

branchName: string

使用する特定のブランチを示す省略可能なパラメーター。指定しない場合は、既定のブランチが使用されます。

戻り値

Promise<Build>

getPathContents(string, string, string, string, string, string)

指定されたソースコードリポジトリ内のディレクトリの内容を取得します。

function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

serviceEndpointId: string

repository: string

commitOrBranch: string

ファイルの内容の取得元のコミットまたはブランチの識別子。

path: string

リポジトリのルートを基準とした、リストへのパスの内容。

戻り値

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

プロジェクトのビルドメトリックを取得します。

function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

metricAggregationType: string

使用する集計の種類 (時間単位、日単位)。

minMetricsTime: Date

メトリックの計算元となる日付。

戻り値

Promise<BuildMetric[]>

getProjectResources(string, string, string)

function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

type: string

id: string

戻り値

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

ソースプロバイダーから pull request オブジェクトを取得します。

function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

pullRequestId: string

pull request のベンダー固有の ID。

repositoryId: string

ベンダー固有の識別子、または pull request を含むリポジトリの名前。

serviceEndpointId: string

戻り値

Promise<PullRequest>

getResourceUsage()

システム内のビルドリソースに関する情報を取得します。

function getResourceUsage(): Promise<BuildResourceUsage>

戻り値

Promise<BuildResourceUsage>

getRetentionHistory(number)

プロジェクトコレクションの保持履歴を返します。これには、保持ジョブのクリーンアップを妨げる可能性があるカスタム保持ルールを持つパイプライン、保持の種類を持つパイプラインごとに実行される、保持の種類を持つコレクションが所有するパイプラインに関連付けられているファイル、パイプラインごとのファイルの数が含まれます。

function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

パラメーター

daysToLookback: number

戻り値

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

リース ID を指定して、保持リースの詳細を返します。

function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

leaseId: number

戻り値

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

指定した MinimalRetentionLeases に一致するすべてのリースを返します

function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

leasesToFetch: MinimalRetentionLease[]

JSON でシリアル化された MinimalRetentionLeases の一覧を '|' で区切る

戻り値

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

指定したエンティティが所有するリースを返します。必要に応じて、1 つのパイプライン定義にスコープを設定して実行します。

function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

ownerId: string

definitionId: number

検索を特定のパイプライン定義に制限する省略可能なパラメーター。

runId: number

検索を 1 つのパイプライン実行に制限する省略可能なパラメーター。 definitionId が必要です。

戻り値

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

指定したユーザーが所有するリースを返します。必要に応じて、1 つのパイプライン定義にスコープを設定して実行します。

function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

userOwnerId: string

検索するユーザー ID。

definitionId: number

検索を特定のパイプライン定義に制限する省略可能なパラメーター。

runId: number

検索を 1 つのパイプライン実行に制限する省略可能なパラメーター。 definitionId が必要です。

戻り値

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

特定のビルドに適用されるすべての保持リースを取得します。

function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<RetentionLease[]>

getRetentionSettings(string)

プロジェクトの保持設定を取得します。

function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p>定義のビルド状態を取得します。必要に応じて、特定のブランチ、ステージ、ジョブ、および構成をスコープとします。</p p><>複数ある場合は、jobName を指定するときに stageName 値を渡す必要があり、構成パラメーターを渡す場合は両方に同じ規則が適用されます。</P>

function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definition: string

省略可能な先頭のフォルダーパスを持つ定義名、または定義 ID。

branchName: string

このブランチの最新のビルドのみを検討してください。指定しない場合は、既定のブランチが使用されます。

stageName: string

パイプライン内でこのステージを使用して、状態をレンダリングします。

jobName: string

パイプラインのステージ内でこのジョブを使用して、状態をレンダリングします。

configuration: string

このジョブ構成を使用して状態をレンダリングする

label: string

バッジの左側にある既定のテキストを置き換えます。

戻り値

Promise<string>

getTags(string)

プロジェクト内のすべてのビルドタグの一覧を取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<string[]>

getTemplate(string, string)

特定のビルド定義テンプレートを取得します。

function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

templateId: string

要求されたテンプレートの ID。

戻り値

Promise<BuildDefinitionTemplate>

getTemplates(string)

すべての定義テンプレートを取得します。

function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

2 つのビルド間のすべての作業項目を取得します。

function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

fromBuildId: number

最初のビルドの ID。

toBuildId: number

最後のビルドの ID。

top: number

返される作業項目の最大数。

戻り値

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

指定されたソースコードリポジトリのブランチの一覧を取得します。

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

serviceEndpointId: string

repository: string

ブランチを取得するベンダー固有の識別子またはリポジトリの名前。複数のリポジトリをサポートしていないプロバイダーの場合にのみ省略できます。

branchName: string

指定した場合は、具体的にチェックするブランチの名前。

戻り値

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

ソースコードリポジトリの一覧を取得します。

function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

serviceEndpointId: string

repository: string

指定した場合は、取得するベンダー固有の識別子または単一のリポジトリの名前。

resultSet: ResultSet

エンドポイントに最も関連するリポジトリの 'top'。設定されていない場合は、すべてのリポジトリが返されます。 'repository' が設定されている場合は無視されます。

pageResults: boolean

true に設定すると、結果のセットが制限され、クエリを続行するための継続トークンが返されます。

continuationToken: string

ページングの結果、これは、このメソッドの以前の呼び出しによって返される継続トークンであり、次のリポジトリセットを返すために使用できます。

戻り値

Promise<SourceRepositories>

listSourceProviders(string)

ソースプロバイダーとその機能の一覧を取得します。

function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

指定されたソースコードリポジトリにインストールされている Webhook の一覧を取得します。

function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

serviceEndpointId: string

repository: string

指定した場合、Webhook を取得するベンダー固有の識別子またはリポジトリの名前。複数のリポジトリをサポートしていないプロバイダーの場合にのみ省略できます。

戻り値

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

ビルドをキューに入れます

function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>

パラメーター

build: Build

project: string

プロジェクト ID またはプロジェクト名

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

本文なしでビルドをキューに登録するための省略可能な定義 ID。有効な本文がある場合は無視されます

戻り値

Promise<Build>

restoreDefinition(string, number, boolean)

削除された定義を復元します

function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>

パラメーター

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

復元する定義の識別子。

deleted: boolean

false の場合、削除された定義が復元されます。

戻り値

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

指定したソースコードリポジトリ内の指定したトリガーの Webhook を再作成します。

function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>

パラメーター

triggerTypes: DefinitionTriggerType[]

Webhook を復元するトリガーの種類。

project: string

プロジェクト ID またはプロジェクト名

providerName: string

ソースプロバイダーの名前。

serviceEndpointId: string

repository: string

戻り値

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

既存のビルド定義テンプレートを更新します。

function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>

パラメーター

template: BuildDefinitionTemplate

テンプレートの新しいバージョン。

project: string

プロジェクト ID またはプロジェクト名

templateId: string

テンプレートの ID。

戻り値

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

ビルドを更新します。

function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>

パラメーター

build: Build

ビルド。

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

retry: boolean

戻り値

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

パイプラインの全般設定を更新します。

function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>

パラメーター

newSettings: PipelineGeneralSettings

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

ビルドのプロパティを更新します。

function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>

パラメーター

document: JsonPatchDocument

更新するプロパティを説明する json パッチドキュメント。

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<any>

updateBuilds(Build[], string)

複数のビルドを更新します。

function updateBuilds(builds: Build[], project: string): Promise<Build[]>

パラメーター

builds: Build[]

更新するビルド。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

ビルド設定を更新します。

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

パラメーター

settings: BuildSettings

新しい設定。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

ビルドからタグを追加または削除します。

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

パラメーター

updateParameters: UpdateTagParameters

追加/削除するタグ。

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルドの ID。

戻り値

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number)

既存のビルド定義を更新します。この操作を成功させるには、要求本文の "Revision" プロパティの値が既存のビルド定義と一致している必要があります。 GET を使用して既存のビルド定義を取得し、必要に応じてビルド定義を変更してから、PUT を使用して変更された定義を送信することをお勧めします。

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>

パラメーター

definition: BuildDefinition

定義の新しいバージョン。その "Revision" プロパティは、更新プログラムを受け入れるための既存の定義と一致する必要があります。

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

戻り値

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

定義のプロパティを更新します。

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

パラメーター

document: JsonPatchDocument

更新するプロパティを説明する json パッチドキュメント。

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

戻り値

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

定義からタグを追加または削除します。

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

パラメーター

updateParameters: UpdateTagParameters

追加/削除するタグ。

project: string

プロジェクト ID またはプロジェクト名

definitionId: number

定義の ID。

戻り値

Promise<string[]>

updateFolder(Folder, string, string)

指定された既存のパスにある既存のフォルダーを更新する

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

パラメーター

folder: Folder

フォルダーの新しいバージョン。

project: string

プロジェクト ID またはプロジェクト名

path: string

フォルダーへの完全なパス。

戻り値

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

保持リースの期間またはパイプライン保護の状態を更新します。

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

パラメーター

leaseUpdate: RetentionLeaseUpdate

保持リースの新しいデータ。

project: string

プロジェクト ID またはプロジェクト名

leaseId: number

更新するリースの ID。

戻り値

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

プロジェクトの保持設定を更新します。

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

パラメーター

updateModel: UpdateProjectRetentionSettingModel

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

ビルドステージを更新する

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

パラメーター

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

次の方法で共有

BuildRestClient class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

BuildRestClient(IVssRestClientOptions)

パラメーター

プロパティの詳細

RESOURCE_AREA_ID

プロパティ値

メソッドの詳細

addBuildTag(string, number, string)

パラメーター

戻り値

addBuildTags(string[], string, number)

パラメーター

戻り値

addDefinitionTag(string, number, string)

パラメーター

戻り値

addDefinitionTags(string[], string, number)

パラメーター

戻り値

addRetentionLeases(NewRetentionLease[], string)

パラメーター

戻り値

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

パラメーター

戻り値

authorizeProjectResources(DefinitionResourceReference[], string)

パラメーター

戻り値

createArtifact(BuildArtifact, string, number)

パラメーター

戻り値

createDefinition(BuildDefinition, string, number, number)

パラメーター

戻り値

createFolder(Folder, string, string)

パラメーター

戻り値

deleteBuild(string, number)

パラメーター

戻り値

deleteBuildTag(string, number, string)

パラメーター

戻り値

deleteDefinition(string, number)

パラメーター

戻り値

deleteDefinitionTag(string, number, string)

パラメーター

戻り値

deleteFolder(string, string)

パラメーター

戻り値

deleteRetentionLeasesById(string, number[])

パラメーター

戻り値

deleteTag(string, string)

パラメーター

戻り値

deleteTemplate(string, string)

パラメーター

戻り値

getArtifact(string, number, string)

パラメーター

戻り値

getArtifactContentZip(string, number, string)

パラメーター

戻り値

getArtifacts(string, number)

パラメーター

戻り値

getAttachment(string, number, string, string, string, string)

パラメーター

戻り値

getAttachments(string, number, string)

パラメーター