All Classes and Interfaces
Class
Description
License assigned to a user
Represents Azure DevOps Account
Type of Account License
Represents Work Item Recent Activity
List of account
Accounts class to manage Accounts Api
ACL acesDictionary entry
this is a list of access control entries, for posting to replace or merge ACEs
Access Control List entry
List of Access Control Lists
Represents a queue for running builds.
Specification of the agent defined by the pool provider.
Represents API inner exception
Types of Exception to be thrown
Approvals execution order.
A filter which would allow fetching approval steps selectively based on whether it is automated, or manual.
Gets or sets the condition type.
Gets or sets the type of approval.
Gets or sets the condition type.
Represents binding of data source for the service endpoint request.
Represents an artifact produced by a build.
Indicates the deploy phase type.
Represents an attachment to a build.
Attachment upload type
Represents the identity of an user object.
Data representation of a build.
Defines policy on environment queuing at Release Management side queue.
Represents an Authorized token object
AzDClientApi class to easily call VSTS REST Api with the connection parameters
Throws the exception from REST API
Deprecated.
This is deprecated as of version 5.0.0
Deprecated.
BaseRestClient that encapsulates the logic for managing request and response for REST API.
The job authorization scope for builds queued against this definition.
Build class to manage build API
The class to represent a collection of REST reference links.
Represents a build definition.
Represents a change associated with a build.
An array of Build changes
BuildConfiguration Details.
Represents a variable used by a build definition.
Array of build controller
Represents a reference to a build log.
The class to represent a collection of REST reference links.
Represents a revision of a build definition.
List of build definition revisions
List of build definition
Represents metadata about builds in the system.
Represents a build log.
Represents a reference to a build log.
List of build log
Represents a reference to a build option definition.
Represents a build process.
The reason that the build was created.
Represents a reference to an agent pool.
Represents a repository used by a build definition.
Represents a queue for running builds.
Represents the result of validating a build request.
The class to represent a collection of REST reference links.
The build result.
The build status.
Represents a trigger for a buld definition.
Represents a List of build results
The status of the controller.
Represents binding of data source for the service endpoint request.
Represents any workitems associated with a build
Represents an array of workitems
Deprecated.
This is deprecated as of version 5.0.0
Represents the committer to the repository
Gets or sets the trigger type.
None
The class to represent a collection of REST reference links.
The factory class which sets the default parameters to use this library.
An individual contribution made by an extension
Specifies a constraint that can be used to dynamically include/exclude a given contribution
Description about a property of a contribution type
A contribution type, given by a json schema
The quality of the definition document (draft, etc.)
Core class to manage core API
Custom header type to set headers for request/response
A custom field information.
Data provider
A value that indicates whether builds can be queued against this definition.
Gets or sets source of release definition.
Represents a reference to a definition.
A value that indicates whether builds can be queued against this definition.
The type of the definition.
Represents a demand used by a definition or build.
The type of the definition.
Project visibility.
Represents a JSON object.
Gets reason for release.
Gets environment status.
Deployment group.
Get the deployment group only if this action can be performed on it.
Include these additional details in the returned object.
List of deployment group
Status of release gates.
Deployment target.
Gets or sets the status of the manual intervention.
The class represents a property bag as a collection of key-value pairs.
The class to represent a collection of REST reference links.
Type of release trigger.
Gets status.
Days of the week to release.
DistributedTaskApi class to manage Agents, Deployment groups, Environments and Variable groups API
This is a temporary class to provide the details for the test run environment.
None
Include these additional details in the returned objects.
Represents an environment
Array of environment instance
EnvironmentInstanceNone
EnvironmentResourceReference.
None
Status of release task.
None
None
Base class for an event callback for an extension
This is the set of files available from the extension.
How this extension behaves with respect to licensing
ExtensionManagementApi class to manage installed extensions API
States of an installed extension
A container for artifacts.
Supported capabilities of a feed.
Feed Management class to manage Artifacts API
Permissions for a feed.
Permissions for a feed.
The role for this identity on a feed.
Array of feed containers
A view on top of a feed.
Array of feed views
Type of view.
Visibility status of the view.
The type of the field.
The usage of the field.
Type of object (Commit, Tree, Blob, Tag)
Represents a folder that contains build definitions.
A variable group reference is a shallow reference to variable group.
Use ExtensionFields to include extension fields, otherwise exclude them.
A Git annotated tag.
GIT class to manage git API
Status of the git asynchronous operation.
The class to represent a collection of REST reference links.
None
State of the status.
None
Represents all the data associated with a pull request.
Represents an array of Git commit references.
Represents a request body object for Get Commits Batch API.
List of deleted repositories
Project state.
Status information about a requested fork operation.
Preferences about how the pull request should be completed.
Request to sync data between two forks.
A list of fork sync requests.
What Git history mode should be used.
State of the status.
Git object identifier and type information.
Type of object (Commit, Tree, Blob, Tag)
The options which are used when a pull request merge is created.
Specify the strategy used to merge the pull request during completion.
This class contains the metadata of a service/extension posting a status.
Status context that uniquely identifies the status.
State of the status.
Represents an array of GitPush
User info and date for Git operations.
This class contains the metadata of a service/extension posting a status.
List of refs (branches).
Describes a set of Git Ref operations
Result of a git reference update.
Result of a git reference update list.
User info and date for Git operations.
Project visibility.
Identity information including a vote on a pull request.
A list of git repositories.
The class to represent a collection of REST reference links.
The type of change that was made to the item.
None
None
None
Versions of the wiki.
Version options - Specify additional modifiers to version (e.g Previous)
Version type (branch, tag, or commit).
Fully-qualified identifier for the source repository.
GraphApi class to manage graph users and groups
Graph descriptor type
This field contains zero or more interesting links about the graph subject.
Graph entity
Graph group entity
List of Graph group
Graph membership entity.
list of graph membership
This field contains zero or more interesting links about the graph subject.
Graph user entity
Represents a list of graph user
Project Group (e.g.
A group entity with additional properties including its license, extensions, and project membership
List of group entitlement
Group option to add a user to
Deprecated.
This is identical to
GraphReferenceLinks and all references should be updated accordinglyGroup Type
collection of identities
identity returned by API identities descriptor lookup
{
"count": 1,
"value": [
{
"id": "81fa6389-0872-6fdd-a451-7ba7880f566a",
"descriptor": "Microsoft.IdentityModel.Claims.ClaimsIdentity;7a394543-62fd-4274-a7d2-8fac775942b6\\jtseng@vscsi.us",
"subjectDescriptor": "aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4",
"providerDisplayName": "Jia-hao Tseng",
"isActive": true,
"members": [],
"memberOf": [],
"memberIds": [],
"properties": {
"SchemaClassName": {
"$type": "System.String",
"$value": "User"
},
"Description": {
"$type": "System.String",
"$value": ""
},
"Domain": {
"$type": "System.String",
"$value": "7a394543-62fd-4274-a7d2-8fac775942b6"
},
"Account": {
"$type": "System.String",
"$value": "jtseng@vscsi.us"
},
"DN": {
"$type": "System.String",
"$value": ""
},
"Mail": {
"$type": "System.String",
"$value": "jtseng@vscsi.us"
},
"SpecialType": {
"$type": "System.String",
"$value": "Generic"
},
"Alias": {
"$type": "System.String",
"$value": "jtseng"
},
"PUID": {
"$type": "System.String",
"$value": "aad:100FAFF21C1B5261"
},
"ComplianceValidated": {
"$type": "System.DateTime",
"$value": "2020-04-23T00:00:00Z"
},
"http://schemas.microsoft.com/identity/claims/objectidentifier": {
"$type": "System.String",
"$value": "55c8c7b6-7ace-43bc-918f-304dfa2b6317"
},
"MetadataUpdateDate": {
"$type": "System.DateTime",
"$value": "2018-07-10T16:11:40Z"
},
"DirectoryAlias": {
"$type": "System.String",
"$value": "jtseng"
}
},
"resourceVersion": 2,
"metaTypeId": 0
}
]
}
Identity information including a vote on a pull request.
None
Ignored gates.
Represents build options input
Represents a VSTS extension along with its installation state
Array of installed extensions
Information about this particular installation of the extension
Represents an installation issue
Base Api instance
Represents an issue (error, warning) associated with a build.
None
List of issues occurred while execution of task.
The type (error, warning) of the issue.
None
None
Represents work items in an iteration backlog
Phase in pipeline
Helper class to transform json string to POJO and vice versa
Provides properties that describe a Git commit and associated metadata.
Provides properties that describe a Git commit and associated metadata.
Provides properties that describe a Git commit and associated metadata.
Summary of Licenses in the organization.
Maps a contribution to a licensing behavior
Licensing Source
The link query mode.
Response class for getting the resource area url.
A collection of logs.
Logical operator separating the condition clause
Represents a build log.
None
List of manual interventions
Gets or sets the status of the manual intervention.
MavenApi class to manage maven artifact package api
Deletion state of a maven package.
MemberEntitlementManagementApi class to manage groups and user entitlements API
This field contains zero or more interesting links about the graph subject.
Helper class to construct the request body dynamically by removing non-assigned values in a type.
Type of MSDN License (e.g.
OAuth Api class to authorize access to REST API
Reference for an async operation.
Represents the application of an optional behavior to a build definition.
Represents a reference to an orchestration plan.
Represents an organization
List of data provider
List of organization
Package version metadata for a Maven package
Package version metadata for a Universal package
The patch operation.
Source type, such as Public or Internal.
A page of users
Pipeline reference
Represents a phase
Definition of a pipeline.
Pipeline configuration object
Log for a pipeline.
A reference to a Pipeline.
The class to represent a collection of REST reference links.
Pipeline Run object
List of Run object
Defines a list of Pipeline object
PipelinesApi class to manage Pipelines API
Artifacts are collections of files produced by a pipeline.
Expand options.
Represents a plan
PolicyApi class to manage Policy API
The full policy configuration with settings.
List of full policy configuration with settings.
User-friendly policy type with description (used for querying policy types).
Policy type reference.
List of User-friendly policy type with description (used for querying policy types).
Preview run result.
Represents a build process.
Represents process
Stores process ID.
Stores project ID and its process ID.
Additional options for queueing the build.
None
A user profile.
Represents a Team Project object.
Relation between a project and the user's effective permissions in that project.
data object representing project feature
Array of project properties
A named value associated with a project.
A reference to a project
The class to represent a collection of REST reference links.
None
List of project
The build's priority.
The class to represent a collection of REST reference links.
Build repository properties
The class represents a property bag as a collection of key-value pairs.
Represents a retention policy for a build definition.
Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows.
None
None
List of pull request reviewers.
Represents a list of pull request
The flag to control error policy in a query batch request.
Represents an item in the work item query hierarchy.
The recursion option for use in a tree query.
The type of query.
Represents a queue for running builds.
Represents a reference to an agent pool.
Represents a reference to an orchestration plan.
Represents a common hyper reference link
Common class to represent self reference link
Represents all reference links commonly used across the services
The class to represent a collection of REST reference links.
Reference to a release.
The class to represent a collection of REST reference links.
None
Release Api to manage releases service
None
None
Get a list of release approvals
Gets or sets the status of the approval.
Gets or sets the type of approval.
Gets or sets the list of artifacts.
None
None
None
None
None
None
None
None
None
None
None
Release definition revision
Release definition revisions
List of release definition
None
None
None
None
None
Release environment status.
None
None
None
ResultMetadata for the given outcome/count.
Gets links to access the release.
List of release
None
None
None
None
None
List of repositories
Represents build repository
Represents a repository's webhook returned from a source provider.
List of Repository webhooks
Represents an user object
Collection of resource area identifiers.
None
List of the resource references
RestClient to call Azure DevOps REST API.
This class is used to provide the filters used for discovery
ResultMetadata for the given outcome/count.
The result.
Identity information including a vote on a pull request.
This class is used to provide the filters used for discovery
Test run statistics per outcome.
An abstracted reference to some other resource.
An abstracted reference to some other resource.
None
Represents a security namespace.
represents an action in a particular security namespace
List of security namespaces
encapsulate security role returned by devops
return security roles
refer to Security Token Reference Documentation
In order to reference and assign access control entries, scope must be specified via a token, which varies depending on the security namespace and resource.
Represents an endpoint which may be used by an orchestration job.
Action filter for the service connection.
Service Endpoint Api to manage service endpoint service
Reference to a project
A list of service endpoints
Service Hooks Api to manage service hooks service
Encapsulates an event subscription.
List of service hook subscription
Stage in pipeline
Signed url for downloading this artifact
Represents a SourceProviderAttribute
Represents an array of SourceProviderAttribute
Represents a pull request object.
A set of repositories returned from the source provider.
Represents a repository returned from a source provider.
Represents an item in a repository from a source provider.
Represents an array of items in the repository from a source provider.
The set of ref mappings to use when performing a sync or create.
Test environment Detail.
Stage update type
Represents a definition steps
Response object from a subject lookup via descriptor
This contains information about the object kind (user or group) and origin source (aad, vsts, etc)
Not all fields may be populated in the response.
wrapper container for subjectLookup response
Subject descriptor is in both the value-field map-key and descriptor field of the
SubjectLookupThe types of triggers supported by this source provider.
Represents a task in a step
Additional pool settings and details
Gets or sets the type of the pool
Represents the public key portion of an RSA asymmetric key.
A reference to an agent.
Whether or not the agent is online.
Represents a variable group.
Details about an agent update.
The result of this request.
None
None
List of task agent
None
None
None
None
None
None
None
None
None
None
Represents a reference to a task.
None
None
None
Represents a project team
Represents the team iteration attributes
Reference object for a TeamProjectCollection.
None
None
Represents a shallow reference to a TeamProject.
None
A reference to a team
Represents list of team
Represents a shallow ref for a single iteration.
List of team settings iterations
Test Resolution State Details.
Test run details.
Test run details.
The types of sub states for test run.
Represents an array of test run
Test run statistics.
Tag attached to a run or result.
None
Represents the timeline of a build.
Represents an entry in a build's timeline.
The state of the record.
Represents a reference to a timeline.
None
Sourceprovider-specific information about what triggered the build
Represents a trigger for a build definition.
UpackApi class to manage Universal Package artifact package api
Deletion state of a Universal package.
Describes upstreaming behavior for a given feed/protocol/package
Source type, such as Public or Internal.
Upstream source definition, including its Identity, package type, and other
associated information.
Source type, such as Public or Internal.
Specifies the status of the upstream.
None
Indicates whether external upstream versions should be considered for this
package
Url helper class to encode the special characters in the url.
A user entity with additional properties including their license, extensions, and project membership
Represents the result after adding a user
List of user entitlement
Represents the response after adding a user
Summary of licenses and extensions assigned to users in the organization
None
None
A variable group is a collection of related variables.
None
Action filter for the variable group.
Represents the request body for adding and updating a variable group.
Variable group map to create variable groups easily.
A variable group reference is a shallow reference to variable group.
None
Sets provider data.
Gets the results in the defined order.
Container of Variable groups
Defines provider data of the variable group.
None
None
Recursion level for subpages retrieval.
The representation of data needed to create a tag definition which is sent across the wire.
The representation of a tag definition which is sent across the wire.
List of tag definitions
Represents a team
Wiki class to manage Wiki API
Defines properties for wiki attachment file.
Defines a page in a wiki.
Defines a page with its metedata in a wiki.
Request contract for Wiki Page Move.
Contract encapsulating parameters for the page move operation.
Defines properties for wiki page stat.
Defines a wiki resource.
List of wiki pages
Work class to manage work API
None
None
Describes a work item.
Collection of link attributes.
Represents the reference to a specific version of a comment on a Work Item.
Full deleted work item object
Full deleted work item object.
Work item delete references
Shallow Reference to a deleted work item.
Work item shallow references
Describes a field on a work item and it's properties specific to that work item type.
Describes a work item field operation.
Reference to a field in a work item
Represents a Work item internal field elements
Reference to a work item icon.
A link between two work items.
A link between two work items.
List of work item
Represents a clause in a work item query.
The result of a work item query.
The sort columns of the query.
Contains reference to a work item.
Contains reference to a work item.
Relations of the work item.
Work item type state name, color and state category
WorkItem Tracking class to manage work items API
Describes a work item type.
Field instance of a work item type.
List of work item types
Represents a yaml build.