# Functions
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
GetActivityID returns the value of the activityIDHeader webhook header.
GetRequestID returns the value of the requestIDHeader webhook header.
GetSubscriptionID returns the value of the subscriptionIDHeader webhook header.
Int is a helper routine that allocates a new int value to store v and returns a pointer to it.
Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.
NewClient returns a new Azure DevOps API client.
ParseWebHook parses the event payload into a corresponding struct.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
ValidatePayload validates an incoming Azure Devops Webhook event request and returns the (JSON) payload.
# Constants
VersionControlChangeType valid enum values.
VersionControlChangeType valid enum values.
GitObjectType enum declaration.
GitObjectType enum declaration.
VersionControlChangeType valid enum values.
CommentThreadStatus enum declaration.
PullRequestMergeFailureType enum values.
CommentThreadStatus enum declaration.
The comment comes as a result of a code change.
The comment represents a system message.
This is a regular user comment.
The comment type is not known.
GitObjectType enum declaration.
DefaultBaseURL is the default URI base for most Azure Devops REST API endpoints.
DefaultVsaexBaseURL is the default URI base for some Azure Devops REST API endpoints.
DefaultVsspsBaseURL is the default URI base for some Azure Devops REST API endpoints.
VersionControlChangeType valid enum values.
DeliveryPlanWorkItemIDKey is the key for which part of the workItems[] slice has the ID.
DeliveryPlanWorkItemIterationKey is the key for which part of the workItems[] slice has the Iteration.
DeliveryPlanWorkItemNameKey is the key for which part of the workItems[] slice has the Name.
DeliveryPlanWorkItemStatusKey is the key for which part of the workItems[] slice has the Status.
DeliveryPlanWorkItemTagKey is the key for which part of the workItems[] slice has the Tag.
DeliveryPlanWorkItemTypeKey is the key for which part of the workItems[] slice has the Type.
VersionControlChangeType valid enum values.
VersionControlChangeType valid enum values.
GitObjectType enum declaration.
FinishTimeAscending orders by finish build time asc.
FinishTimeDescending orders by finish build time desc.
CommentThreadStatus enum declaration.
GitStatusState enum values.
GitStatusState enum values.
GitStatusState enum values.
GitStatusState enum values.
GitStatusState enum values.
GitStatusState enum values.
BoardColumnType Enum values.
BoardColumnType Enum values.
IterationReason enum declaration.
IterationReason enum declaration.
IterationReason enum declaration.
IterationReason enum declaration.
IterationReason enum declaration.
IterationReason enum declaration.
VersionControlChangeType valid enum values.
VersionControlChangeType valid enum values.
PullRequestAsyncStatus enum values.
PullRequestAsyncStatus enum values.
PullRequestAsyncStatus enum values.
PullRequestAsyncStatus enum values.
PullRequestAsyncStatus enum values.
PullRequestAsyncStatus enum values.
PullRequestMergeFailureType enum values.
GitPullRequestMergeStrategy enum values.
VersionControlChangeType valid enum values.
PullRequestMergeFailureType enum values.
GitObjectType enum declaration.
BoardColumnType Enum values.
CommentThreadStatus enum declaration.
PolicyEvaluationApproved represents that the policy has been fulfilled for this pull request.
PolicyEvaluationBroken represents that the policy encountered an unexpected error.
PolicyEvaluationNotApplicable represents that the policy does not apply to this pull request.
PolicyEvaluationQueued represents that the policy is either queued to run, or is waiting for some event before progressing.
PolicyEvaluationRejected represents that the policy has rejected this pull request.
PolicyEvaluationRunning represents that the policy is currently running.
VersionControlChangeType valid enum values.
PullRequestStatus enum values.
PullRequestStatus enum values.
PullRequestStatus enum values.
PullRequestStatus enum values.
PullRequestStatus enum values.
PullRequestCommentedEvent Resource field is parsed as a pull request commented event (note this maps to resourceVersion 2.0 of the payload struct, which is incompatible with 1.0.
PullRequestEvent Resource field is parsed as a pull request event.
PushEvent Git push service event.
QueueTimeAscending orders by build queue time asc.
QueueTimeDescending orders by build queue time desc.
GitPullRequestMergeStrategy enum values.
GitObjectType enum declaration.
VersionControlChangeType valid enum values.
VersionControlChangeType valid enum values.
GitPullRequestMergeStrategy enum values.
VersionControlChangeType valid enum values.
GitPullRequestMergeStrategy enum values.
StartTimeAscending orders by build start time asc.
StartTimeDescending orders by build start time desc.
CommentThreadStatus enum declaration.
CommentThreadStatus enum declaration.
GitObjectType enum declaration.
VersionControlChangeType valid enum values.
GitObjectType enum declaration.
VersionControlChangeType valid enum values.
PullRequestMergeFailureType enum values.
Vote identifiers.
Vote identifiers.
Vote identifiers.
Vote identifiers.
Vote identifiers.
CommentThreadStatus enum declaration.
WorkItemCommentedEvent Resource field is parsed as a work item commented event.
WorkItemUpdatedEvent Resource field is parsed as a work item updated event.
# Structs
AccessLevel is a wrapper class used by Item.
AgentPoolQueue The queue.
Avatar is a wrapper class used by Links.
BasicAuthTransport is an http.RoundTripper that authenticates all requests using HTTP Basic Authentication with the provided username and password.
Board describes a board.
BoardColumn describes a column on the board.
BoardFields describes a column on the board.
BoardReference Base object a board.
BoardRow describes a row on the board.
BoardsService handles communication with the boards methods on the API utilising https://docs.microsoft.com/en-gb/rest/api/vsts/work/boards.
Build Represents a build.
BuildController represents a controller of the build service.
BuildDefinition represents a build definition.
BuildDefinitionsListOptions describes what the request to the API should look like.
BuildDefinitionsListResponse describes the build definitions list response.
BuildDefinitionsService handles communication with the build definitions methods on the API utilising https://docs.microsoft.com/en-gb/rest/api/vsts/build/definitions.
BuildDemand Represents a demand used by a definition or build.
BuildLogReference Information about the build logs.
BuildRepository represents a repository used by a build definition.
BuildsListOptions describes what the request to the API should look like.
BuildsListResponse is the wrapper around the main response for the List of Builds.
BuildsService handles communication with the builds methods on the API utilising https://docs.microsoft.com/en-gb/rest/api/vsts/build/builds.
Client for interacting with the Azure DevOps API.
Comment Represents a comment which is one of potentially many in a comment thread.
CommentPosition describes a comment position.
CommentVersionRef refers to the specific version of a comment.
DeliveryPlan describes an plan.
DeliveryPlansListOptions describes what the request to the API should look like.
DeliveryPlansListResponse describes the delivery plans list response.
DeliveryPlansService handles communication with the deliverytimeline methods on the API utilising https://docs.microsoft.com/en-us/rest/api/vsts/work/deliverytimeline.
DeliveryPlanTimeLine describes the delivery plan get response.
DeliveryTeam describes the teams in a specific plan.
Event - Describes an Azure Devops webhook payload parent Delay parsing Resource using *json.RawMessage until we know EventType.
Favourite describes what a favourite is.
FavouritesResponse describes the favourites response.
FavouritesService handles communication with the favourites methods on the API So far it looks like this is undocumented, so this could change.
FieldReference describes a row on the board.
FileContentMetadata Describes files referenced by a GitItem.
GitChange describes file path and content changes.
GitCommitChanges is a list of GitCommitRefs and count of all changes describes in the response from the API.
GitCommitDiffs describes the difference between two commits.
GitCommitRef describes a single git commit reference.
GitItem describes a single git item.
GitPullRequest represents all the data associated with a pull request.
GitPullRequestChange Change made in a pull request.
GitPullRequestCommentThread Represents a comment thread of a pull request.
GitPullRequestCommentThreadContext Comment thread context contains details about what diffs were being viewed at the time of thread creation and whether or not the thread has been tracked from that original diff.
GitPullRequestCompletionOptions describes preferences about how the pull request should be completed.
GitPullRequestIteration Provides properties that describe a Git pull request iteration.
Collection of changes made in a pull request.
GitPullRequestMergeOptions describes the options which are used when a pull request merge is created.
GitPullRequestStatus This class contains the metadata of a service/extension posting pull request status.
GitPullRequestWithComment contains a reference to an existing pull request and a comment.
GitPush describes a code push request event.
GitPushRef Describes a push request.
GitRef provides information about a git/fork ref.
GitRefListOptions describes what the request to the API should look like.
GitRefsResponse describes the git list refs response.
GitRefsUpdateResponse describes the git list refs update response.
GitRefUpdate Describes a ref update.
GitRepository describes an Azure Devops Git repository.
GitRepositoryRef describes a repository ref.
GitService handles communication with the git methods on the API See: https://docs.microsoft.com/en-us/rest/api/vsts/git/.
GitStatus describes a git status entity.
GitStatusContext Status context that uniquely identifies the status.
GitStatusesResponse describes the git statuses response.
GitTemplate describes a git template.
GitUserDate User info and date for Git operations.
GraphDescriptorResult Returns user descriptor and links related to the request.
GraphGroup is the parent struct describing a Microsoft Graph group for Azure Devops.
GraphMember is a child of the GraphUser struct.
GraphSubject A graph subject entity.
GraphSubjectBase Base struct for other graph entities.
GraphUser is the parent struct describing a Microsoft Graph user for Azure Devops.
GraphUsersListResponse describes what a response from the Users.List() API should look like.
IdentityRef describes an Azure Devops identity.
IdentityRefWithVote Identity information including a vote on a pull request.
Item is a wrapper class used by UserEntitlements.
ItemContent describes an item.
ItemContentType describes an item content type.
Iteration describes an iteration.
IterationsResponse describes the iterations response.
IterationsService handles communication with the work items methods on the API utilising https://docs.microsoft.com/en-gb/rest/api/vsts/work/iterations.
IterationWorkItems Represents work items in an iteration backlog.
Link A single item in a collection of Links.
Links is a wrapper class used by User.
ListBoardsResponse describes the boards response.
Message represents an Azure Devops webhook message property.
PolicyConfiguration is the full policy configuration with settings.
PolicyEvaluationRecord encapsulates the current state of a policy as it applies to one specific pull request.
PolicyEvaluationsListOptions describes what the request to the API should look like.
PolicyEvaluationsListResponse describes a pull requests list response.
PolicyEvaluationsService handles communication with the evaluations methods on the API utilising https://docs.microsoft.com/en-us/rest/api/azure/devops/policy/evaluations.
PolicyTypeRef is the policy type reference.
Project Describes a project.
PullRequestGetOptions describes what the request to the API should look like.
PullRequestIterationsListOptions describes what the request to the API should look like.
PullRequestListOptions describes what the request to the API should look like.
PullRequestsCommitsResponse describes a pull requests commits response.
PullRequestsIterationsListResponse describes a pull requests list response.
PullRequestsListCommitsResponse describes a pull requests list commits response.
PullRequestsListResponse describes a pull requests list response.
PullRequestsService handles communication with the pull requests methods on the API utilising https://docs.microsoft.com/en-us/rest/api/vsts/git/pull%20requests.
QueueBuildOptions describes what the request to the API should look like.
ResourceContainers provides information related to the Resources in a payload.
ResourceRef Describes properties to identify a resource.
TaskAgentPoolReference Represents a reference to an agent pool.
TaskOrchestrationPlanReference The orchestration plan for the build.
Team describes what a team looks like.
TeamProjectCollectionReference Reference object for a TeamProjectCollection.
TeamProjectReference Represents a shallow reference to a TeamProject.
TeamsListOptions describes what the request to the API should look like.
TeamsListResponse Requests that may return multiple entities use this format.
TeamsService handles communication with the teams methods on the API utilising https://docs.microsoft.com/en-us/rest/api/vsts/core/teams/get%20all%20teams.
Test represents a test.
TestListResponse is the wrapper around the main response for the List of Tests.
TestResult represents a test result.
TestResultsListOptions describes what the request to the API should look like.
TestResultsListResponse is the wrapper around the main response for the List of Tests.
TestsListOptions describes what the request to the API should look like.
TestsService handles communication with the Tests methods on the API utilising https://docs.microsoft.com/en-gb/rest/api/vsts/test.
No description provided by the author
TriggerInfo Source provider-specific information about what triggered the build.
UpdateRefsBody Request body for UpdateRefs().
User is a wrapper class used by Item.
UserEntitlements is a wrapper class around the main response for the Get of UserEntitlement.
UserEntitlementsService handles communication with the user entitlements methods on the API utilising https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements?view=azure-devops-rest-6.0.
UsersService handles communication with the Graph.Users methods on the API utilising https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/get.
ValidationResult Represents the result of validating a build request.
WebAPITagDefinition The representation of a tag definition which is sent across the wire.
WorkItem describes an individual work item in TFS.
WorkItemComment Describes a response to CreateComment.
WorkItemCommentList Represents a list of work item comments.
WorkItemCommentListOptions URI parameters for ListComments Valid Expand strings are: all, mentions, none, reactions, renderedText, renderedTextOnly.
WorkItemFieldUpdate Describes an update to a work item field.
WorkItemLink A link between two work items.
WorkItemListResponse describes the list response for work items.
WorkItemReference Contains reference to a work item.
WorkItemRelation describes an intermediary between iterations and work items.
WorkItemRelationUpdates Describes updates to a work item's relations.
WorkItemsService handles communication with the work items methods on the API utilising https://docs.microsoft.com/en-gb/rest/api/vsts/wit/work%20items.
WorkItemUpdate Describes an update to a work item.
# Type aliases
BoardColumnType describes a column on the board.
BuildListOrder is enum type for build list order.
CommentThreadStatus enum declaration.
CommentType enum declaration.
GitObjectType enum declaration.
GitPullRequestMergeStrategy specifies the strategy used to merge the pull request during completion.
GitStatusState contains the metadata of a service/extension posting a status.
IterationReason The reason for which the pull request iteration was created.
PayloadType Used to describe the event area.
PullRequestAsyncStatus The current status of a pull request merge.
PullRequestMergeFailureType The specific type of merge request failure.
PullRequestStatus The current status of a pull request merge.
VersionControlChangeType enum declaration.