BuildRestClient class

new BuildRestClient(options: IVssRestClientOptions)

パラメーター

static RESOURCE_AREA_ID: string

プロパティ値

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

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

パラメーター

戻り値

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

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 は非推奨であることに注意してください。 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 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[]>

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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>

パラメーター

戻り値

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

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

パラメーター

戻り値