Releases
Retrieves a list of releases.
Table Specific Information
Select
The driver uses the Azure DevOps API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,in' operators.
- CreatedOn supports the '>,>=,<,<=' operators.
- ProjectId supports the '=' operator.
- ReleaseDefinitionId supports the '=' operator.
- Status supports the '=' operator.
- Tags supports the '=,in' operators.
- Properties supports the '=,in' operators.
- IsDeleted supports the '=' operator.
- SourceBranch supports the '=' operator.
- ArtifactVersionId supports the '=' operator.
- ArtifactTypeId supports the '=' operator.
- EnvironmentStatus supports the '=' operator.
- DefinitionEnvironmentId supports the '=' operator.
- SearchText supports the '=' operator.
- SourceId supports the '=' operator.
- Path supports the '=' operator.
- TopGateRecoards supports the '=' operator.
- Expand supports the '=' operator.
The rest of the filter is executed client-side in the driver.
For example:
SELECT * FROM Releases WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073'
SELECT * FROM Releases WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073' AND Id = 1
SELECT * FROM Releases WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073' AND CreatedOn >= '2000-01-01'
SELECT * FROM Releases WHERE ProjectId = '66eb7414-f622-4eff-88da-3ad681f19073' AND Expand = 'Variables'
Insert
The following
is an example of inserting
into Releases table. For example:
INSERT INTO ReleaseArtifacts#TEMP (Alias, BuildVersionId, BuildVersionName) VALUES ('cdata1', 1, 'cdata')
INSERT INTO ReleaseArtifacts#TEMP (Alias, BuildVersionId, BuildVersionName) VALUES ('cdata2', 2, 'cdata33')
INSERT INTO Releases (ProjectId, Reason, Description, ReleaseArtifacts) VALUES ('b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937', 'creating release object', 'HelloCdata1', releaseArtifacts#TEMP)
Update
The following
is an example of updating
a Releases table:
UPDATE Releases SET Name = 'cdata2' WHERE ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937' AND Id = '1'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id of the release. | |
| Links | String | True |
Aggregate of the reference links. | |
| Comment | String | True |
Release comment. | |
| CreatedByDisplayName | String | True |
The display name of the user who created this release. | |
| CreatedById | String | True |
The Id of the user who created this release. | |
| CreatedByUrl | String | True |
The URL of the user who created this release. | |
| CreatedOn | Datetime | True |
The date on which it was created. | |
| DefinitionSnapshotRevision | Integer | True |
Revision number of definition snapshot. | |
| Description | String | False |
Description of release. | |
| KeepForever | Boolean | True |
Whether to exclude the release from retention policies. | |
| LogsContainerUrl | String | True |
Logs container url. | |
| ModifiedByDisplayName | String | True |
The display name of the user who modified this release. | |
| ModifiedById | String | True |
The id of the user who modified this release. | |
| ModifiedByUrl | String | True |
The URL of the user who modified this release. | |
| ModifiedOn | Datetime | True |
The date on which it got modified. | |
| Name | String | True |
Release name. | |
| PoolName | String | True |
Pool name. | |
| ProjectId | String | True |
Id of the project. | |
| ProjectName | String | True |
Name of the project. | |
| Properties | String | False |
Release properties. | |
| Reason | String | False |
Reason of release. | |
| ReleaseDefinitionId | Integer | True |
Id of the release definition. | |
| ReleaseDefinitionName | String | True |
Name of the release definition. | |
| ReleaseDefinitionUrl | String | True |
URL of the release definition. | |
| ReleaseDefinitionRevision | Integer | True |
The release definition revision. | |
| ReleaseNameFormat | String | True |
The release name format. | |
| Status | String | True |
Release status. The allowed values are abandoned, active, draft, undefined. | |
| Tags | String | True |
List of tags. | |
| TriggeringArtifactAlias | String | True |
Triggering artifact alias. | |
| Url | String | True |
The URL of the release. | |
| Variables | String | False |
The dictionary of variables. |
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 |
| IsDeleted | Boolean |
Gets the soft deleted releases, if true. |
| SourceBranch | String |
Releases with given sourceBranchFilter will be returned. |
| ArtifactVersionId | String |
Releases with given artifactVersionId will be returned. |
| ArtifactTypeId | String |
Releases with given artifactTypeId will be returned. |
| EnvironmentStatus | Integer |
Environment status filter. |
| DefinitionEnvironmentId | Integer |
Id of the definition environment. |
| SearchText | String |
Releases with names containing searchText. |
| SourceId | String |
Unique identifier of the artifact used. |
| Path | String |
Releases under this folder path will be returned. |
| TopGateRecords | Integer |
Number of release gate records to get. |
| Expand | String |
The property that should be expanded in the list of releases. The allowed values are none, tags, variables. |
| ReleaseArtifacts | String |
The property that should be expanded in the list of releases. |