BuildRestClient class

new BuildRestClient(options: IVssRestClientOptions)

パラメーター

static RESOURCE_AREA_ID: "965220d5-5bb9-42cf-8d67-9b146df2a5a4" = "965220d5-5bb9-42cf-8d67-9b146df2a5a4"

プロパティ値

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

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

パラメーター

返品

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

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

パラメーター

返品

定義にタグを追加します

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

パラメーター

返品

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

パラメーター

返品

アーティファクトとビルドを関連付けます。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

ビルドを削除します。

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

パラメーター

返品

ビルドからタグを除去します。 注意:このAPIは特殊文字のタグには対応しません。 特殊文字のタグを削除するには、代わりにPATCHメソッド(6.0+)を使います。

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

パラメーター

返品

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

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

パラメーター

返品

定義からタグを削除します。 注意:このAPIは特殊文字のタグには対応しません。 特殊文字のタグを削除するには、代わりにPATCHメソッド(6.0+)を使います。

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

パラメーター

返品

定義フォルダを削除します。 定義および対応するビルドも削除されます。

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

パラメーター

返品

特定のリテンションリースを除外します。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

ビルド用の特定のアーティファクトを手に入れます。

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

パラメーター

返品

ビルド用の特定のアーティファクトを手に入れます。

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

パラメーター

返品

ビルドのための全アーティファクトを手に入れます。

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

パラメーター

返品

特定の愛着を持つ。

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

パラメーター

返品

ビルドに関連付けられた特定のタイプのアタッチメントのリストを取得できます。

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

パラメーター

返品

定義のために最新のビルドの状態を示すバッジをもらいます。 このAPIは非推奨であることにご注意ください。 Prefer StatusBadgeController.GetStatusBadge.

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

パラメーター

返品

ビルドを取得します。

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

パラメーター

返品

指定された部門の最新ビルドのステータスを示すバッジを手に入れます。

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

パラメーター

返品

指定された部門の最新ビルドのステータスを示すバッジを手に入れます。

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

パラメーター

返品

ビルドに関連する変更点を取得できます

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

パラメーター

返品

コントローラーを手に入れた

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

パラメーター

返品

コントローラーを手に入れ、名前でフィルタリングできます

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

パラメーター

返品

パイプラインの一般的な設定を手に入れます。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

建築用のログを入手します。

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

パラメーター

返品

建築用のログを入手します。

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

パラメーター

返品

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

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

パラメーター

返品

システムがサポートするすべてのビルド定義オプションが使えます。

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

パラメーター

返品

建築のための物件を手に入れます。

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

パラメーター

返品

ビルドレポートを受け取ります。

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

パラメーター

返品

ビルドレポートを受け取ります。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

特定のステージにフィルター処理されたビルドの最新のタイムラインを取得します。

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

パラメーター

返品

特定のステージにフィルター処理されたビルドのタイムラインを取得します。

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

パラメーター

返品

ビルド用のタグを手に入れます。

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

パラメーター

返品

ビルドの詳細を取得する

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

パラメーター

返品

建築に関連する作業項目を取得します。 同じプロジェクト内の作業項目のみが返却されます。

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

パラメーター

返品

ビルドに関連付けられた作業項目を特定のコミットにフィルターで取り込みます。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

定義のための性質を得る。

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

パラメーター

返品

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

パラメーター

返品

定義のすべての改訂を受け取ります。

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

パラメーター

返品

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

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

パラメーター

返品

定義のためのタグを入手します。

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

パラメーター

返品

定義をYAMLに変換し、特定のリビジョンで任意で変換します。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

ビルド定義フォルダのリストを取得します。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

パラメーター

返品

ソースプロバイダーからプルリクエストオブジェクトを受け取ります。

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

パラメーター

返品

システム内の建築資源に関する情報を得られます。

function getResourceUsage(): Promise<BuildResourceUsage>

返品

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

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

パラメーター

返品

リテンションリースの詳細を返却し、リースIDを付けます。

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

パラメーター

返品

指定されたMinimalRetentionLeasesに一致するリースを返却します

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

パラメーター

返品

指定されたエンティティが所有するリースを返却し、オプションで単一のパイプライン定義にスコープをかけて実行します。

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

パラメーター

返品

指定されたユーザーが所有するリースを返し、オプションで単一のパイプライン定義にスコープをかけて実行します。

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

パラメーター

返品

特定の建築に適用されるすべてのリテンションリースを取得します。

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

パラメーター

返品

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

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

パラメーター

返品

<p>定義のビルドステータスを取得し、特定のブランチ、ステージ、ジョブ、構成にスコープを割り当てることができます</p><p>複数ある場合は、jobNameを指定する際にStageNameの値を渡す必要があり、設定パラメータを渡す際には同じルールが両方に適用されます</p>

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

2つのビルド間の作業アイテムをすべて取得できます。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

ソースプロバイダーとその対応能力のリストを取得しましょう。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

指定されたトリガーのウェブフックをソースコードリポジトリに再作成します。

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

パラメーター

返品

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

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

パラメーター

返品

ビルドを更新します。

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

既存のフォルダを特定のパスで更新します

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品