azure-devops-extension-api 1.158.0 → 2.220.0

package/Build/BuildClient.d.ts

@@ -112,6 +112,13 @@ export declare class BuildRestClient extends RestClientBase {
      * @param branchName - The branch name.
      */
     getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>;
+    /**
+     * Gets all retention leases that apply to a specific build.
+     *
+     * @param project - Project ID or project name
+     * @param buildId - The ID of the build.
+     */
+    getRetentionLeasesForBuild(project: string, buildId: number): Promise<Build.RetentionLease[]>;
     /**
      * Deletes a build.
      *
@@ -152,7 +159,7 @@ export declare class BuildRestClient extends RestClientBase {
      * @param repositoryId - If specified, filters to builds that built from this repository.
      * @param repositoryType - If specified, filters to builds that built from repositories of this type.
      */
-    getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: Build.BuildReason, statusFilter?: Build.BuildStatus, resultFilter?: Build.BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: Build.QueryDeletedOption, queryOrder?: Build.BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<Build.Build[]>;
+    getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: Build.BuildReason, statusFilter?: Build.BuildStatus, resultFilter?: Build.BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: Build.QueryDeletedOption, queryOrder?: Build.BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<WebApi.PagedList<Build.Build>>;
     /**
      * Queues a build
      *
@@ -161,8 +168,9 @@ export declare class BuildRestClient extends RestClientBase {
      * @param ignoreWarnings -
      * @param checkInTicket -
      * @param sourceBuildId -
+     * @param definitionId - Optional definition id to queue a build without a body. Ignored if there's a valid body
      */
-    queueBuild(build: Build.Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number): Promise<Build.Build>;
+    queueBuild(build: Build.Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build.Build>;
     /**
      * Updates a build.
      *
@@ -188,7 +196,7 @@ export declare class BuildRestClient extends RestClientBase {
      * @param top - The maximum number of changes to return
      * @param includeSourceChange -
      */
-    getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<Build.Change[]>;
+    getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<WebApi.PagedList<Build.Change>>;
     /**
      * Gets the changes made to the repository between two given builds.
      *
@@ -256,9 +264,9 @@ export declare class BuildRestClient extends RestClientBase {
      * @param includeLatestBuilds - Indicates whether to return the latest and latest completed builds for this definition.
      * @param taskIdFilter - If specified, filters to definitions that use the specified task.
      * @param processType - If specified, filters to definitions with the given process type.
-     * @param yamlFilename - If specified, filters to YAML definitions that match the given filename.
+     * @param yamlFilename - If specified, filters to YAML definitions that match the given filename. To use this filter includeAllProperties should be set to true
      */
-    getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: Build.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<Build.BuildDefinitionReference[]>;
+    getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: Build.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<WebApi.PagedList<Build.BuildDefinitionReference>>;
     /**
      * Restores a deleted definition
      *
@@ -268,9 +276,9 @@ export declare class BuildRestClient extends RestClientBase {
      */
     restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<Build.BuildDefinition>;
     /**
-     * Updates an existing definition.
+     * Updates an existing build definition.  In order for this operation to succeed, the value of the "Revision" property of the request body must match the existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify the build definition as necessary, and then submit the modified definition with PUT.
      *
-     * @param definition - The new version of the defintion.
+     * @param definition - The new version of the definition. Its "Revision" property must match the existing definition for the update to be accepted.
      * @param project - Project ID or project name
      * @param definitionId - The ID of the definition.
      * @param secretsSourceDefinitionId -
@@ -319,14 +327,87 @@ export declare class BuildRestClient extends RestClientBase {
      * @param path - The full path to the folder.
      */
     updateFolder(folder: Build.Folder, project: string, path: string): Promise<Build.Folder>;
+    /**
+     * Gets pipeline general settings.
+     *
+     * @param project - Project ID or project name
+     */
+    getBuildGeneralSettings(project: string): Promise<Build.PipelineGeneralSettings>;
+    /**
+     * Updates pipeline general settings.
+     *
+     * @param newSettings -
+     * @param project - Project ID or project name
+     */
+    updateBuildGeneralSettings(newSettings: Build.PipelineGeneralSettings, project: string): Promise<Build.PipelineGeneralSettings>;
+    /**
+     * Returns the retention history for the project collection. This includes pipelines that have custom retention rules that may prevent the retention job from cleaning them up, runs per pipeline with retention type, files associated with pipelines owned by the collection with retention type, and the number of files per pipeline.
+     *
+     * @param daysToLookback -
+     */
+    getRetentionHistory(daysToLookback?: number): Promise<Build.BuildRetentionHistory>;
     /**
      * Gets the latest build for a definition, optionally scoped to a specific branch.
      *
      * @param project - Project ID or project name
      * @param definition - definition name with optional leading folder path, or the definition id
-     * @param branchName - optional parameter that indicates the specific branch to use
+     * @param branchName - optional parameter that indicates the specific branch to use. If not specified, the default branch is used.
      */
     getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build.Build>;
+    /**
+     * Adds new leases for pipeline runs.
+     *
+     * @param newLeases -
+     * @param project - Project ID or project name
+     */
+    addRetentionLeases(newLeases: Build.NewRetentionLease[], project: string): Promise<Build.RetentionLease[]>;
+    /**
+     * Removes specific retention leases.
+     *
+     * @param project - Project ID or project name
+     * @param ids -
+     */
+    deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>;
+    /**
+     * Returns the details of the retention lease given a lease id.
+     *
+     * @param project - Project ID or project name
+     * @param leaseId -
+     */
+    getRetentionLease(project: string, leaseId: number): Promise<Build.RetentionLease>;
+    /**
+     * Returns any leases matching the specified MinimalRetentionLeases
+     *
+     * @param project - Project ID or project name
+     * @param leasesToFetch - List of JSON-serialized MinimalRetentionLeases separated by '|'
+     */
+    getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: Build.MinimalRetentionLease[]): Promise<Build.RetentionLease[]>;
+    /**
+     * Returns any leases owned by the specified entity, optionally scoped to a single pipeline definition and run.
+     *
+     * @param project - Project ID or project name
+     * @param ownerId -
+     * @param definitionId - An optional parameter to limit the search to a specific pipeline definition.
+     * @param runId - An optional parameter to limit the search to a single pipeline run. Requires definitionId.
+     */
+    getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<Build.RetentionLease[]>;
+    /**
+     * Returns any leases owned by the specified user, optionally scoped to a single pipeline definition and run.
+     *
+     * @param project - Project ID or project name
+     * @param userOwnerId - The user id to search for.
+     * @param definitionId - An optional parameter to limit the search to a specific pipeline definition.
+     * @param runId - An optional parameter to limit the search to a single pipeline run. Requires definitionId.
+     */
+    getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<Build.RetentionLease[]>;
+    /**
+     * Updates the duration or pipeline protection status of a retention lease.
+     *
+     * @param leaseUpdate - The new data for the retention lease.
+     * @param project - Project ID or project name
+     * @param leaseId - The ID of the lease to update.
+     */
+    updateRetentionLease(leaseUpdate: Build.RetentionLeaseUpdate, project: string, leaseId: number): Promise<Build.RetentionLease>;
     /**
      * Gets an individual log file for a build.
      *
@@ -543,7 +624,7 @@ export declare class BuildRestClient extends RestClientBase {
      *
      * @param project - Project ID or project name
      * @param definition - Either the definition name with optional leading folder path, or the definition id.
-     * @param branchName - Only consider the most recent build for this branch.
+     * @param branchName - Only consider the most recent build for this branch. If not specified, the default branch is used.
      * @param stageName - Use this stage within the pipeline to render the status.
      * @param jobName - Use this job within a stage of the pipeline to render the status.
      * @param configuration - Use this job configuration to render the status
@@ -561,13 +642,13 @@ export declare class BuildRestClient extends RestClientBase {
     /**
      * Adds tags to a build.
      *
-     * @param tags - The tags to add.
+     * @param tags - The tags to add. Request body is composed directly from listed tags.
      * @param project - Project ID or project name
      * @param buildId - The ID of the build.
      */
     addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>;
     /**
-     * Removes a tag from a build.
+     * Removes a tag from a build. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+)
      *
      * @param project - Project ID or project name
      * @param buildId - The ID of the build.
@@ -581,6 +662,14 @@ export declare class BuildRestClient extends RestClientBase {
      * @param buildId - The ID of the build.
      */
     getBuildTags(project: string, buildId: number): Promise<string[]>;
+    /**
+     * Adds/Removes tags from a build.
+     *
+     * @param updateParameters - The tags to add/remove.
+     * @param project - Project ID or project name
+     * @param buildId - The ID of the build.
+     */
+    updateBuildTags(updateParameters: Build.UpdateTagParameters, project: string, buildId: number): Promise<string[]>;
     /**
      * Adds a tag to a definition
      *
@@ -598,7 +687,7 @@ export declare class BuildRestClient extends RestClientBase {
      */
     addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>;
     /**
-     * Removes a tag from a definition.
+     * Removes a tag from a definition. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+)
      *
      * @param project - Project ID or project name
      * @param definitionId - The ID of the definition.
@@ -613,6 +702,14 @@ export declare class BuildRestClient extends RestClientBase {
      * @param revision - The definition revision number. If not specified, uses the latest revision of the definition.
      */
     getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>;
+    /**
+     * Adds/Removes tags from a definition.
+     *
+     * @param updateParameters - The tags to add/remove.
+     * @param project - Project ID or project name
+     * @param definitionId - The ID of the definition.
+     */
+    updateDefinitionTags(updateParameters: Build.UpdateTagParameters, project: string, definitionId: number): Promise<string[]>;
     /**
      * Removes a tag from builds, definitions, and from the tag store
      *
@@ -684,7 +781,7 @@ export declare class BuildRestClient extends RestClientBase {
      */
     listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<Build.RepositoryWebhook[]>;
     /**
-     * Gets the work items associated with a build.
+     * Gets the work items associated with a build. Only work items in the same project are returned.
      *
      * @param project - Project ID or project name
      * @param buildId - The ID of the build.
@@ -709,4 +806,15 @@ export declare class BuildRestClient extends RestClientBase {
      * @param top - The maximum number of work items to return.
      */
     getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<WebApi.ResourceRef[]>;
+    /**
+     * Converts a definition to YAML, optionally at a specific revision.
+     *
+     * @param project - Project ID or project name
+     * @param definitionId - The ID of the definition.
+     * @param revision - The revision number to retrieve. If this is not specified, the latest version will be returned.
+     * @param minMetricsTime - If specified, indicates the date from which metrics should be included.
+     * @param propertyFilters - A comma-delimited list of properties to include in the results.
+     * @param includeLatestBuilds -
+     */
+    getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<Build.YamlBuild>;
 }