GitBranches
Retrieves a collection of git branch.
Table Specific Information
Select
The cmdlet uses the Azure DevOps API to process WHERE clause conditions built with the following columns and operators:
- ProjectId supports the '=' operator.
- RepositoryId supports the '=' operator.
- IncludeLinks supports the '=' operator.
- MyBranches supports the '=' operator.
- IncludeStatuses supports the '=' operator.
- LatestStatusesOnly supports the '=' operator.
NOTE: RepositoryId is required in order to query GitBranches.
For example:
SELECT * FROM GitBranches WHERE RepositoryId = '02b4a62d-2f5f-4d69-8420-29257dcc8051' SELECT * FROM GitBranches WHERE RepositoryId = '02b4a62d-2f5f-4d69-8420-29257dcc8051' AND IncludeLinks = true
Update
The following is an example of updating a GitBranches table:
UPDATE GitBranches SET isLocked = true WHERE name = 'abc' AND ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937' AND RepositoryId = 'e50698d4-bb6e-400f-a1a0-5f4d17517d9e'
Columns
Name | Type | ReadOnly | References | Description |
ObjectId [KEY] | String | True |
Path for the branch. | |
ProjectId | String | False |
Id of the project this branch belongs to. | |
RepositoryId | String | False |
Id of the repositories. | |
Name | String | False |
Name of the branch. | |
CreatorDisplayName | String | True |
The non-unique display name of the user who created this branch. | |
CreatorUrl | String | True |
The URL of the user who created this branch. | |
CreatorLinksAvatarHref | String | True |
Avatar reference link of the creator. | |
CreatorId | String | True |
Id of the creator. | |
CreatorDescriptor | String | True |
Descriptor of the creator. | |
Links | String | True |
Aggregate of the reference links. | |
Statuses | String | True |
Contains the metadata of a service/extension posting a status. | |
Url | String | True |
Full HTTP resource link of the branch. | |
isLocked | Boolean | False |
Represents a boolean value if the branch is locked or not. |
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 |
IncludeLinks | Boolean |
Specifies if referenceLinks should be included in the result. |
IncludeStatuses | Boolean |
Includes up to the first 1000 commit statuses for each ref. |
MyBranches | Boolean |
Includes only branches that the user owns, the branches the user favorites, and the default branch. |
LatestStatusesOnly | Boolean |
rue to include only the tip commit status for each ref. |