Cmdlets for Azure DevOps

Build 24.0.9060

Builds

Retrieves a list of builds.

Table Specific Information

Select

The cmdlet uses the Azure DevOps API to process WHERE clause conditions built with the following columns and operators:

  • Id supports the '=,in' operators.
  • ProjectId supports the '=' operator.
  • BuildNumber supports the '=' operator.
  • DefinitionId supports the '=,in' operators.
  • FinishTime supports the '>,>=,<,<=' operators.
  • QueueTime supports the '>,>=,<,<=' operators.
  • Reason supports the '=' operator.
  • RepositoryId supports the '=' operator.
  • RepositoryType supports the '=' operator.
  • Result supports the '=' operator.
  • SourceBranch supports the '=' operator.
  • StartTime supports the '<,<=,>,>=' operators.
  • Status supports the '=' operator.
  • Tags supports the '=,in' operators.
  • DeletedFilter supports the '=' operator.
  • Properties supports the '=,in' operators.
  • QueueId supports the '=' operator.
  • RequestedForId supports the '=' operator.
  • MaxBuildsPerDefinition supports the '=' operator.
The rest of the filter is executed client-side in the cmdlet.

For example: 

	SELECT * FROM Builds WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073'
	SELECT * FROM Builds WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073' AND BuildNumber = '20200401.1'
	SELECT * FROM Builds WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073' ORDER BY StartTime ASC
	SELECT * FROM Builds WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073' AND Id IN (2, 3, 4)
	SELECT * FROM Builds WHERE ProjectId = '837ccd31-8159-4db3-b8ce-de0c36d2a0bf' AND FinishTime > '2020-04-06 05:50:00' AND FinishTime < '2020-04-06 06:50:00'

Update

The following is an example of updating a Builds table: 

UPDATE Builds SET Reason = 'cdata2' WHERE ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937' AND Id = '1'

Delete

The following is an example of deleting data in a Builds table: 

DELETE FROM Builds WHERE ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937' AND Id = '1'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

Id of the Build.

AgentSpecificationIdentifier String False

The agent specification for the build.

BuildNumber String False

The build number/name of the build.

BuildNumberRevision Integer False

The build number revision.

ControllerCreatedDate Datetime False

The date the controller was created. This is only set if definition type is XAML.

ControllerDescription String False

The description of the controller. This is only set if definition type is XAML.

ControllerEnabled Boolean False

Indicates whether the controller is enabled. This is only set if definition type is XAML.

ControllerId Integer False

Id of the build controller. This is set only if definition type is XAML.

ControllerName String False

Name of the controller. This is set only if definition type is XAML.

ControllerStatus String False

Status of the controller. This is set only if definition type is XAML.

ControllerUpdatedDate Datetime False

The date the controller was last updated. This is only set if definition type is XAML.

ControllerUri String False

The controller URI. This is only set if definition type is XAML.

ControllerUrl String False

Full Http Link to the resource. This is set only if definition type is XAML.

DefinitionId Integer False

BuildDefinitions.Id

The Id of the definition associated with the build.

Deleted Boolean False

Indicates whether the build has been deleted.

DeletedByDisplayName String False

This is the non-unique display name of the user.

DeletedById String False

The Id of the user.

DeletedDate Datetime False

The date the build was deleted.

DeletedReason String False

The description of how the build was deleted.

FinishTime Datetime False

The time that the build was completed.

KeepForever Boolean True

Indicates whether the build should be skipped by retention policies.

LastChangedByDisplayName String False

This is the non-unique display name of the user.

LastChangedById String False

The Id of the user.

LastChangedDate Datetime False

The date the build was last changed.

Links String True

Aggregate of the reference links.

LogsId Integer False

The Id of the log.

LogsType String False

The type of the log location.

LogsUrl String False

A full link to the log resource.

OrchestrationPlanId String False

The ID of the plan.

OrchestrationPlanType Integer False

The type of the plan.

Parameters String False

The parameters for the build.

Priority String False

The build's priority.

ProjectId String True

Project identifier. Can be either the id or name.

Properties String False

The class represents a property bag as a collection of key-value pairs.

Quality String False

The quality of the XAML build (good, bad, etc.).

QueueId Integer False

The Id of the queue.

QueueName String False

The name of the queue.

QueuePoolId Integer False

The pool Id.

QueuePoolIsHosted Boolean False

A value indicating whether or not this pool is managed by the service.

QueuePoolName String False

The pool name.

QueueOptions String False

Additional options for queueing the build.

QueuePosition Integer False

The current position of the build in the queue.

QueueTime Datetime False

The time that the build was queued.

Reason String False

The reason that the build was create.

The allowed values are all, batchedCI, buildCompletion, checkInShelveset, individualCI, manual, none, pullRequest, schedule, scheduleForced, triggered, userCreated, validateShelveset.

RepositoryId String False

Repositories.Id

The Id of the repository.

RepositoryType String False

Type of the repository.

RequestedByDisplayName String False

This is the non-unique display name of the user.

RequestedById String False

The Id of the user.

RequestedForDisplayName String False

This is the non-unique display name of the user.

RequestedForId String False

The Id of the user.

Result String False

The build result.

The allowed values are canceled, failed, none, partiallySucceeded, succeeded.

RetainedByRelease Boolean False

Indicates whether the build is retained by a release.

SourceBranch String False

The source branch.

SourceVersion String False

The source version.

SourceSha String False

The SHA checksum of the action which triggered the build.

StartTime Datetime False

The time that the build was started.

Status String False

The status of the build.

The allowed values are all, cancelling, completed, inProgress, none, notStarted, postponed.

Tags String False

The tags associated with this build.

TriggerMessage String False

Commit message of the action which triggered the build.

TriggerRepository String False

Repository Id of the commit which triggered the build.

TriggeredByBuildId Integer False

The build that triggered this build via a Build completion trigger.

Uri String False

The URI of the build.

Url String False

The REST URL of the build.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements, and offer a more granular control over the tuples that are returned from the data source. Unless otherwise specified, only the = operator is permitted when filtering on pseudocolumns.

Name Type Description
DeletedFilter String

Indicates whether to exclude, include, or only return deleted builds.

The allowed values are excludeDeleted, includeDeleted, onlyDeleted.

MaxBuildsPerDefinition Integer

The maximum number of builds to return per definition.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060