azure-devops-extension-api package
Classes
AccountsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ReportingRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
AlertRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
BoardsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
BuildRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
RestClientBase |
Base class that should be used (derived from) to make requests to VSS REST apis |
Uri |
Class that represents a Uri and allows parsing/getting and setting of individual parts |
ContributionsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
CoreRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
DashboardRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ConfigurationEvent | |
WidgetConfigurationSave | |
WidgetSizeConverter | |
WidgetStatusHelper | |
ExtensionManagementRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
FavoriteRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
FeatureAvailabilityRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
FeatureManagementRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
FileContainerRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
GalleryRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
GitRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
GraphRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
PeoplePickerProvider | |
LocationsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ManagementRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
NotificationRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
OperationsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
PipelinesRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
PolicyRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ProfileRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ProjectAnalysisRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ReleaseRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ResourceUsageRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ServiceEndpointRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
ServiceHooksRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
TaskAgentRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
TestRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
TestPlanRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
TestResultsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
TfvcRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
WikiRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
WorkRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
WorkItemTrackingRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
WorkItemTrackingProcessRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
WorkItemTrackingProcessDefinitionsRestClient |
Base class that should be used (derived from) to make requests to VSS REST apis |
Interfaces
Account | |
AccountCreateInfoInternal | |
AccountPreferencesInternal | |
AlertSummaryBySeverity |
Alert Summary by severity. |
OrgAlertSummary |
Org Alert Summary. |
OrgEnablementSummary |
Org Enablement Summary. |
ProjectAlertSummary |
Project Alert Summary. |
ProjectEnablementSummary |
Project Enablement Summary. |
RepoAlertSummary |
Repo Alert Summary. |
RepoEnablementSummary |
Repo Enablement Summary. |
Alert | |
AlertAnalysisInstance |
Summary of the state of the alert for a given analysis configuration. |
AlertMetadata |
Alert metadata. |
AlertMetadataChange |
Used to represent an update in a relationship between an alert and an artifact. |
AlertStateUpdate | |
AnalysisConfiguration |
AnalysisConfiguration class models a build definition. |
AnalysisConfigurationDetails | |
AnalysisInstance |
AnalysisInstance class models a build. |
AnalysisResult | |
Branch | |
Dependency |
Represents a dependency. |
DependencyResult |
An instance of a vulnerable dependency that was detected |
Dismissal |
Information about an alert dismissal |
License |
License information for dependencies |
LogicalLocation | |
Metadata |
The metadata operation to be performed on the alert. |
MetadataChange |
The change that has been made to the metadata. |
PhysicalLocation |
Location in the source control system where the issue was found |
Pipeline |
Definition of a pipeline. |
Region | |
RelationMetadata |
The metadata to be associated with the alert. |
Result | |
Rule | |
SarifUploadStatus | |
SarifValidationError | |
SearchCriteria | |
Tool |
An Analysis tool that can generate security alerts |
UxFilters | |
ValidationFingerprint | |
VersionControlDetails |
Information for locating files in a source control system |
VersionControlFilePath | |
VersionControlResult | |
VersionControlSnippet | |
Board | |
BoardColumn | |
BoardColumnBase |
Provides base properties that describe a column in a board. |
BoardColumnCollectionResponse |
Response collection for board column actions. |
BoardColumnCreate |
Describes a column to create on a board. |
BoardColumnCreateList |
Describes a list of columns to create on a board. |
BoardColumnCreatedRealtimeEvent |
INTERNAL. Event that is fired when a column is added. |
BoardColumnDeletedRealtimeEvent |
INTERNAL. Event that is fired when a column is deleted. |
BoardColumnResponse |
Response for board column actions. |
BoardColumnUpdate |
Describes a column to update on a board. |
BoardColumnUpdatedRealtimeEvent |
INTERNAL. Event that is fired when a column is updated. |
BoardItem |
Provides properties that describe an item in a board. |
BoardItemAction |
Describe the action to apply when an item is moved to a column and the specified condition is met. |
BoardItemActionCreate |
Describes a board item action to create on a board. |
BoardItemActionUpdate |
Describes a board item action to update on a board. |
BoardItemAddedRealtimeEvent |
INTERNAL. Event that is fired when a board item is added. |
BoardItemBatchOperation |
Data to perform an operation on a batch of board items. |
BoardItemCollectionResponse |
Response collection for board items actions. |
BoardItemIdAndEtag |
Board Item id and etag pair. |
BoardItemMovedRealtimeEvent |
INTERNAL. Event that is fired when a board item moves. |
BoardItemReference |
Provides properties that describe an item's source identifier and type in a board. |
BoardItemRemovedRealtimeEvent |
INTERNAL. Event that is fired when a board item is removed. |
BoardItemResponse |
Provides a response for board item actions. |
BoardItemSourceIdAndType |
Provides properties that describe an item's source identifier and type in a board. |
BoardItemStateSync |
Describe a two way sync from moving item on board OR from changing state of item outside of the board. |
BoardItemStateSyncCreate |
Describes a board item state sync to create on a board. |
BoardItemStateSyncUpdate |
Describes a board item state sync to update on a board. |
BoardReference | |
BoardResponse |
Response for board column actions. |
BoardRow | |
BoardRowBase |
Provides properties that describe a row in a board. |
BoardRowCollectionResponse |
Response collection for board row actions. |
BoardRowCreate |
Describes a row to create on a board. |
BoardRowCreateList |
Describes a list of rows to create on a board. |
BoardRowResponse |
Response for board row actions. |
BoardRowUpdate |
Describes a row to update on a board. |
CreateBoard | |
EntityReference | |
NewBoardItem |
Provides properties that describe an item's source identifier and type in a board. |
NoContentResponse |
Response containing ETag header with no content |
PredicateAndAction | |
RealtimeBoardEvent |
Base type for real time board events. All board events should inherit from this class. |
SubTypeAndStateValue | |
UpdateBoard | |
UpdateBoardItem | |
UpdateBoardItemList |
List of items to update in the board. |
AgentPoolQueue |
Represents a queue for running builds. |
AgentPoolQueueReference |
Represents a reference to an agent queue. |
AgentPoolQueueTarget |
Describes how a phase should run against an agent queue. |
AgentSpecification |
Specification of the agent defined by the pool provider. |
AgentTargetExecutionOptions |
Additional options for running phases against an agent queue. |
ArtifactResource | |
Attachment | |
Build | |
BuildAgent | |
BuildAgentReference | |
BuildArtifact |
Represents an artifact produced by a build. |
BuildBadge |
Represents a build badge. |
BuildCompletedEvent | |
BuildCompletionTrigger |
Represents a build completion trigger. |
BuildController | |
BuildDefinition |
Represents a build definition. |
BuildDefinition3_2 |
For back-compat with extensions that use the old Steps format instead of Process and Phases |
BuildDefinitionReference |
The build definition reference resource |
BuildDefinitionReference3_2 |
For back-compat with extensions that use the old Steps format instead of Process and Phases |
BuildDefinitionRevision |
Represents a revision of a build definition. |
BuildDefinitionSourceProvider | |
BuildDefinitionStep |
Represents a step in a build phase. |
BuildDefinitionTemplate |
Represents a template from which new build definitions can be created. |
BuildDefinitionTemplate3_2 |
For back-compat with extensions that use the old Steps format instead of Process and Phases |
BuildDefinitionVariable |
Represents a variable used by a build definition. |
BuildDeletedEvent | |
BuildDeployment | |
BuildEvent | |
BuildLog |
Represents a build log. |
BuildLogReference |
Represents a reference to a build log. |
BuildMetric |
Represents metadata about builds in the system. |
BuildOption |
Represents the application of an optional behavior to a build definition. |
BuildOptionDefinition |
Represents an optional behavior that can be applied to a build definition. |
BuildOptionDefinitionReference |
Represents a reference to a build option definition. |
BuildOptionGroupDefinition |
Represents a group of inputs for a build option. |
BuildOptionInputDefinition |
Represents an input for a build option. |
BuildProcess |
Represents a build process. |
BuildProcessResources |
Represents resources used by a build process. |
BuildProcessTemplate | |
BuildQueuedEvent | |
BuildReference |
Reference to a build. |
BuildReportMetadata |
Represents information about a build report. |
BuildRepository |
Represents a repository used by a build definition. |
BuildRequestValidationResult |
Represents the result of validating a build request. |
BuildResourceUsage |
Represents information about resources used by builds in the system. |
BuildRetentionHistory |
A historical overview of build retention information. This includes a list of snapshots taken about build retention usage, and a list of builds that have exceeded the default 30 day retention policy. |
BuildRetentionSample |
A snapshot of build retention information. This class takes a sample at the given time. It provides information about retained builds, files associated with those retained builds, and number of files being retained. |
BuildServer | |
BuildSettings |
Represents system-wide build settings. |
BuildSummary | |
BuildTagsAddedEvent | |
BuildTrigger |
Represents a trigger for a buld definition. |
BuildUpdatedEvent | |
BuildWorkspace |
Represents a workspace mapping. |
BuildsDeletedEvent | |
BuildsDeletedEvent1 | |
Change | |
ConsoleLogEvent | |
ContinuousDeploymentDefinition | |
ContinuousIntegrationTrigger |
Represents a continuous integration (CI) trigger. |
DefinitionReference |
Represents a reference to a definition. |
DefinitionResourceReference | |
Demand | |
Deployment | |
DeploymentBuild |
Deployment information for type "Build" |
DeploymentDeploy |
Deployment information for type "Deploy" |
DeploymentTest |
Deployment information for type "Test" |
DesignerProcess |
Represents a build process supported by the build definition designer. |
DesignerProcessTarget |
Represents the target for the build process. |
DockerProcess |
Represents a build process. |
DockerProcessTarget |
Represents the target for the docker build process. |
Folder | |
Forks |
Represents the ability to build forks of the selected repository. |
GatedCheckInTrigger |
Represents a gated check-in trigger. |
InformationNode |
Data representation of an information node associated with a build |
Issue |
An issue (error, warning) associated with a pipeline run. |
JustInTimeProcess |
Represents a build process. |
MappingDetails | |
MinimalRetentionLease | |
MultipleAgentExecutionOptions |
Represents options for running a phase against multiple agents. |
NewRetentionLease |
Required information to create a new retention lease. |
Phase |
Represents a phase of a build definition. |
PhaseTarget |
Represents the target of a phase. |
PipelineGeneralSettings |
Contains pipeline general settings. |
PipelineTriggerSettings |
Represents the effective settings applicable to individual pipeline triggers. |
ProjectRetentionSetting |
Contains the settings for the retention rules. |
PullRequest |
Represents a pull request object. These are retrieved from Source Providers. |
PullRequestTrigger | |
RealtimeBuildEvent | |
RepositoryWebhook |
Represents a repository's webhook returned from a source provider. |
ResourceReference |
Represents a reference to a resource. |
RetentionLease |
A valid retention lease prevents automated systems from deleting a pipeline run. |
RetentionLeaseUpdate |
An update to the retention parameters of a retention lease. |
RetentionPolicy | |
RetentionSetting |
Contains the minimum, maximum, and current value for a retention setting. |
Schedule | |
ScheduleTrigger |
Represents a schedule trigger. |
SecureFileReference |
Represents a reference to a secure file. |
ServerTarget |
Represents a phase target that runs on the server. |
ServerTargetExecutionOptions |
Represents options for running a phase on the server. |
ServiceEndpointReference |
Represents a reference to a service endpoint. |
SourceProviderAttributes | |
SourceRelatedWorkItem |
Represents a work item related to some source item. These are retrieved from Source Providers. |
SourceRepositories |
A set of repositories returned from the source provider. |
SourceRepository |
Represents a repository returned from a source provider. |
SourceRepositoryItem |
Represents an item in a repository from a source provider. |
SupportedTrigger | |
SvnMappingDetails |
Represents a Subversion mapping entry. |
SvnWorkspace |
Represents a subversion workspace. |
TaskAgentPoolReference | |
TaskDefinitionReference | |
TaskOrchestrationPlanGroupReference | |
TaskOrchestrationPlanGroupsStartedEvent | |
TaskOrchestrationPlanReference | |
TaskReference |
A reference to a task. |
Timeline |
Timeline |
TimelineAttempt |
An attempt to update a TimelineRecord. |
TimelineRecord |
Detailed information about the execution of different operations during pipeline run. |
TimelineRecordsUpdatedEvent | |
TimelineReference |
A reference to a timeline. |
UpdateProjectRetentionSettingModel |
Contains members for updating the retention settings values. All fields are optional. |
UpdateRetentionSettingModel | |
UpdateStageParameters | |
UpdateTagParameters | |
VariableGroup |
A variable group is a collection of related variables. |
VariableGroupReference |
Represents a reference to a variable group. |
VariableMultipliersAgentExecutionOptions |
Represents options for running a phase based on values specified by a list of variables. |
VariableMultipliersServerExecutionOptions |
Represents options for running a phase based on values specified by a list of variables. |
WorkspaceMapping |
Mapping for a workspace |
WorkspaceTemplate | |
XamlBuildControllerReference | |
XamlBuildDefinition |
Represents a reference to a definition. |
XamlBuildReference | |
XamlBuildServerReference | |
XamlDefinitionReference | |
YamlBuild |
Represents a yaml build. |
YamlProcess |
Represents a YAML process. |
IBuildPageData |
Contextual information for a build page |
IBuildPageDataService |
Service for getting contextual information when on a builds page |
Comment |
Comment on a Work Item. |
CommentAttachment |
Represents an attachment to a comment. |
CommentCreateParameters |
Represents a request to create a work item comment. |
CommentList |
Represents a list of work item comments. |
CommentMention |
Base class for WIT REST resources. |
CommentReaction |
Contains information about work item comment reaction for a particular reaction type. |
CommentResourceReference |
Base class for comment resource references |
CommentUpdateParameters |
Represents a request to update a comment. |
CommentVersion |
Represents a specific version of a comment on a work item. |
ExtensionDataCollection |
Represents a single collection for extension data documents |
IColor |
Color used in some UI components |
IContributedButton |
Defines a button from a first- or third- party contribution |
IContributedIconDefinition |
Definition which can be specified in a contributions "icon" property which can specify a set of values for different themes. |
IContributedPill |
Defines a pill from a contribution |
IDialogOptions |
Options for showing host dialogs |
IDocumentOptions |
Interface for options that can be supplied with document actions |
IExtensionDataManager | |
IExtensionDataService | |
IGlobalDialog |
Dialog Props specifying how it will be rendered by the service |
IGlobalMessageBanner |
Banner Props specifying how it will be rendered by the service |
IGlobalMessageHelpInfo |
Optional help icon info to show after global message text |
IGlobalMessageLink |
Message links that will be formatted into the message. |
IGlobalMessagesService | |
IHostNavigationService |
Service for interacting with the host window's navigation (URLs, new windows, etc.) |
IHostPageLayoutService |
Service for interacting with the layout of the page: managing full-screen mode, opening dialogs and panels |
ILocationService |
Service for external content to get locations |
IMessageDialogOptions |
Options for showing a message dialog |
INavigationElement |
Information about a displayed navigation element |
IPageRoute |
Route information for the current page |
IPanelOptions |
Options for showing panels |
IProjectInfo | |
IProjectPageService | |
IToast |
Toast Props with metadata to specify how it will be rendered by the service |
IAuthorizationTokenProvider |
Interface for a class that can retrieve authorization tokens to be used in fetch requests. |
IVssRestClientOptions |
Options for a specific instance of a REST client. |
IPostRequestEvent |
An IPostRequestEvent is sent after a fetch request has completed. |
IPreRequestEvent |
An IPreRequestEvent is sent before a fetch request is made. |
IVssRequestOptions |
VSS-specific options for VSS requests |
VssServerError |
When a fetch request fails, it will throw a VssServerError. Failure is defined as a request that made it to the server, and the server successfully responded with a failure. This will be any status return that is not a status code in the success range (200-299). |
RestClientRequestParams |
Parameters for sending a WebApi request |
IParsedRoute |
Represents a route parsed by parseRoute |
IParsedRouteSegment |
And individual segment of the route (fixed text or a parameter) |
IQueryParameter |
A single query parameter entry in a Uri |
IRouteMatchResult |
Result of a call to replace route values for a parsed route |
IUriParseOptions |
Options for parsing a Uri string |
ClientContribution |
Representation of a ContributionNode that can be used for serialized to clients. |
ClientContributionNode |
Representation of a ContributionNode that can be used for serialized to clients. |
ClientContributionProviderDetails | |
ClientDataProviderQuery |
A client data provider are the details needed to make the data provider request from the client. |
Contribution |
An individual contribution made by an extension |
ContributionBase |
Base class shared by contributions and contribution types |
ContributionConstraint |
Specifies a constraint that can be used to dynamically include/exclude a given contribution |
ContributionNodeQuery |
A query that can be issued for contribution nodes |
ContributionNodeQueryResult |
Result of a contribution node query. Wraps the resulting contribution nodes and provider details. |
ContributionPropertyDescription |
Description about a property of a contribution type |
ContributionType |
A contribution type, given by a json schema |
DataProviderContext |
Contextual information that data providers can examine when populating their data |
DataProviderExceptionDetails | |
DataProviderQuery |
A query that can be issued for data provider data |
DataProviderResult |
Result structure from calls to GetDataProviderData |
ExtensionEventCallback |
Base class for an event callback for an extension |
ExtensionEventCallbackCollection |
Collection of event callbacks - endpoints called when particular extension events occur. |
ExtensionLicensing |
How an extension should handle including contributions based on licensing |
ExtensionManifest |
Base class for extension properties which are shared by the extension manifest and the extension model |
InstalledExtension |
Represents a VSTS extension along with its installation state |
InstalledExtensionState |
The state of an installed extension |
InstalledExtensionStateIssue |
Represents an installation issue |
LicensingOverride |
Maps a contribution to a licensing behavior |
ResolvedDataProvider |
Entry for a specific data provider's resulting data |
CategorizedWebApiTeams | |
IdentityData | |
Process | |
ProcessReference | |
ProjectAvatar |
Contains the image data for project avatar. |
ProjectInfo |
Contains information describing a project. |
ProjectMessage | |
ProjectProperties | |
ProjectProperty |
A named value associated with a project. |
Proxy | |
ProxyAuthorization | |
TeamContext |
The Team Context for an operation. |
TeamProject |
Represents a Team Project object. |
TeamProjectCollection |
Data contract for a TeamProjectCollection. |
TeamProjectCollectionReference |
Reference object for a TeamProjectCollection. |
TeamProjectReference |
Represents a shallow reference to a TeamProject. |
TemporaryDataCreatedDTO |
A data transfer object that stores the metadata associated with the creation of temporary data. |
TemporaryDataDTO |
A data transfer object that stores the metadata associated with the temporary data. |
UpdateTeam |
Updateable properties for a WebApiTeam. |
WebApiConnectedService | |
WebApiConnectedServiceDetails | |
WebApiConnectedServiceRef | |
WebApiCreateTagRequestData |
The representation of data needed to create a tag definition which is sent across the wire. |
WebApiProject |
Represents a shallow reference to a TeamProject. |
WebApiProjectCollection | |
WebApiProjectCollectionRef | |
WebApiTagDefinition |
The representation of a tag definition which is sent across the wire. |
WebApiTeam | |
WebApiTeamRef | |
CopyDashboardOptions |
Copy options of a Dashboard. |
CopyDashboardResponse | |
Dashboard |
Model of a Dashboard. |
DashboardGroup |
Describes a list of dashboards associated to an owner. Currently, teams own dashboard groups. |
DashboardGroupEntry |
Dashboard group entry, wrapping around Dashboard (needed?) |
DashboardGroupEntryResponse |
Response from RestAPI when saving and editing DashboardGroupEntry |
DashboardResponse |
Dashboard group entry, wrapping around Dashboard (needed?) |
LightboxOptions |
Lightbox configuration |
SemanticVersion |
versioning for an artifact as described at: http://semver.org/, of the form major.minor.patch. |
Widget |
Widget data |
WidgetMetadata |
Contribution based information describing Dashboard Widgets. |
WidgetMetadataResponse | |
WidgetPosition | |
WidgetResponse |
Response from RestAPI when saving and editing Widget |
WidgetSize | |
WidgetTypesResponse | |
WidgetsVersionedList |
Wrapper class to support HTTP header generation using CreateResponse, ClientHeaderParameter and ClientResponseType in WidgetV2Controller |
CustomSettings |
settings of the widget that encapsulate their serialized data and version support. |
EventArgs |
Arguments associated with an event being passed by a widget or configurations. |
IConfigurableWidget |
Configurable widgets implement this interface |
IWidget |
All widgets implement this interface |
IWidgetConfiguration |
Widget authors implement this interface for their configuration. |
IWidgetConfigurationContext |
Interface for the object passed to the widget configuration to communicate with its host. |
NotifyResult |
The result of a notification being made by a widget configuration. |
SaveStatus |
Interface for the object passed to the host when user clicks on the Save button in the configuration pane |
Size |
Size of lightbox to draw widget in |
WidgetSettings |
A description of widget state, satisfying requirements for rendering a widget (Does not contain grid centric information, or contribution metadata). |
WidgetStatus |
The object encapsulating the result for an IWidget/IConfigurableWidget method call. This object is created using the WidgetStatusHelper library. |
AuthorizationHeader | |
DataSourceBindingBase |
Represents binding of data source for the service endpoint request. |
ProcessParameters | |
TaskInputDefinitionBase | |
TaskInputValidation | |
TaskSourceDefinitionBase | |
AcquisitionOperation | |
AcquisitionOperationDisallowReason | |
AcquisitionOptions |
Market item acquisition options (install, buy, etc) for an installation target. |
ContributionProviderDetails | |
DataProviderSharedData |
Data bag that any data provider can contribute to. This shared dictionary is returned in the data provider result. |
ExtensionAcquisitionRequest |
Contract for handling the extension acquisition process |
ExtensionAuditLog |
Audit log for an extension |
ExtensionAuditLogEntry |
An audit log entry for an extension |
ExtensionAuthorization | |
ExtensionDataCollectionQuery |
Represents a query to receive a set of extension data collections |
ExtensionEvent |
Stores details of each event |
ExtensionEventUrls | |
ExtensionHost | |
ExtensionRequest |
A request for an extension (to be installed or have a license assigned) |
ExtensionRequestEvent | |
ExtensionRequestUrls | |
ExtensionRequestsEvent | |
ExtensionState |
The state of an extension |
ExtensionUrls | |
InstalledExtensionQuery | |
RequestedExtension |
A request for an extension (to be installed or have a license assigned) |
Scope | |
SupportedExtension |
Information about the extension |
ArtifactProperties | |
ArtifactScope |
Describes the scope a favorited Artifact resides in. e.g. A team project. |
Favorite |
Implementation of Favorite contract following modern storage |
FavoriteCreateParameters | |
FavoriteProvider |
Exposes a provider of favorites. |
FavoritesSecuredObject | |
FeatureFlag | |
FeatureFlagPatch |
This is passed to the FeatureFlagController to edit the status of a feature flag |
ContributedFeature |
A feature that can be enabled or disabled |
ContributedFeatureHandlerSettings | |
ContributedFeatureListener |
An identifier and properties used to pass into a handler for a listener or plugin |
ContributedFeatureSettingScope |
The scope to which a feature setting applies |
ContributedFeatureState |
A contributed feature/state pair |
ContributedFeatureStateQuery |
A query for the effective contributed feature states for a list of feature ids |
ContributedFeatureValueRule |
A rule for dynamically getting the enabled/disabled state of a feature |
ContainerItemBlobReference |
Represents an reference to a file in Blobstore |
FileContainer |
Represents a container that encapsulates a hierarchical file system. |
FileContainerItem |
Represents an item in a container. |
InputDescriptor |
Describes an input for subscriptions. |
InputFilter |
Defines a filter for subscription inputs. The filter matches a set of inputs if any (one or more) of the groups evaluates to true. |
InputFilterCondition |
An expression which can be applied to filter a list of subscription inputs |
InputValidation |
Describes what values are valid for a subscription input |
InputValue |
Information about a single value for an input |
InputValues |
Information about the possible/allowed values for a given subscription input |
InputValuesError |
Error information related to a subscription input value. |
InputValuesQuery | |
Answers | |
AssetDetails | |
AzurePublisher | |
AzureRestApiRequestModel | |
AzureRestApiResponseModel | |
CategoriesResult |
This is the set of categories in response to the get category query |
CategoryLanguageTitle |
Definition of one title of a category |
Concern |
The structure of a Concern Rather than defining a separate data structure having same fields as QnAItem, we are inheriting from the QnAItem. |
CustomerLastContact |
Stores Last Contact Date |
CustomerSupportRequest |
An entity representing the data required to create a Customer Support Request. |
EventCounts | |
ExtensionBadge | |
ExtensionCategory | |
ExtensionDailyStat | |
ExtensionDailyStats | |
ExtensionDraft | |
ExtensionDraftAsset | |
ExtensionDraftPatch | |
ExtensionEvents |
Container object for all extension events. Stores all install and uninstall events related to an extension. The events container is generic so can store data of any type of event. New event types can be added without altering the contract. |
ExtensionFile | |
ExtensionFilterResult |
The FilterResult is the set of extensions that matched a particular query filter. |
ExtensionFilterResultMetadata |
ExtensionFilterResultMetadata is one set of metadata for the result e.g. Total count. There can be multiple metadata items for one metadata. |
ExtensionIdentifier |
Represents the component pieces of an extensions fully qualified name, along with the fully qualified name. |
ExtensionPackage |
Package that will be used to create or update a published extension |
ExtensionPayload | |
ExtensionPolicy |
Policy with a set of permissions on extension operations |
ExtensionQuery |
An ExtensionQuery is used to search the gallery for a set of extensions that match one of many filter values. |
ExtensionQueryResult |
This is the set of extensions that matched a supplied query through the filters given. |
ExtensionShare | |
ExtensionStatistic | |
ExtensionStatisticUpdate | |
ExtensionVersion | |
FilterCriteria |
One condition in a QueryFilter. |
InstallationTarget | |
MetadataItem |
MetadataItem is one value of metadata under a given category of metadata |
NotificationsData |
Information needed for sending mail notification |
ProductCategoriesResult |
This is the set of categories in response to the get category query |
ProductCategory |
This is the interface object to be used by Root Categories and Category Tree APIs for Visual Studio Ide. |
PublishedExtension | |
Publisher | |
PublisherBase |
Keeping base class separate since publisher DB model class and publisher contract class share these common properties |
PublisherFacts |
High-level information about the publisher, like id's and names |
PublisherFilterResult |
The FilterResult is the set of publishers that matched a particular query filter. |
PublisherQuery |
An PublisherQuery is used to search the gallery for a set of publishers that match one of many filter values. |
PublisherQueryResult |
This is the set of publishers that matched a supplied query through the filters given. |
PublisherRoleAssignment | |
PublisherSecurityRole | |
PublisherUserRoleAssignmentRef | |
QnAItem |
The core structure of a QnA item |
QueryFilter |
A filter used to define a set of extensions to return during a query. |
Question |
The structure of the question / thread |
QuestionsResult | |
RatingCountPerRating | |
Response | |
RestApiResponseStatusModel |
REST Api Response |
Review | |
ReviewEventProperties |
Properties associated with Review event |
ReviewPatch | |
ReviewReply | |
ReviewSummary | |
ReviewsResult | |
UnpackagedExtensionData | |
UserExtensionPolicy |
Represents the extension policy applied to a given user |
UserIdentityRef |
Identity reference with name and guid |
UserReportedConcern | |
CommentRule |
Describes how comments for a language work. |
EnterAction |
Describes what to do when pressing Enter. |
FoldingMarkers |
Describes language specific folding markers such as '#region' and '#endregion'. The start and end regexes will be tested against the contents of all lines and must be designed efficiently:
|
FoldingRules |
Describes folding rules for a language. |
IAutoClosingPair | |
IAutoClosingPairConditional | |
ICodeEditorContribution |
Extensions to the code editor should implement this interface, which will be called when the exension is loaded. |
ICodeEditorContributionEndpoints |
These functions will be made available to extensions to interact with the code editor. |
IDocComment |
Definition of documentation comments (e.g. Javadoc/JSdoc) |
IGitResourceVersion |
Identifies a file in Git. |
IJsonSchemaRegistration |
Describes a JSON schema |
ILanguageExtensionPoint |
A monaco language extension point. See https://github.com/Microsoft/monaco-editor/blob/master/monaco.d.ts |
ILanguageRegistration |
Everything needed to register a language. See https://github.com/Microsoft/monaco-languages/ for examples. |
IMonarchLanguage |
A Monarch language definition |
IResource | |
ITfvcResourceVersion |
Identifies a file in TFVC. |
IndentationRule |
Describes indentation rules for a language. |
LanguageConfiguration |
The language configuration interface defines the contract between extensions and various editor features, like automatic bracket insertion, automatic indentation etc. |
OnEnterRule |
Describes a rule to be evaluated when pressing Enter. |
AdvSecEnablementOptions | |
AdvSecEnablementStatus | |
AdvSecEnablementUpdate | |
AssociatedWorkItem | |
AsyncGitOperationNotification | |
AsyncRefOperationCommitLevelEventNotification | |
AsyncRefOperationCompletedNotification | |
AsyncRefOperationConflictNotification | |
AsyncRefOperationGeneralFailureNotification | |
AsyncRefOperationProgressNotification | |
AsyncRefOperationTimeoutNotification | |
AutoCompleteUpdatedEvent |
Real time event (SignalR) for an auto-complete update on a pull request |
BillableCommitter |
Used by AdvSec to return billable committers. |
BillableCommitterDetail |
Used by AdvSec to return billable committers. |
BillablePusher |
Used by AdvSec to estimate billable pushers for a Host or Project. |
BranchUpdatedEvent |
Real time event (SignalR) for a source/target branch update on a pull request |
ChangeCountDictionary | |
ChangeList | |
ChangeListSearchCriteria |
Criteria used in a search for change lists |
CheckinNote | |
CommentIterationContext |
Comment iteration context is used to identify which diff was being viewed when the thread was created. |
CommentPosition | |
CommentThread |
Represents a comment thread of a pull request. A thread contains meta data about the file it was left on along with one or more comments (an initial comment and the subsequent replies). |
CommentThreadContext | |
CommentTrackingCriteria |
Comment tracking criteria is used to identify which iteration context the thread has been tracked to (if any) along with some detail about the original position and filename. |
CompletionErrorsEvent |
Real time event (SignalR) for a completion errors on a pull request |
DiscussionsUpdatedEvent |
Real time event (SignalR) for a discussions update on a pull request |
FileContentMetadata | |
FileDiff |
Provides properties that describe file differences |
FileDiffParams |
Provides parameters that describe inputs for the file diff |
FileDiffsCriteria |
Provides properties that describe inputs for the file diffs |
GitAnnotatedTag |
A Git annotated tag. |
GitAsyncRefOperation | |
GitAsyncRefOperationDetail |
Information about the progress of a cherry pick or revert operation. |
GitAsyncRefOperationParameters |
Parameters that are provided in the request body when requesting to cherry pick or revert. |
GitAsyncRefOperationSource |
GitAsyncRefOperationSource specifies the pull request or list of commits to use when making a cherry pick and revert operation request. Only one should be provided. |
GitBaseVersionDescriptor | |
GitBlobRef | |
GitBranchStats |
Ahead and behind counts for a particular ref. |
GitChange | |
GitCherryPick |
This object is returned from Cherry Pick operations and provides the id and status of the operation |
GitCommit |
Provides properties that describe a Git commit and associated metadata. |
GitCommitChanges | |
GitCommitDiffs | |
GitCommitRef |
Provides properties that describe a Git commit and associated metadata. |
GitCommitToCreate | |
GitConflict | |
GitConflictAddAdd |
Data object for AddAdd conflict |
GitConflictAddRename |
Data object for RenameAdd conflict |
GitConflictDeleteEdit |
Data object for EditDelete conflict |
GitConflictDeleteRename |
Data object for RenameDelete conflict |
GitConflictDirectoryFile |
Data object for FileDirectory conflict |
GitConflictEditDelete |
Data object for DeleteEdit conflict |
GitConflictEditEdit |
Data object for EditEdit conflict |
GitConflictFileDirectory |
Data object for DirectoryFile conflict |
GitConflictRename1to2 |
Data object for Rename1to2 conflict |
GitConflictRename2to1 |
Data object for Rename2to1 conflict |
GitConflictRenameAdd |
Data object for AddRename conflict |
GitConflictRenameDelete |
Data object for DeleteRename conflict |
GitConflictRenameRename |
Data object for RenameRename conflict |
GitConflictUpdateResult | |
GitDeletedRepository | |
GitFilePathsCollection | |
GitForkOperationStatusDetail |
Status information about a requested fork operation. |
GitForkRef |
Information about a fork ref. |
GitForkSyncRequest |
Request to sync data between two forks. |
GitForkSyncRequestParameters |
Parameters for creating a fork request |
GitForkTeamProjectReference |
Represents a shallow reference to a TeamProject. |
GitImportFailedEvent | |
GitImportGitSource |
Parameter for creating a git import request when source is Git version control |
GitImportRequest |
A request to import data from a remote source control system. |
GitImportRequestParameters |
Parameters for creating an import request |
GitImportStatusDetail |
Additional status information about an import request. |
GitImportSucceededEvent | |
GitImportTfvcSource |
Parameter for creating a git import request when source is tfvc version control |
GitItem | |
GitItemDescriptor | |
GitItemRequestData | |
GitLastChangeItem | |
GitLastChangeTreeItems | |
GitMerge |
Parameters required for performing git merge. |
GitMergeOperationStatusDetail |
Status information about a requested merge operation. |
GitMergeOriginRef | |
GitMergeParameters |
Parameters required for performing git merge. |
GitObject |
Git object identifier and type information. |
GitPathAction | |
GitPathToItemsCollection | |
GitPolicyConfigurationResponse | |
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. A thread contains meta data about the file it was left on (if any) along with one or more comments (an initial comment and the subsequent replies). |
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 |
Preferences about how the pull request should be completed. |
GitPullRequestIteration |
Provides properties that describe a Git pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request. |
GitPullRequestIterationChanges |
Collection of changes made in a pull request. |
GitPullRequestMergeOptions |
The options which are used when a pull request merge is created. |
GitPullRequestQuery |
A set of pull request queries and their results. |
GitPullRequestQueryInput |
Pull request query input parameters. |
GitPullRequestReviewFileContentInfo | |
GitPullRequestSearchCriteria |
Pull requests can be searched for matching this criteria. |
GitPullRequestStatus |
This class contains the metadata of a service/extension posting pull request status. Status can be associated with a pull request or an iteration. |
GitPush | |
GitPushEventData | |
GitPushRef | |
GitPushSearchCriteria | |
GitQueryBranchStatsCriteria | |
GitQueryCommitsCriteria | |
GitQueryRefsCriteria | |
GitRecycleBinRepositoryDetails | |
GitRef | |
GitRefFavorite | |
GitRefUpdate | |
GitRefUpdateResult | |
GitRepository | |
GitRepositoryCreateOptions | |
GitRepositoryRef | |
GitRepositoryStats | |
GitResolution | |
GitResolutionMergeContent | |
GitResolutionPathConflict | |
GitResolutionPickOneAction | |
GitResolutionRename1to2 | |
GitRevert | |
GitStatus |
This class contains the metadata of a service/extension posting a status. |
GitStatusContext |
Status context that uniquely identifies the status. |
GitSuggestion |
An object describing the git suggestion. Git suggestions are currently limited to suggested pull requests. |
GitTargetVersionDescriptor | |
GitTemplate | |
GitTreeDiff | |
GitTreeDiffEntry | |
GitTreeDiffResponse | |
GitTreeEntryRef | |
GitTreeRef | |
GitUserDate |
User info and date for Git operations. |
GitVersionDescriptor | |
GlobalGitRepositoryKey |
Globally unique key for a repository. |
HistoryEntry | |
IdentityRefWithVote |
Identity information including a vote on a pull request. |
ImportRepositoryValidation | |
IncludedGitCommit | |
IsDraftUpdatedEvent |
Real time event (SignalR) for IsDraft update on a pull request |
ItemContent | |
ItemDetailsOptions |
Optional details to include when returning an item model |
ItemModel | |
LabelsUpdatedEvent |
Real time event (SignalR) for updated labels on a pull request |
LineDiffBlock |
The class to represent the line diff block |
MergeCompletedEvent |
Real time event (SignalR) for a merge completed on a pull request |
PolicyEvaluationUpdatedEvent |
Real time event (SignalR) for a policy evaluation update on a pull request |
PullRequestCreatedEvent |
Real time event (SignalR) for pull request creation |
PullRequestTabExtensionConfig |
Initial config contract sent to extensions creating tabs on the pull request page |
RealTimePullRequestEvent |
Base contract for a real time pull request event (SignalR) |
RetargetEvent |
Real time event (SignalR) for when the target branch of a pull request is changed |
ReviewerVoteUpdatedEvent |
Real time event (SignalR) for a reviewer vote update on a pull request |
ReviewersUpdatedEvent |
Real time event (SignalR) for an update to reviewers on a pull request |
ReviewersVotesResetEvent |
Real time event (SignalR) for reviewer votes being reset on a pull request |
ShareNotificationContext |
Context used while sharing a pull request. |
SourceToTargetRef | |
StatusAddedEvent |
Real time event (SignalR) for an added status on a pull request |
StatusUpdatedEvent |
Real time event (SignalR) for a status update on a pull request |
StatusesDeletedEvent |
Real time event (SignalR) for deleted statuses on a pull request |
SupportedIde |
Represents a Supported IDE entity. |
TfvcBranch |
Class representing a branch object. |
TfvcBranchMapping |
A branch mapping. |
TfvcBranchRef |
Metadata for a branchref. |
TfvcChange |
A change. |
TfvcChangeset |
A collection of changes. |
TfvcChangesetRef |
Metadata for a changeset. |
TfvcChangesetSearchCriteria |
Criteria used in a search for change lists. |
TfvcChangesetsRequestData |
Request body for Get batched changesets. |
TfvcCheckinEventData | |
TfvcHistoryEntry | |
TfvcItem |
Metadata for an item. |
TfvcItemDescriptor |
Item path and Version descriptor properties |
TfvcItemPreviousHash |
Metadata for an item including the previous hash value for files. |
TfvcItemRequestData |
Request body used by Get Items Batch |
TfvcLabel |
Metadata for a label. |
TfvcLabelRef |
Metadata for a Label. |
TfvcLabelRequestData | |
TfvcMappingFilter |
MappingFilter can be used to include or exclude specific paths. |
TfvcMergeSource | |
TfvcPolicyFailureInfo |
Policy failure information. |
TfvcPolicyOverrideInfo |
Information on the policy override. |
TfvcShallowBranchRef |
This is the shallow branchref class. |
TfvcShelveset |
Metadata for a shelveset. |
TfvcShelvesetRef |
Metadata for a shallow shelveset. |
TfvcShelvesetRequestData | |
TfvcStatistics | |
TfvcVersionDescriptor |
Version descriptor properties. |
TitleDescriptionUpdatedEvent |
Real time event (SignalR) for a title/description update on a pull request |
UpdateRefsRequest | |
VersionControlProjectInfo | |
IVersionControlRepositoryService |
Host service for accessing repository information. |
AadGraphMember |
Top-level graph entity |
GraphCachePolicies | |
GraphDescriptorResult |
Subject descriptor of a Graph entity |
GraphFederatedProviderData |
Represents a set of data used to communicate with a federated provider on behalf of a particular user. |
GraphGlobalExtendedPropertyBatch | |
GraphGroup |
Graph group entity |
GraphGroupCreationContext |
Do not attempt to use this type to create a new group. This type does not contain sufficient fields to create a new group. |
GraphGroupMailAddressCreationContext |
Use this type to create a new group using the mail address as a reference to an existing group from an external AD or AAD backed provider. This is the subset of GraphGroup fields required for creation of a group for the AAD and AD use case. |
GraphGroupOriginIdCreationContext |
Use this type to create a new group using the OriginID as a reference to an existing group from an external AD or AAD backed provider. This is the subset of GraphGroup fields required for creation of a group for the AD and AAD use case. |
GraphGroupVstsCreationContext |
Use this type to create a new Vsts group that is not backed by an external provider. |
GraphMember |
Top-level graph entity |
GraphMembership |
Relationship between a container and a member |
GraphMembershipState |
Status of a Graph membership (active/inactive) |
GraphMembershipTraversal | |
GraphProviderInfo |
Who is the provider for this user and what is the identifier and domain that is used to uniquely identify the user. |
GraphScope |
Container where a graph entity is defined (organization, project, team) |
GraphScopeCreationContext |
This type is the subset of fields that can be provided by the user to create a Vsts scope. Scope creation is currently limited to internal back-compat scenarios. End users that attempt to create a scope with this API will fail. |
GraphServicePrincipal |
Top-level graph entity |
GraphServicePrincipalCreationContext |
Do not attempt to use this type to create a new service principal. Use one of the subclasses instead. This type does not contain sufficient fields to create a new service principal. |
GraphServicePrincipalOriginIdCreationContext |
Use this type to create a new service principal using the OriginID as a reference to an existing service principal from an external AAD backed provider. This is the subset of GraphServicePrincipal fields required for creation of a GraphServicePrincipal for the AAD use case when looking up the service principal by its unique ID in the backing provider. |
GraphServicePrincipalOriginIdUpdateContext |
Use this type to update an existing service principal using the OriginID as a reference to an existing service principal from an external AAD backed provider. This is the subset of GraphServicePrincipal fields required for creation of a GraphServicePrincipal for AAD use case when looking up the service principal by its unique ID in the backing provider. |
GraphServicePrincipalUpdateContext |
Do not attempt to use this type to update service principal. Use one of the subclasses instead. This type does not contain sufficient fields to create a new service principal. |
GraphStorageKeyResult |
Storage key of a Graph entity |
GraphSubject |
Top-level graph entity |
GraphSubjectBase | |
GraphSubjectLookup |
Batching of subjects to lookup using the Graph API |
GraphSubjectLookupKey | |
GraphSubjectQuery |
Subject to search using the Graph API |
GraphSystemSubject |
Top-level graph entity |
GraphUser |
Top-level graph entity |
GraphUserCreationContext |
Do not attempt to use this type to create a new user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user. |
GraphUserMailAddressCreationContext |
Use this type to create a new user using the mail address as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its mail address in the backing provider. |
GraphUserOriginIdCreationContext |
Use this type to create a new user using the OriginID as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its unique ID in the backing provider. |
GraphUserOriginIdUpdateContext |
Use this type to update an existing user using the OriginID as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its unique ID in the backing provider. |
GraphUserPrincipalNameCreationContext |
Use this type to create a new user using the principal name as a reference to an existing user from an external AD or AAD backed provider. This is the subset of GraphUser fields required for creation of a GraphUser for the AD and AAD use case when looking up the user by its principal name in the backing provider. |
GraphUserPrincipalNameUpdateContext |
Use this type for transfering identity rights, for instance after performing a Tenant switch. |
GraphUserUpdateContext |
Do not attempt to use this type to update user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user. |
IdentityMapping | |
IdentityMappings | |
MappingResult | |
PagedGraphGroups | |
PagedGraphMembers | |
PagedGraphServicePrincipals | |
PagedGraphUsers | |
RequestAccessPayLoad | |
ResolveDisconnectedUsersResponse | |
UserPrincipalName | |
ChangedIdentities |
Container class for changed identities |
ChangedIdentitiesContext |
Context class for changed identities |
CreateScopeInfo | |
FrameworkIdentityInfo | |
GroupMembership | |
Identity |
Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties |
IdentityBase |
Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties |
IdentityBatchInfo | |
IdentityDescriptor |
An Identity descriptor is a wrapper for the identity type (Windows SID, Passport) along with a unique identifier such as the SID or PUID. |
IdentityRightsTransferData | |
IdentityScope | |
IdentitySelf |
Identity information. |
IdentitySnapshot | |
IdentityUpdateData | |
PagedIdentities | |
SwapIdentityInfo | |
TenantInfo | |
IPeoplePickerProvider | |
IIdentity | |
IVssIdentityService | |
IdentitiesGetConnectionsResponseModel | |
IdentitiesSearchRequestModel | |
AccessMapping | |
ConnectionData |
Data transfer class that holds information needed to set up a connection with a VSS server. |
LocationMapping | |
LocationServiceData |
Data transfer class used to transfer data about the location service data over the web service. |
ResourceAreaInfo | |
ServiceDefinition | |
AdvSecEnablementFeatures | |
AdvSecEnablementSettings | |
AdvSecEnablementSettingsUpdate | |
AdvSecEnablementStatusUpdate | |
BillableCommitterDetails |
Billable Committers Details for Advanced Security Services |
BilledCommitter |
Information related to billed committers using Advanced Security services |
MeterUsage |
Information related to billing for Advanced Security services |
ActorFilter | |
ActorNotificationReason | |
ArtifactFilter | |
BaseSubscriptionFilter | |
BatchNotificationOperation | |
BlockFilter | |
BlockSubscriptionChannel | |
DiagnosticIdentity | |
DiagnosticNotification | |
DiagnosticRecipient | |
EmailHtmlSubscriptionChannel | |
EmailPlaintextSubscriptionChannel | |
EventBacklogStatus | |
EventBatch | |
EventProcessingLog |
Abstract base class for all of the diagnostic logs. |
EventTransformRequest |
A transform request specify the properties of a notification event to be transformed. |
EventTransformResult |
Result of transforming a notification event. |
EventsEvaluationResult |
Encapsulates events result properties. It defines the total number of events used and the number of matched events. |
ExpressionFilter | |
ExpressionFilterClause |
Subscription Filter Clause represents a single clause in a subscription filter e.g. If the subscription has the following criteria "Project Name = [Current Project] AND Assigned To = [Me] it will be represented as two Filter Clauses Clause 1: Index = 1, Logical Operator: NULL , FieldName = 'Project Name', Operator = '=', Value = '[Current Project]' Clause 2: Index = 2, Logical Operator: 'AND' , FieldName = 'Assigned To' , Operator = '=', Value = '[Me]' |
ExpressionFilterGroup |
Represents a hierarchy of SubscritionFilterClauses that have been grouped together through either adding a group in the WebUI or using parethesis in the Subscription condition string |
ExpressionFilterModel |
This class represents the Subscription Filter associated with a subscription in a user readable format e.g. "filterModel":{ "clauses":[ { "logicalOperator":"", "fieldName":"PortfolioProject", "operator":"=", "value":"@@MyProjectName@@", "index":1 } ], "groups":[ ], "maxGroupLevel":0 } |
FieldInputValues |
Information about the possible/allowed values for a given subscription input |
FieldValuesQuery | |
GeneratedNotification | |
GroupSubscriptionChannel | |
INotificationDiagnosticLog |
Abstraction interface for the diagnostic log. Primarily for deserialization. |
ISubscriptionChannel | |
ISubscriptionFilter | |
MatcherResult | |
MessageQueueSubscriptionChannel | |
NotificationAdminSettings | |
NotificationAdminSettingsUpdateParameters | |
NotificationBacklogStatus | |
NotificationBatch | |
NotificationDeliveryLog |
Abstract base class for all of the diagnostic logs. |
NotificationDiagnosticLog |
Abstract base class for all of the diagnostic logs. |
NotificationDiagnosticLogMessage | |
NotificationEventBacklogStatus | |
NotificationEventField |
Encapsulates the properties of a filterable field. A filterable field is a field in an event that can used to filter notifications for a certain event type. |
NotificationEventFieldOperator |
Encapsulates the properties of a field type. It includes a unique id for the operator and a localized string for display name |
NotificationEventFieldType |
Encapsulates the properties of a field type. It describes the data type of a field, the operators it support and how to populate it in the UI |
NotificationEventPublisher |
Encapsulates the properties of a notification event publisher. |
NotificationEventRole |
Encapsulates the properties of an event role. An event Role is used for role based subscription for example for a buildCompletedEvent, one role is request by field |
NotificationEventType |
Encapsulates the properties of an event type. It defines the fields, that can be used for filtering, for that event type. |
NotificationEventTypeCategory |
Encapsulates the properties of a category. A category will be used by the UI to group event types |
NotificationJobDiagnosticLog |
Abstract base class for all of the diagnostic logs. |
NotificationQueryCondition | |
NotificationReason | |
NotificationStatistic | |
NotificationStatisticsQuery | |
NotificationStatisticsQueryConditions | |
NotificationSubscriber |
A subscriber is a user or group that has the potential to receive notifications. |
NotificationSubscriberUpdateParameters |
Updates to a subscriber. Typically used to change (or set) a preferred email address or default delivery preference. |
NotificationSubscription |
A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. |
NotificationSubscriptionCreateParameters |
Parameters for creating a new subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. |
NotificationSubscriptionTemplate | |
NotificationSubscriptionUpdateParameters |
Parameters for updating an existing subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. Note: only the fields to be updated should be set. |
NotificationsEvaluationResult |
Encapsulates notifications result properties. It defines the number of notifications and the recipients of notifications. |
OperatorConstraint |
Encapsulates the properties of an operator constraint. An operator constraint defines if some operator is available only for specific scope like a project scope. |
ProcessedEvent | |
ProcessingDiagnosticIdentity | |
ProcessingIdentities | |
RoleBasedFilter | |
ServiceBusSubscriptionChannel | |
ServiceHooksSubscriptionChannel | |
SoapSubscriptionChannel | |
SubscriptionAdminSettings |
Admin-managed settings for a group subscription. |
SubscriptionChannelWithAddress | |
SubscriptionDiagnostics |
Contains all the diagnostics settings for a subscription. |
SubscriptionEvaluation | |
SubscriptionEvaluationClause | |
SubscriptionEvaluationRequest |
Encapsulates the properties of a SubscriptionEvaluationRequest. It defines the subscription to be evaluated and time interval for events used in evaluation. |
SubscriptionEvaluationResult |
Encapsulates the subscription evaluation results. It defines the Date Interval that was used, number of events evaluated and events and notifications results |
SubscriptionEvaluationSettings |
Encapsulates the subscription evaluation settings needed for the UI |
SubscriptionManagement |
Encapsulates the properties needed to manage subscriptions, opt in and out of subscriptions. |
SubscriptionQuery |
Notification subscriptions query input. |
SubscriptionQueryCondition |
Conditions a subscription must match to qualify for the query result set. Not all fields are required. A subscription must match all conditions specified in order to qualify for the result set. |
SubscriptionScope |
A resource, typically an account or project, in which events are published from. |
SubscriptionTraceDiagnosticLog |
Abstract base class for all of the diagnostic logs. |
SubscriptionTraceEventProcessingLog |
Abstract base class for all of the diagnostic logs. |
SubscriptionTraceNotificationDeliveryLog |
Abstract base class for all of the diagnostic logs. |
SubscriptionTracing |
Data controlling a single diagnostic setting for a subscription. |
SubscriptionUserSettings |
User-managed settings for a group subscription. |
UnsupportedFilter | |
UnsupportedSubscriptionChannel | |
UpdateSubscripitonDiagnosticsParameters |
Parameters to update diagnostics settings for a subscription. |
UpdateSubscripitonTracingParameters |
Parameters to update a specific diagnostic setting. |
UserSubscriptionChannel | |
UserSystemSubscriptionChannel | |
ValueDefinition |
Encapsulates the properties of a field value definition. It has the information needed to retrieve the list of possible values for a certain field and how to handle that field values in the UI. This information includes what type of object this value represents, which property to use for UI display and which property to use for saving the subscription |
OperationReference |
Reference for an async operation. |
OperationResultReference | |
Artifact | |
BuildResourceParameters | |
Container | |
ContainerResource | |
ContainerResourceParameters | |
CreatePipelineConfigurationParameters |
Configuration parameters of the pipeline. |
CreatePipelineParameters |
Parameters to create a pipeline. |
Log |
Log for a pipeline. |
LogCollection |
A collection of logs. |
PackageResourceParameters | |
PipelineBase | |
PipelineConfiguration | |
PipelineReference |
Pipeline reference |
PipelineResource | |
PipelineResourceParameters | |
PreviewRun | |
Repository | |
RepositoryResource | |
RepositoryResourceParameters | |
Run | |
RunPipelineParameters |
Settings which influence pipeline runs. |
RunReference | |
RunResources | |
RunResourcesParameters | |
RunYamlDetails | |
SignalRConnection | |
Variable | |
YamlFileDetails | |
PolicyConfiguration |
The full policy configuration with settings. |
PolicyConfigurationRef |
Policy configuration reference. |
PolicyEvaluationRecord |
This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to. |
PolicyType |
User-friendly policy type with description (used for querying policy types). |
PolicyTypeRef |
Policy type reference. |
VersionedPolicyConfigurationRef |
A particular revision for a policy configuration. |
AttributeDescriptor |
Identifies an attribute with a name and a container. |
AttributesContainer |
Stores a set of named profile attributes. |
Avatar | |
CoreProfileAttribute |
A profile attribute which always has a value for each profile. |
CreateProfileContext | |
GeoRegion | |
Profile |
A user profile. |
ProfileAttribute |
A named object associated with a profile. |
ProfileAttributeBase | |
ProfileRegion |
Country/region information |
ProfileRegions |
Container of country/region information |
AnalyzerDescriptor | |
CodeChangeTrendItem | |
LanguageMetricsSecuredObject | |
LanguageStatistics | |
ProjectActivityMetrics | |
ProjectLanguageAnalytics | |
RepositoryActivityMetrics | |
RepositoryLanguageAnalytics | |
AgentArtifactDefinition | |
AgentBasedDeployPhase | |
AgentDeploymentInput | |
ApprovalOptions | |
ArtifactContributionDefinition | |
ArtifactDownloadInputBase | |
ArtifactInstanceData | |
ArtifactMetadata | |
ArtifactProvider | |
ArtifactSourceId | |
ArtifactSourceIdsQueryResult | |
ArtifactSourceReference | |
ArtifactSourceTrigger | |
ArtifactTriggerConfiguration | |
ArtifactTypeDefinition | |
ArtifactVersion | |
ArtifactVersionQueryResult | |
ArtifactsDownloadInput | |
AutoTriggerIssue | |
AzureKeyVaultVariableGroupProviderData |
Defines provider data of the variable group. |
AzureKeyVaultVariableValue |
A wrapper class for a generic variable. |
BaseDeploymentInput | |
BuildArtifactDownloadInput | |
BuildVersion | |
CheckConfigurationReference | |
CheckConfigurationResource | |
CodeRepositoryReference | |
ComplianceSettings | |
Condition | |
ConfigurationVariableValue | |
Consumer |
Defines the data contract of a consumer. |
ContainerImageTrigger | |
ContinuousDeploymentTriggerIssue | |
ControlOptions | |
CustomArtifactDownloadInput | |
DataSourceBinding |
Represents binding of data source for the service endpoint request. |
DefinitionEnvironmentReference | |
DeployPhase | |
DeploymentApprovalCompletedEvent | |
DeploymentApprovalPendingEvent | |
DeploymentAttempt | |
DeploymentAuthorizationInfo | |
DeploymentCompletedEvent | |
DeploymentEvent | |
DeploymentInput | |
DeploymentJob | |
DeploymentManualInterventionPendingEvent | |
DeploymentQueryParameters | |
DeploymentStartedEvent | |
EmailRecipients | |
EnvironmentExecutionPolicy |
Defines policy on environment queuing at Release Management side queue. We will send to Environment Runner [creating pre-deploy and other steps] only when the policies mentioned are satisfied. |
EnvironmentOptions | |
EnvironmentRetentionPolicy | |
EnvironmentTrigger | |
EnvironmentTriggerContent | |
ExecutionInput | |
FavoriteItem |
Class to represent favorite entry. |
GateUpdateMetadata | |
GatesDeployPhase | |
GatesDeploymentInput | |
GitArtifactDownloadInput | |
GitHubArtifactDownloadInput | |
IgnoredGate | |
JenkinsArtifactDownloadInput | |
MachineGroupBasedDeployPhase | |
MachineGroupDeploymentInput | |
MailMessage | |
ManualIntervention | |
ManualInterventionUpdateMetadata | |
Metric | |
MultiConfigInput | |
MultiMachineInput | |
OrgPipelineReleaseSettings | |
OrgPipelineReleaseSettingsUpdateParameters | |
PackageTrigger | |
ParallelExecutionInputBase | |
PipelineProcess | |
ProjectPipelineReleaseSettings | |
ProjectPipelineReleaseSettingsUpdateParameters | |
ProjectReference |
Defines the project reference class. |
ProofOfPresenceTenant | |
PropertySelector | |
PullRequestConfiguration | |
PullRequestFilter | |
QueuedReleaseData | |
RealtimeReleaseDefinitionEvent | |
RealtimeReleaseEvent | |
Release | |
ReleaseAbandonedEvent | |
ReleaseApproval | |
ReleaseApprovalHistory | |
ReleaseApprovalPendingEvent | |
ReleaseArtifact | |
ReleaseCondition | |
ReleaseCreatedEvent | |
ReleaseDefinition | |
ReleaseDefinitionApprovalStep | |
ReleaseDefinitionApprovals | |
ReleaseDefinitionDeployStep | |
ReleaseDefinitionEnvironment | |
ReleaseDefinitionEnvironmentStep | |
ReleaseDefinitionEnvironmentSummary | |
ReleaseDefinitionEnvironmentTemplate | |
ReleaseDefinitionGate | |
ReleaseDefinitionGatesOptions | |
ReleaseDefinitionGatesStep | |
ReleaseDefinitionRevision | |
ReleaseDefinitionShallowReference | |
ReleaseDefinitionSummary | |
ReleaseDefinitionUndeleteParameter | |
ReleaseDeployPhase | |
ReleaseEnvironment | |
ReleaseEnvironmentCompletedEvent | |
ReleaseEnvironmentShallowReference | |
ReleaseEnvironmentStatusUpdatedEvent | |
ReleaseEnvironmentUpdateMetadata | |
ReleaseEvent | |
ReleaseGates | |
ReleaseGatesPhase | |
ReleaseManagementInputValue | |
ReleaseNotCreatedEvent | |
ReleaseReference |
Reference to a release. |
ReleaseRevision | |
ReleaseSchedule | |
ReleaseSettings | |
ReleaseShallowReference | |
ReleaseStartEnvironmentMetadata | |
ReleaseStartMetadata | |
ReleaseTask | |
ReleaseTaskAttachment | |
ReleaseTaskLogUpdatedEvent | |
ReleaseTasksUpdatedEvent | |
ReleaseTriggerBase | |
ReleaseUpdateMetadata | |
ReleaseUpdatedEvent | |
ReleaseWorkItemRef | |
RetentionSettings | |
RunOnServerDeployPhase | |
ScheduledReleaseTrigger | |
ServerDeploymentInput | |
SourceIdInput | |
SourcePullRequestVersion | |
SourceRepoTrigger | |
SummaryMailSection | |
TagFilter | |
TfvcArtifactDownloadInput | |
TimeZone | |
TimeZoneList | |
VariableGroupProjectReference |
A variable group reference is a shallow reference to variable group. |
VariableGroupProviderData |
Defines provider data of the variable group. |
VariableValue |
A wrapper class for a generic variable. |
WorkflowTask | |
WorkflowTaskReference | |
YamlFileSource | |
YamlPipelineProcess | |
YamlPipelineProcessResources | |
YamlSourceReference | |
Usage |
Represents usage data that includes a count and a limit for a specific aspect. |
AadOauthTokenRequest | |
AadOauthTokenResult | |
AuthConfiguration | |
AuthenticationSchemeReference | |
AzureAppService | |
AzureKeyVaultPermission | |
AzureMLWorkspace | |
AzureManagedIdentity | |
AzureManagementGroup |
Azure Management Group |
AzureManagementGroupQueryResult |
Azure management group query result |
AzurePermission | |
AzureResourcePermission | |
AzureRoleAssignmentPermission | |
AzureSpnOperationStatus | |
AzureSubscription | |
AzureSubscriptionQueryResult | |
ClientCertificate | |
DataSource | |
DataSourceDetails | |
DependencyBinding | |
DependencyData | |
DependsOn | |
EndpointAuthorization | |
EndpointOperationStatus | |
EndpointUrl |
Represents url of the service endpoint. |
HelpLink | |
OAuth2TokenResult | |
OAuthConfiguration | |
OAuthConfigurationParams | |
OAuthEndpointStatus | |
Parameter | |
RefreshAuthenticationParameters |
Specify the properties for refreshing the endpoint authentication object being queried |
ResultTransformationDetails | |
ServiceEndpoint |
Represents an endpoint which may be used by an orchestration job. |
ServiceEndpointAuthenticationScheme | |
ServiceEndpointDetails | |
ServiceEndpointEvent | |
ServiceEndpointExecutionData |
Represents service endpoint execution data. |
ServiceEndpointExecutionOwner |
Represents execution owner of the service endpoint. |
ServiceEndpointExecutionRecord | |
ServiceEndpointExecutionRecordsInput | |
ServiceEndpointOAuthConfigurationReference | |
ServiceEndpointProjectReference | |
ServiceEndpointRequest | |
ServiceEndpointRequestResult | |
ServiceEndpointTokenResult |
Represents the details of service endpoint execution. |
ServiceEndpointType |
Represents type of the service endpoint. |
ConsumerAction |
Defines the data contract of a consumer action. |
Event |
Encapsulates the properties of an event. |
EventTypeDescriptor |
Describes a type of event |
ExternalConfigurationDescriptor |
Describes how to configure a subscription that is managed externally. |
FormattedEventMessage |
Provides different formats of an event message |
Notification |
Defines the data contract of the result of processing an event for a subscription. |
NotificationDetails |
Defines the data contract of notification details. |
NotificationResultsSummaryDetail |
Summary of a particular result and count. |
NotificationSummary |
Summary of the notifications for a subscription. |
NotificationsQuery |
Defines a query for service hook notifications. |
PublisherEvent |
Wrapper around an event which is being published |
PublishersQuery |
Defines a query for service hook publishers. |
ResourceContainer |
The base class for all resource containers, i.e. Account, Collection, Project |
SessionToken |
Represents a session token to be attached in Events for Consumer actions that need it. |
Subscription |
Encapsulates an event subscription. |
SubscriptionInputValuesQuery |
Query for obtaining information about the possible/allowed values for one or more subscription inputs |
SubscriptionsQuery |
Defines a query for service hook subscriptions. |
VersionedResource |
Encapsulates the resource version and its data or reference to the compatible version. Only one of the two last fields should be not null. |
AgentChangeEvent | |
AgentJobRequestMessage | |
AgentPoolEvent | |
AgentQueueEvent | |
AgentQueueServiceHookEvent | |
AgentQueuesEvent | |
AgentRefreshMessage | |
CounterVariable | |
DemandEquals | |
DemandExists | |
DemandMinimumVersion | |
DemandSource | |
DeploymentGatesChangeEvent | |
DeploymentGroup |
Deployment group. |
DeploymentGroupCreateParameter |
Properties to create Deployment group. |
DeploymentGroupCreateParameterPoolProperty |
Properties of Deployment pool to create Deployment group. |
DeploymentGroupMetrics |
Deployment group metrics. |
DeploymentGroupReference |
Deployment group reference. This is useful for referring a deployment group in another object. |
DeploymentGroupUpdateParameter |
Deployment group update parameter. |
DeploymentMachine |
Deployment target. |
DeploymentMachineChangedData |
Deployment target. |
DeploymentMachineGroup | |
DeploymentMachineGroupReference | |
DeploymentMachinesChangeEvent | |
DeploymentPoolSummary |
Deployment pool summary. |
DeploymentTargetUpdateParameter |
Deployment target update parameter. |
DiagnosticLogMetadata | |
ElasticAgentPoolResizedEvent | |
ElasticNode |
Data and settings for an elastic node |
ElasticNodeSettings |
Class used for updating an elastic node where only certain members are populated |
ElasticPool |
Data and settings for an elastic pool |
ElasticPoolCreationResult |
Returned result from creating a new elastic pool |
ElasticPoolLog |
Log data for an Elastic Pool |
ElasticPoolSettings |
Class used for updating an elastic pool where only certain members are populated |
EnvironmentCreateParameter |
Properties to create Environment. |
EnvironmentDeploymentExecutionRecord |
EnvironmentDeploymentExecutionRecord. |
EnvironmentInstance |
Environment. |
EnvironmentLinkedResourceReference |
EnvironmentLinkedResourceReference. |
EnvironmentReference | |
EnvironmentResource | |
EnvironmentResourceDeploymentExecutionRecord |
EnvironmentResourceDeploymentExecutionRecord. |
EnvironmentResourceReference |
EnvironmentResourceReference. |
EnvironmentUpdateParameter |
Properties to update Environment. |
EventsConfig | |
ExpressionValidationItem | |
InputBindingContext | |
InputValidationItem | |
InputValidationRequest | |
JobAssignedEvent |
A pipeline job event to be processed by the execution plan. |
JobCancelMessage | |
JobCanceledEvent |
A pipeline job event to be processed by the execution plan. |
JobCompletedEvent |
A pipeline job event to be processed by the execution plan. |
JobEnvironment |
Represents the context of variables and vectors for a job request. |
JobEvent |
A pipeline job event to be processed by the execution plan. |
JobEventConfig | |
JobEventsConfig | |
JobMetadataEvent |
A pipeline job event to be processed by the execution plan. |
JobMetadataMessage |
A message to be sent to an agent currently running the job. |
JobOption |
Represents an option that may affect the way an agent runs the job. |
JobRequestMessage | |
JobStartedEvent |
A pipeline job event to be processed by the execution plan. |
KubernetesResource | |
KubernetesResourceCreateParameters | |
KubernetesResourceCreateParametersExistingEndpoint | |
KubernetesResourceCreateParametersNewEndpoint | |
KubernetesResourcePatchParameters | |
MarketplacePurchasedLicense |
Represents a purchase of resource units in a secondary marketplace. |
MaskHint | |
MetricsColumnMetaData |
Meta data for a metrics column. |
MetricsColumnsHeader |
Metrics columns header |
MetricsRow |
Metrics row. |
PackageMetadata |
Represents a downloadable package. |
PackageVersion | |
PlanEnvironment | |
PublishTaskGroupMetadata | |
ResourceFilterOptions | |
ResourceFilters | |
ResourceItem |
Resources include Service Connections, Variable Groups and Secure Files. |
ResourceLimit | |
ResourceLockRequest |
A request for a resource's exclusive lock |
ResourceUsage | |
ResourcesHubData | |
SecureFile | |
SecureFileEvent | |
SendJobResponse | |
ServerExecutionDefinition | |
ServerTaskRequestMessage | |
TaskAgent |
A task agent. |
TaskAgentAuthorization |
Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows. |
TaskAgentCloud | |
TaskAgentCloudRequest | |
TaskAgentCloudType | |
TaskAgentDowngrade | |
TaskAgentJob | |
TaskAgentJobRequest |
A job request for an agent. |
TaskAgentJobStep | |
TaskAgentJobTask | |
TaskAgentJobVariable | |
TaskAgentManualUpdate | |
TaskAgentMessage |
Provides a contract for receiving messages from the task orchestrator. |
TaskAgentMinAgentVersionRequiredUpdate | |
TaskAgentPool |
An organization-level grouping of agents. |
TaskAgentPoolMaintenanceDefinition | |
TaskAgentPoolMaintenanceJob | |
TaskAgentPoolMaintenanceJobTargetAgent | |
TaskAgentPoolMaintenanceOptions | |
TaskAgentPoolMaintenanceRetentionPolicy | |
TaskAgentPoolMaintenanceSchedule | |
TaskAgentPoolStatus | |
TaskAgentPoolSummary | |
TaskAgentPublicKey |
Represents the public key portion of an RSA asymmetric key. |
TaskAgentQueue |
An agent queue. |
TaskAgentReference |
A reference to an agent. |
TaskAgentSession |
Represents a session for performing message exchanges from an agent. |
TaskAgentSessionKey |
Represents a symmetric key used for message-level encryption for communication sent to an agent. |
TaskAgentUpdate |
Details about an agent update. |
TaskAgentUpdateReason | |
TaskAssignedEvent |
A pipeline job event to be processed by the execution plan. |
TaskAttachment | |
TaskCommandRestrictions | |
TaskCompletedEvent |
A pipeline job event to be processed by the execution plan. |
TaskDefinition | |
TaskDefinitionEndpoint | |
TaskEvent |
A pipeline job event to be processed by the execution plan. |
TaskExecution | |
TaskGroup | |
TaskGroupCreateParameter | |
TaskGroupDefinition | |
TaskGroupPublishPreviewParameter | |
TaskGroupRestoreParameter | |
TaskGroupRevision | |
TaskGroupStep |
Represents tasks in the task group. |
TaskGroupUpdateParameter | |
TaskGroupUpdatePropertiesBase | |
TaskHubLicenseDetails | |
TaskHubOidcToken | |
TaskInputDefinition | |
TaskInstance |
A reference to a task. |
TaskLog |
A task log connected to a timeline record. |
TaskLogReference |
A reference to a task log. This class contains information about the output printed to the timeline record's logs console during pipeline run. |
TaskOrchestrationContainer | |
TaskOrchestrationItem | |
TaskOrchestrationJob | |
TaskOrchestrationOwner | |
TaskOrchestrationPlan | |
TaskOrchestrationPlanGroup | |
TaskOrchestrationPlanGroupsQueueMetrics | |
TaskOrchestrationQueuedPlan | |
TaskOrchestrationQueuedPlanGroup | |
TaskOutputVariable | |
TaskPackageMetadata | |
TaskRestrictions | |
TaskSourceDefinition | |
TaskStartedEvent |
A pipeline job event to be processed by the execution plan. |
TaskVariableRestrictions | |
TaskVersion | |
TimelineRecordFeedLinesWrapper | |
TimelineRecordReference |
A reference to a timeline record. |
ValidationItem | |
VariableGroupParameters | |
VirtualMachine | |
VirtualMachineGroup | |
VirtualMachineGroupCreateParameters | |
VirtualMachineResource | |
VirtualMachineResourceCreateParameters | |
AbortTestRunRequest | |
AfnStrip | |
AggregatedDataForResultTrend | |
AggregatedResultDetailsByOutcome |
Result deatils for a particular test result outcome. |
AggregatedResultsAnalysis | |
AggregatedResultsByOutcome | |
AggregatedResultsDifference | |
AggregatedRunsByOutcome | |
AggregatedRunsByState | |
AnalysisFailureGroupReturn | |
BatchResponse | |
BranchCoverage | |
BuildConfiguration |
BuildConfiguration Details. |
BuildCoverage |
Build Coverage Detail |
BuildReference2 | |
BulkResultUpdateRequest | |
CloneOperationInformation |
Detail About Clone Operation. |
CloneOptions |
Clone options for cloning the test suite. |
CloneStatistics |
Clone Statistics Details. |
CloneTestCaseOptions | |
CodeCoverageData |
Represents the build configuration (platform, flavor) and coverage data for the build |
CodeCoverageStatistics |
Represents the code coverage statistics for a particular coverage label (modules, statements, blocks, etc.) |
CodeCoverageSummary |
Represents the code coverage summary results Used to publish or retrieve code coverage summary against a build |
CodeCoverageSummary2 | |
Coverage2 | |
CoverageStatistics | |
CreateTestMessageLogEntryRequest | |
CreateTestResultsRequest | |
CreateTestRunRequest | |
CustomTestField |
A custom field information. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool) |
CustomTestFieldDefinition |
Data structure which stores details for the customTestFields to be updated |
CustomTestFieldUpdateDefinition |
Data structure which stores details for the customTestField to be updated. |
DatedTestFieldData | |
DefaultAfnStripBinding | |
DeleteTestRunRequest | |
DownloadAttachmentsRequest | |
DtlEnvironmentDetails |
This is a temporary class to provide the details for the test run environment. |
FailingSince |
Failing since information of a test result. |
FetchTestResultsRequest | |
FetchTestResultsResponse | |
FieldDetailsForTestResults | |
FileCoverage | |
FileCoverageData | |
FileCoverageRequest | |
FilterPointQuery | |
FlakyDetection | |
FlakyDetectionPipelines | |
FlakySettings | |
FolderCoverageData | |
FunctionCoverage | |
FunctionCoverage2 | |
HttpPostedTcmAttachment | |
JobReference |
Job in pipeline. This is related to matrixing in YAML. |
LastResultDetails |
Last result details of test point. |
LegacyBuildConfiguration | |
LegacyReleaseReference | |
LegacyTestCaseResult | |
LegacyTestCaseResultIdentifier | |
LegacyTestRun | |
LegacyTestRunStatistic | |
LegacyTestSettings | |
LineBlockCoverage | |
Link |
Link description. |
LinkedWorkItemsQuery | |
LinkedWorkItemsQueryResult | |
Machine |
Computer which ran tests in the session |
ModuleCoverage | |
ModuleCoverage2 | |
NameValuePair |
Name value pair |
NewTestResultLoggingSettings | |
PhaseReference |
Phase in pipeline |
PipelineTestMetrics |
Test summary of a pipeline instance. |
PlanUpdateModel |
A model class used for creating and updating test plans. |
PointAssignment |
Assignments for the Test Point |
PointLastResult | |
PointUpdateModel |
Model to update test point. |
PointWorkItemProperty |
Test point workitem property. |
PointsFilter |
Filter class for test point. |
PointsReference2 | |
PointsResults2 | |
PropertyBag |
The class to represent a Generic store for test session data. |
QueryByPointRequest | |
QueryByRunRequest | |
QueryModel | |
QueryTestActionResultRequest | |
QueryTestActionResultResponse | |
QueryTestMessageLogEntryRequest | |
QueryTestRunStatsRequest | |
QueryTestRuns2Request | |
QueryTestRunsRequest | |
ReleaseEnvironmentDefinitionReference |
Reference to release environment resource. |
ReleaseReference2 | |
RequirementsToTestsMapping2 | |
ResetTestResultsRequest | |
ResultRetentionSettings |
Test result retention settings |
ResultSummary |
Summary of results for a pipeline instance. |
ResultUpdateRequest | |
ResultUpdateRequestModel | |
ResultUpdateResponse | |
ResultUpdateResponseModel | |
ResultsAnalysis |
Results insights for runs with state completed and NeedInvestigation. |
ResultsByQueryRequest | |
ResultsByQueryResponse | |
ResultsFilter | |
ResultsStoreQuery | |
ResultsSummaryByOutcome |
Result summary by the outcome of test results. |
RunCreateModel |
Test run create details. |
RunFilter |
This class is used to provide the filters used for discovery |
RunStatistic |
Test run statistics per outcome. |
RunSummary |
Summary of runs for a pipeline instance. |
RunSummaryModel |
Run summary for each output type of test. |
RunUpdateModel | |
SessionEnvironmentAndMachine |
Container class for TestSessionEnvironment and Machine objects related to a test session |
SessionSourcePipeline |
SessionSourcePipeline |
ShallowReference |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
ShallowTestCaseResult | |
SharedStepModel |
Reference to shared step workitem. |
Source |
Session source |
SourceViewBuildCoverage | |
StageReference |
Stage in pipeline |
SuiteCreateModel |
Suite create model |
SuiteEntry |
A suite entry defines properties for a test suite. |
SuiteEntryUpdateModel |
A model to define sequence of test suite entries in a test suite. |
SuiteTestCase |
Test case for the suite. |
SuiteTestCaseUpdateModel |
Test suite update model. |
SuiteUpdateModel |
Test suite update model. |
TCMPropertyBag2 | |
TestActionResult | |
TestActionResult2 | |
TestActionResultModel |
Represents a test step result. |
TestAnalysisFailureGroup |
Test analysis failure group object |
TestAttachment | |
TestAttachmentReference |
Reference to test attachment. |
TestAttachmentRequestModel |
Test attachment request model |
TestAuthoringDetails | |
TestCaseMetadata2 | |
TestCaseReference2 | |
TestCaseResult |
Represents a test result. |
TestCaseResultAttachmentModel |
Test attachment information in a test iteration. |
TestCaseResultIdAndRev | |
TestCaseResultIdentifier |
Reference to a test result. |
TestCaseResultUpdateModel | |
TestConfiguration |
Test configuration |
TestEnvironment |
Test environment Detail. |
TestExecutionReportData | |
TestExtensionField | |
TestExtensionFieldDetails | |
TestFailureDetails | |
TestFailureType | |
TestFailuresAnalysis | |
TestFieldData | |
TestFieldsEx2 | |
TestFlakyIdentifier |
Test Flaky Identifier |
TestHistoryQuery |
Filter to get TestCase result history. |
TestIterationDetailsModel |
Represents a test iteration result. |
TestLog |
Represents Test Log Result object. |
TestLogReference |
Test Log Reference object |
TestLogStatus |
Represents Test Log Status object. |
TestLogStoreAttachment |
Attachment metadata for test attachments from LogStore. |
TestLogStoreAttachmentReference |
Reference to test attachment. |
TestLogStoreEndpointDetails |
Represents Test Log store endpoint details. |
TestMessageLog2 | |
TestMessageLogDetails |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
TestMessageLogEntry | |
TestMessageLogEntry2 | |
TestMethod | |
TestOperationReference |
Class representing a reference to an operation. |
TestOutcomeSettings |
Test outcome settings |
TestParameter2 | |
TestPlan |
The test plan resource. |
TestPlanCloneRequest | |
TestPlanHubData | |
TestPlansWithSelection | |
TestPoint |
Test Point Class |
TestPointReference | |
TestPointsEvent | |
TestPointsQuery |
Test point query class. |
TestPointsUpdatedEvent | |
TestResolutionState |
Test Resolution State Details. |
TestResult2 | |
TestResultAcrossProjectResponse | |
TestResultAttachment | |
TestResultAttachmentIdentity | |
TestResultCreateModel | |
TestResultDimension |
Represents dimensions |
TestResultDocument | |
TestResultFailureType |
The test failure type resource |
TestResultFailureTypeRequestModel |
The test failure type request model |
TestResultFailuresAnalysis | |
TestResultHistory | |
TestResultHistoryDetailsForGroup | |
TestResultHistoryForGroup |
List of test results filtered on the basis of GroupByValue |
TestResultLog |
Class to capture logs associated with a TestResultMachine |
TestResultMachine |
Class to map TestCaseResult to Machine objects the test ran on |
TestResultMetaData |
Represents a Meta Data of a test result. |
TestResultMetaDataUpdateInput |
Represents a TestResultMetaData Input |
TestResultMetaDataUpdateResponse | |
TestResultModelBase | |
TestResultParameter | |
TestResultParameterModel |
Test parameter information in a test iteration. |
TestResultPayload | |
TestResultReset2 | |
TestResultSummary | |
TestResultTrendFilter | |
TestResultsContext | |
TestResultsDetails | |
TestResultsDetailsForGroup | |
TestResultsEx2 | |
TestResultsGroupsForBuild | |
TestResultsGroupsForRelease | |
TestResultsQuery | |
TestResultsSession |
The TestResultSession is a higher-level container for test results by encapsulating multiple TestRun objects |
TestResultsSettings | |
TestResultsUpdateSettings | |
TestResultsWithWatermark | |
TestRun |
Test run details. |
TestRun2 | |
TestRunCanceledEvent | |
TestRunContext2 | |
TestRunCoverage |
Test Run Code Coverage Details |
TestRunCreatedEvent | |
TestRunEvent | |
TestRunEx2 | |
TestRunExtended2 | |
TestRunStartedEvent | |
TestRunStatistic |
Test run statistics. |
TestRunSummary2 | |
TestRunWithDtlEnvEvent | |
TestSession |
Test Session |
TestSessionAnalysis |
Test session anaylsis |
TestSessionEnvironment |
Test session environment |
TestSessionExploredWorkItemReference | |
TestSessionNotification |
Notifications for the TestResults Session |
TestSessionWorkItemReference | |
TestSettings |
Represents the test settings of the run. Used to create test settings and fetch test settings |
TestSettings2 |
Represents the test settings of the run. Used to create test settings and fetch test settings |
TestSettingsMachineRole | |
TestSubResult |
Represents a sub result of a test result. |
TestSuite |
Test suite |
TestSuiteCloneRequest |
Test suite clone request |
TestSummaryForWorkItem | |
TestTag |
Tag attached to a run or result. |
TestTagSummary |
Test tag summary for build or release grouped by test run. |
TestTagsUpdateModel |
Tags to update to a run or result. |
TestToWorkItemLinks | |
TestVariable |
Test Variable |
UpdateTestRunRequest | |
UpdateTestRunResponse | |
UpdatedProperties | |
UploadAttachmentsRequest | |
WorkItemReference |
Contains reference to a work item. |
WorkItemToTestLinks | |
CloneOperationCommonResponse |
Common Response for clone operation |
CloneTestCaseOperationInformation | |
CloneTestCaseParams |
Parameters for Test Suite clone operation |
CloneTestPlanOperationInformation |
Response for Test Plan clone operation |
CloneTestPlanParams |
Parameters for Test Plan clone operation |
CloneTestSuiteOperationInformation |
Response for Test Suite clone operation |
CloneTestSuiteParams |
Parameters for Test Suite clone operation |
Configuration |
Configuration of the Test Point |
DestinationTestPlanCloneParams |
Destination Test Plan create parameters |
DestinationTestSuiteInfo |
Destination Test Suite information for Test Suite clone operation |
ExportTestCaseParams |
Parameters for test case export operation |
LibraryWorkItemsData |
This data model is used in Work item-based tabs of Test Plans Library. |
LibraryWorkItemsDataProviderRequest |
This is the request data contract for LibraryTestCaseDataProvider. |
Results |
Results class for Test Point |
SourceTestPlanInfo |
Source Test Plan information for Test Plan clone operation |
SourceTestSuiteInfo |
Source Test Suite information for Test Suite clone operation |
SourceTestSuiteResponse |
Source Test Suite Response for Test Case clone operation |
SourceTestplanResponse |
Source Test Plan Response for Test Plan clone operation |
SuiteEntryUpdateParams |
A suite entry defines properties for a test suite. |
SuiteTestCaseCreateUpdateParameters |
Create and Update Suite Test Case Parameters |
TestCase |
Test Case Class |
TestCaseAssociatedResult | |
TestCaseReference |
Test Case Reference |
TestCaseResultsData |
This data model is used in TestCaseResultsDataProvider and populates the data required for initial page load |
TestConfigurationCreateUpdateParameters |
Test Configuration Create or Update Parameters |
TestConfigurationReference |
Test Configuration Reference |
TestEntityCount |
Test Entity Count Used to store test cases count (define tab) and test point count (execute tab) Used to store test cases count (define tab) and test point count (execute tab) |
TestPlanAndSuiteRestoreModel |
Test Plan/Suite restore request body params |
TestPlanCreateParams |
The test plan create parameters. |
TestPlanDetailedReference |
The test plan detailed reference resource. Contains additional workitem realted information |
TestPlanReference |
The test plan reference resource. |
TestPlanUpdateParams |
The test plan update parameters. |
TestPlansHubRefreshData |
This data model is used in TestPlansHubRefreshDataProvider and populates the data required for initial page load |
TestPlansLibraryWorkItemFilter |
Container to hold information about a filter being applied in Test Plans Library. |
TestPointDetailedReference | |
TestPointResults |
Test Point Results |
TestPointUpdateParams |
Test Point Update Parameters |
TestSuiteCreateParams |
Test suite Create Parameters |
TestSuiteCreateUpdateCommonParams |
Test Suite Create/Update Common Parameters |
TestSuiteReference |
The test suite reference resource. |
TestSuiteReferenceWithProject |
Test Suite Reference with Project |
TestSuiteUpdateParams |
Test Suite Update Parameters |
TestVariableCreateUpdateParameters |
Test Variable Create or Update Parameters |
WorkItem |
Describes a work item. |
WorkItemDetails |
Work Item Class |
ApiResourceLocation |
Information about the location of a REST API resource |
ApiResourceVersion |
Represents version information for a REST Api resource |
EventActor |
Defines an "actor" for an event. |
EventScope |
Defines a scope for an event. |
IdentityRef | |
IdentityRefWithEmail | |
JsonPatchDocument |
The JSON model for JSON Patch Operations |
JsonPatchOperation |
The JSON model for a JSON Patch operation |
JsonWebToken | |
PagedList |
A list that contains a single page of results from a query. |
PublicKey |
Represents the public key portion of an RSA asymmetric key. |
ReferenceLink |
The class to represent a REST reference link. RFC: http://tools.ietf.org/html/draft-kelly-json-hal-06 The RFC is not fully implemented, additional properties are allowed on the reference link but as of yet we don't have a need for them. |
ResourceRef | |
ServiceEvent | |
SignedUrl |
A signed url allowing limited-time anonymous access to private resources. |
TeamMember | |
TimingEntry |
A single secured timing consisting of a duration and start time |
TimingGroup |
A set of secured performance timings all keyed off of the same string |
TraceFilter |
This class describes a trace filter, i.e. a set of criteria on whether or not a trace event should be emitted |
VssJsonCollectionWrapper | |
VssJsonCollectionWrapperBase | |
VssJsonCollectionWrapperV |
This class is used to serialize collections as a single JSON object on the wire. |
VssNotificationEvent |
This is the type used for firing notifications intended for the subsystem in the Notifications SDK. For components that can't take a dependency on the Notifications SDK directly, they can use ITeamFoundationEventService.PublishNotification and the Notifications SDK ISubscriber implementation will get it. |
WrappedException | |
Wiki |
Defines a wiki repository which encapsulates the git repository backing the wiki. |
WikiAttachment |
Defines properties for wiki attachment file. |
WikiAttachmentResponse |
Response contract for the Wiki Attachments API |
WikiCreateBaseParameters |
Base wiki creation parameters. |
WikiCreateParameters |
Wiki creations parameters. |
WikiCreateParametersV2 |
Wiki creation parameters. |
WikiPage |
Defines a page in a wiki. |
WikiPageCreateOrUpdateParameters |
Contract encapsulating parameters for the page create or update operations. |
WikiPageDetail |
Defines a page with its metedata in a wiki. |
WikiPageMove |
Request contract for Wiki Page Move. |
WikiPageMoveParameters |
Contract encapsulating parameters for the page move operation. |
WikiPageMoveResponse |
Response contract for the Wiki Page Move API. |
WikiPageResponse |
Response contract for the Wiki Pages PUT, PATCH and DELETE APIs. |
WikiPageStat |
Defines properties for wiki page stat. |
WikiPageViewStats |
Defines properties for wiki page view stats. |
WikiPagesBatchRequest |
Contract encapsulating parameters for the pages batch. |
WikiUpdateParameters |
Wiki update parameters. |
WikiUpdatedNotificationMessage | |
WikiV2 |
Defines a wiki resource. |
Activity | |
BacklogColumn | |
BacklogConfiguration | |
BacklogFields | |
BacklogLevel |
Contract representing a backlog level |
BacklogLevelConfiguration | |
BacklogLevelWorkItems |
Represents work items in a backlog level |
BoardBadge |
Represents a board badge. |
BoardCardRuleSettings | |
BoardCardSettings | |
BoardChart | |
BoardChartReference | |
BoardFields | |
BoardSuggestedValue | |
BoardUserSettings | |
CapacityContractBase |
Base class for TeamSettings data contracts. Anything common goes here. |
CapacityPatch |
Expected data from PATCH |
CardFieldSettings |
Card settings, such as fields and rules |
CardSettings |
Card settings, such as fields and rules |
CategoryConfiguration |
Details about a given backlog category |
CreatePlan | |
DateRange | |
DeliveryViewData |
Data contract for Data of Delivery View |
DeliveryViewPropertyCollection |
Collection of properties, specific to the DeliveryTimelineView |
FieldInfo |
Object bag storing the set of permissions relevant to this plan |
FieldReference |
An abstracted reference to a field |
FieldSetting | |
FilterClause | |
FilterGroup | |
ITaskboardColumnMapping | |
IterationCapacity |
Capacity and teams for all teams in an iteration |
IterationWorkItems |
Represents work items in an iteration backlog |
Marker |
Client serialization contract for Delivery Timeline Markers. |
Member | |
ParentChildWIMap | |
Plan |
Data contract for the plan definition |
PlanMetadata |
Metadata about a plan definition that is stored in favorites service |
PlanViewData |
Base class for plan view data contracts. Anything common goes here. |
PredefinedQuery |
Represents a single pre-defined query. |
ProcessConfiguration |
Process Configurations for the project |
ReorderOperation |
Represents a reorder request for one or more work items. |
ReorderResult |
Represents a reorder result for a work item. |
TaskboardColumn |
Represents the taskbord column |
TaskboardColumnMapping |
Represents the state to column mapping per work item type This allows auto state update when the column changes |
TaskboardColumns | |
TaskboardWorkItemColumn |
Column value of a work item in the taskboard |
TeamAutomationRulesSettingsRequestModel | |
TeamBacklogMapping |
Mapping of teams to the corresponding work item category |
TeamCapacity |
Represents team member capacity with totals aggregated |
TeamCapacityTotals |
Team information with total capacity and days off |
TeamFieldValue |
Represents a single TeamFieldValue |
TeamFieldValues |
Essentially a collection of team field values |
TeamFieldValuesPatch |
Expected data from PATCH |
TeamIterationAttributes | |
TeamMemberCapacity |
Represents capacity for a specific team member |
TeamMemberCapacityIdentityRef |
Represents capacity for a specific team member |
TeamSetting |
Data contract for TeamSettings |
TeamSettingsDataContractBase |
Base class for TeamSettings data contracts. Anything common goes here. |
TeamSettingsDaysOff |
Base class for TeamSettings data contracts. Anything common goes here. |
TeamSettingsDaysOffPatch | |
TeamSettingsIteration |
Represents a shallow ref for a single iteration. |
TeamSettingsPatch |
Data contract for what we expect to receive when PATCH |
TimelineCriteriaStatus | |
TimelineIterationStatus | |
TimelineTeamData | |
TimelineTeamIteration | |
TimelineTeamStatus | |
UpdatePlan | |
UpdateTaskboardColumn | |
UpdateTaskboardWorkItemColumn | |
WorkItemColor |
Work item color and icon. |
WorkItemTypeStateInfo | |
attribute | |
AccountMyWorkResult | |
AccountRecentActivityWorkItemModel |
Represents Work Item Recent Activity |
AccountRecentActivityWorkItemModel2 |
Represents Work Item Recent Activity |
AccountRecentActivityWorkItemModelBase |
Represents Work Item Recent Activity |
AccountRecentMentionWorkItemModel |
Represents Recent Mention Work Item |
AccountWorkWorkItemModel | |
ArtifactUriQuery |
Contains criteria for querying work items based on artifact URI. |
ArtifactUriQueryResult |
Defines result of artifact URI query on work items. Contains mapping of work item IDs to artifact URI. |
AttachmentReference | |
CommentCreate |
Represents a request to create a work item comment. |
CommentUpdate |
Represents a request to update a work item comment. |
DestroyedAttachment |
Describes permanently deleted attachment and work items that had links to this attachment. |
ExternalDeployment | |
ExternalEnvironment | |
ExternalPipeline | |
FieldDependentRule |
Describes a list of dependent fields for a rule. |
FieldUpdate | |
GitHubConnectionModel |
Describes Github connection. |
GitHubConnectionRepoModel |
Describes Github connection's repo. |
GitHubConnectionReposBatchRequest |
Describes Github connection's repo bulk request |
IdentityReference |
Describes a reference to an identity. |
ProcessIdModel |
Stores process ID. |
ProcessMigrationResultModel |
Stores project ID and its process ID. |
ProjectWorkItemStateColors |
Project work item type state colors |
ProvisioningResult |
Result of an update work item type XML update operation. |
QueryBatchGetRequest |
Describes a request to get a list of queries |
QueryHierarchyItem |
Represents an item in the work item query hierarchy. This can be either a query or a folder. |
QueryHierarchyItemsResult | |
ReportingWorkItemLinksBatch |
The class describes reporting work item revision batch. |
ReportingWorkItemRevisionsBatch |
The class describes reporting work item revision batch. |
ReportingWorkItemRevisionsFilter |
The class represents the reporting work item revision filer. |
SendMailBody | |
StreamedBatch |
The class describes reporting work item revision batch. |
TemporaryQueryRequestModel |
Describes a request to create a temporary query |
TemporaryQueryResponseModel |
The result of a temporary query creation. |
UpdateWorkItemField |
Describes an update request for a work item field. |
Wiql |
A WIQL query |
WorkArtifactLink |
A work artifact link describes an outbound artifact link type. |
WorkItemBatchGetRequest |
Describes a request to get a set of work items |
WorkItemClassificationNode |
Defines a classification node for work item tracking. |
WorkItemComment |
Comment on Work Item |
WorkItemCommentVersionRef |
Represents the reference to a specific version of a comment on a Work Item. |
WorkItemComments |
Collection of comments. |
WorkItemDelete |
Full deleted work item object. Includes the work item itself. |
WorkItemDeleteBatch |
Describes response to delete a set of work items. |
WorkItemDeleteBatchRequest |
Describes a request to delete a set of work items |
WorkItemDeleteReference |
Reference to a deleted work item. |
WorkItemDeleteShallowReference |
Shallow Reference to a deleted work item. |
WorkItemDeleteUpdate |
Describes an update request for a deleted work item. |
WorkItemField |
Describes a field on a work item and it's properties specific to that work item type. |
WorkItemField2 |
Describes a field on a work item and it's properties specific to that work item type. |
WorkItemFieldAllowedValues |
Describes the list of allowed values of the field. |
WorkItemFieldOperation |
Describes a work item field operation. |
WorkItemFieldReference |
Reference to a field in a work item |
WorkItemFieldUpdate |
Describes an update to a work item field. |
WorkItemHistory |
Base class for WIT REST resources. |
WorkItemIcon |
Reference to a work item icon. |
WorkItemLink |
A link between two work items. |
WorkItemNextStateOnTransition |
Describes the next state for a work item. |
WorkItemQueryClause |
Represents a clause in a work item query. This shows the structure of a work item query. |
WorkItemQueryResult |
The result of a work item query. |
WorkItemQuerySortColumn |
A sort column. |
WorkItemRelation |
Link description. |
WorkItemRelationType |
Represents the work item type relation type. |
WorkItemRelationUpdates |
Describes updates to a work item's relations. |
WorkItemStateColor |
Work item type state name, color and state category |
WorkItemStateTransition |
Describes a state transition in a work item. |
WorkItemTagDefinition | |
WorkItemTemplate |
Describes a work item template. |
WorkItemTemplateReference |
Describes a shallow reference to a work item template. |
WorkItemTrackingReference |
Base class for WIT REST resources. |
WorkItemTrackingResource |
Base class for WIT REST resources. |
WorkItemTrackingResourceReference |
Base class for work item tracking resource references. |
WorkItemType |
Describes a work item type. |
WorkItemTypeCategory |
Describes a work item type category. |
WorkItemTypeColor |
Describes a work item type's colors. |
WorkItemTypeColorAndIcon |
Describes work item type name, its icon and color. |
WorkItemTypeFieldInstance |
Field instance of a work item type. |
WorkItemTypeFieldInstanceBase |
Base field instance for workItemType fields. |
WorkItemTypeFieldWithReferences |
Field Instance of a workItemype with detailed references. |
WorkItemTypeReference |
Reference to a work item type. |
WorkItemTypeStateColors |
State colors for a work item type |
WorkItemTypeTemplate |
Describes a work item type template. |
WorkItemTypeTemplateUpdateModel |
Describes a update work item type template request body. |
WorkItemUpdate |
Describes an update to a work item. |
IWorkItemChangedArgs |
Interface defining the arguments for notifications sent by the ActiveWorkItemService |
IWorkItemFieldChangedArgs |
Interface defining the arguments for the 'onFieldChanged' notification sent by the ActiveWorkItemService |
IWorkItemFormNavigationService |
Host service for opening the work item form |
IWorkItemFormService |
Host service for interacting with the currently active work item form (work item currently displayed in the UI). Form service depends on the current active work item context. Will throw an error when there is no open work item. |
IWorkItemLoadedArgs |
Interface defining the arguments for the 'onLoaded' notification sent by the ActiveWorkItemService |
IWorkItemNotificationListener |
Interface defining notifications provided by the ActiveWorkItemService |
WorkItemOptions |
Options for getting the values of a work item |
AddProcessWorkItemTypeFieldRequest |
Class that describes a request to add a field in a work item type. |
Control |
Represent a control in the form. |
CreateProcessModel |
Describes a process being created. |
CreateProcessRuleRequest |
Request object/class for creating a rule on a work item type. |
CreateProcessWorkItemTypeRequest |
Class for create work item type request |
Extension |
Represents the extensions part of the layout |
FieldModel | |
FieldRuleModel | |
FormLayout | |
Group |
Represent a group in the form that holds controls in it. |
HideStateModel | |
Page | |
PickList |
Picklist. |
PickListMetadata |
Metadata for picklist. |
ProcessBehavior |
Process Behavior Model. |
ProcessBehaviorCreateRequest |
Process Behavior Create Payload. |
ProcessBehaviorField |
Process Behavior Field. |
ProcessBehaviorReference |
Process behavior Reference. |
ProcessBehaviorUpdateRequest |
Process Behavior Replace Payload. |
ProcessInfo |
Process. |
ProcessModel | |
ProcessProperties |
Properties of the process. |
ProcessRule |
Process Rule Response. |
ProcessWorkItemType |
Class that describes a work item type object |
ProcessWorkItemTypeField |
Class that describes a field in a work item type and its properties. |
RuleAction |
Action to take when the rule is triggered. |
RuleActionModel |
Action to take when the rule is triggered. |
RuleCondition |
Defines a condition on a field when the rule should be triggered. |
RuleConditionModel | |
Section |
A layout node holding groups together in a page |
UpdateProcessModel |
Describes a request to update a process |
UpdateProcessRuleRequest |
Request class/object to update the rule. |
UpdateProcessWorkItemTypeFieldRequest |
Class to describe a request that updates a field's properties in a work item type. |
UpdateProcessWorkItemTypeRequest |
Class for update request on a work item type |
WitContribution | |
WorkItemBehavior | |
WorkItemBehaviorField | |
WorkItemBehaviorReference | |
WorkItemStateInputModel | |
WorkItemStateResultModel | |
WorkItemTypeBehavior | |
WorkItemTypeModel | |
BehaviorCreateModel | |
BehaviorModel | |
BehaviorReplaceModel | |
PickListItemModel | |
PickListMetadataModel | |
PickListModel | |
WorkItemTypeFieldModel | |
WorkItemTypeFieldModel2 |
New version of WorkItemTypeFieldModel supporting defaultValue as object (such as IdentityRef) and description |
WorkItemTypeUpdateModel |
Type Aliases
RestClientFactory |
A REST client factory is the method used to create and initialize an IVssRestClient. |
QueryParameterEntryValueType |
Type of individual entry values that can be used in Uri.addQueryParams call |
QueryParameterValueType |
Type of values supported by Uri.addQueryParams call |
CharacterPair |
A tuple of two characters, like a pair of opening and closing brackets. |
IResourceVersion | |
ResourceChangedCallback | |
VersionControlType |
Enums
AccountStatus | |
AccountType | |
AccountUserStatus | |
AlertType | |
AnalysisConfigurationType | |
ComponentType |
This enum defines the dependency components. |
Confidence | |
DependencyKind | |
DismissalType | |
ExpandOption | |
LicenseState | |
MetadataChangeType |
The type of change that occurred to the metadata. |
MetadataOperation |
The operation to be performed on the metadata. |
ResultType |
This enum defines the different result types. |
SarifJobStatus | |
Severity | |
State | |
BoardItemBatchOperationTypeEnum |
Describes board item batch operation types. |
BoardTypeEnum | |
AgentStatus | |
AuditAction | |
BuildAuthorizationScope |
Represents the desired scope of authorization for a build. |
BuildOptionInputType | |
BuildPhaseStatus | |
BuildQueryOrder |
Specifies the desired ordering of builds. |
BuildReason | |
BuildResult |
This is not a Flags enum because we don't want to set multiple statuses on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum This will ensure that things that key off multiple result types (like labelling sources) continue to work |
BuildStatus | |
ControllerStatus | |
DefinitionQuality | |
DefinitionQueryOrder |
Specifies the desired ordering of definitions. |
DefinitionQueueStatus | |
DefinitionTriggerType | |
DefinitionType | |
DeleteOptions | |
FolderQueryOrder |
Specifies the desired ordering of folders. |
GetOption | |
IssueType |
The type of issue based on severity. |
ProcessTemplateType | |
QueryDeletedOption | |
QueueOptions | |
QueuePriority | |
RepositoryCleanOptions | |
ResultSet | |
ScheduleDays | |
ServiceHostStatus | |
SourceProviderAvailability | |
StageUpdateType | |
SupportLevel | |
TaskResult |
The result of an operation tracked by a timeline record. |
TimelineRecordState |
The state of the timeline record. |
ValidationResult | |
WorkspaceMappingType | |
BuildServiceIds |
Contribution ids of Azure Pipelines services which can be obtained from DevOps.getService |
CommentExpandOptions |
Specifies the additional data retrieval options for work item comments. |
CommentFormat |
Represents the possible types for the comment format. Should be in sync with WorkItemCommentFormat.cs |
CommentMentionType | |
CommentReactionType |
Represents different reaction types for a work item comment. |
CommentSortOrder | |
CommentState |
Represents the possible comment states. |
CommonServiceIds |
Contribution ids of core DevOps services which can be obtained from DevOps.getService |
MessageBannerLevel |
The severity of the message. |
PanelSize |
Size (width) options for panel |
TeamFoundationHostType |
Host level for a VSS service |
DayOfWeek | |
SqlDbType |
Specifies SQL Server-specific data type of a field, property, for use in a System.Data.SqlClient.SqlParameter. |
ContributionLicensingBehaviorType |
Represents different ways of including contributions based on licensing |
ContributionPropertyType |
The type of value used for a property |
ContributionQueryOptions |
Options that control the contributions to include in a query |
ExtensionFlags |
Set of flags applied to extensions that are relevant to contribution consumers |
ExtensionStateFlags |
States of an extension Note: If you add value to this enum, you need to do 2 other things. First add the back compat enum in value src\Vssf\Sdk\Server\Contributions\InstalledExtensionMessage.cs. Second, you can not send the new value on the message bus. You need to remove it from the message bus event prior to being sent. |
InstalledExtensionStateIssueType |
Installation issue type (Warning, Error) |
ConnectedServiceKind | |
ProcessCustomizationType |
Type of process customization on a collection. |
ProcessType | |
ProjectChangeType | |
ProjectVisibility | |
SourceControlTypes | |
DashboardScope |
identifies the scope of dashboard storage and permissions. |
GroupMemberPermission |
None - Team member cannot edit dashboard Edit - Team member can add, configure and delete widgets Manage - Team member can add, reorder, delete dashboards Manage Permissions - Team member can manage membership of other members to perform group operations. |
TeamDashboardPermission |
Read - User can see dashboards Create - User can create dashboards Edit - User can add, configure and delete widgets, and edit dashboard settings. Delete - User can delete dashboards Manage Permissions - Team member can manage membership of other members to perform group operations. |
WidgetScope |
data contract required for the widget to function in a webaccess area or page. |
WidgetStatusType |
Used to differentiate between widget status helpers |
AcquisitionAssignmentType |
How the acquisition is assigned |
AcquisitionOperationState | |
AcquisitionOperationType |
Set of different types of operations that can be requested. |
ExtensionRequestState |
Represents the state of an extension request |
ExtensionRequestUpdateType | |
ExtensionUpdateType | |
ContributedFeatureEnabledValue |
The current state of a feature within a given scope |
BlobCompressionType |
Compression type for file stored in Blobstore |
ContainerItemStatus |
Status of a container item. |
ContainerItemType |
Type of a container item. |
ContainerOptions |
Options a container can have. |
InputDataType |
Enumerates data types that are supported as subscription input values. |
InputFilterOperator | |
InputMode |
Mode in which a subscription input should be entered (in a UI) |
ConcernCategory | |
DraftPatchOperation | |
DraftStateType | |
ExtensionDeploymentTechnology | |
ExtensionLifecycleEventType |
Type of event |
ExtensionPolicyFlags |
Set of flags that can be associated with a given permission over an extension |
ExtensionQueryFilterType |
Type of extension filters that are supported in the queries. |
ExtensionQueryFlags |
Set of flags used to determine which set of information is retrieved when reading published extensions |
ExtensionStatisticOperation | |
ExtensionStatsAggregateType |
Stats aggregation type |
ExtensionVersionFlags |
Set of flags that can be associated with a given extension version. These flags apply to a specific version of the extension. |
NotificationTemplateType |
Type of event |
PagingDirection |
PagingDirection is used to define which set direction to move the returned result set based on a previous query. |
PublishedExtensionFlags |
Set of flags that can be associated with a given extension. These flags apply to all versions of the extension and not to a specific version. |
PublisherFlags | |
PublisherPermissions | |
PublisherQueryFlags |
Set of flags used to define the attributes requested when a publisher is returned. Some API's allow the caller to specify the level of detail needed. |
PublisherRoleAccess |
Access definition for a RoleAssignment. |
PublisherState | |
QnAItemStatus |
Denotes the status of the QnA Item |
RestApiResponseStatus |
The status of a REST Api response status. |
ReviewEventOperation |
Type of operation |
ReviewFilterOptions |
Options to GetReviews query |
ReviewPatchOperation |
Denotes the patch operation type |
ReviewResourceType |
Type of event |
SortByType |
Defines the sort order that can be defined for Extensions query |
SortOrderType |
Defines the sort order that can be defined for Extensions query |
VSCodeWebExtensionStatisicsType | |
IndentAction |
Describes what to do with the indentation when pressing Enter. |
CommentThreadStatus |
The status of a comment thread. |
CommentType |
The type of a comment. |
GitAsyncOperationStatus |
Current status of the asynchronous operation. |
GitAsyncRefOperationFailureStatus | |
GitConflictType |
The type of a merge conflict. |
GitConflictUpdateStatus |
Represents the possible outcomes from a request to update a pull request conflict |
GitHistoryMode |
Accepted types of version |
GitObjectType | |
GitPathActions | |
GitPullRequestMergeStrategy |
Enumeration of possible merge strategies which can be used to complete a pull request. |
GitPullRequestQueryType |
Accepted types of pull request queries. |
GitPullRequestReviewFileType | |
GitRefSearchType |
Search type on ref name |
GitRefUpdateMode |
Enumerates the modes under which ref updates can be written to their repositories. |
GitRefUpdateStatus |
Represents the possible outcomes from a request to update a ref in a repository. |
GitResolutionError |
The type of a merge conflict. |
GitResolutionMergeType | |
GitResolutionPathConflictAction | |
GitResolutionRename1to2Action | |
GitResolutionStatus |
Resolution status of a conflict. |
GitResolutionWhichAction | |
GitStatusState |
State of the status. |
GitVersionOptions |
Accepted types of version options |
GitVersionType |
Accepted types of version |
ItemContentType | |
IterationReason |
The reason for which the pull request iteration was created. |
LineDiffBlockChangeType |
Type of change for a line diff block |
PullRequestAsyncStatus |
The status of a pull request merge. |
PullRequestMergeFailureType |
The specific type of a pull request merge failure. |
PullRequestStatus |
Status of a pull request. |
PullRequestTimeRangeType |
Specifies the desired type of time range for pull requests queries. |
RefFavoriteType | |
SupportedIdeType |
Enumeration that represents the types of IDEs supported. |
TfvcVersionOption |
Options for Version handling. |
TfvcVersionType |
Type of Version object |
VersionControlChangeType | |
VersionControlRecursionType | |
GitServiceIds |
Contribution ids of Azure Pipelines services which can be obtained from DevOps.getService |
GraphTraversalDirection | |
FrameworkIdentityType | |
GroupScopeType | |
QueryMembership | |
ReadIdentitiesOptions | |
IdentityServiceIds |
Contribution ids of identity services which can be obtained from DevOps.getService |
InheritLevel | |
RelativeToSetting | |
ServiceStatus | |
DefaultGroupDeliveryPreference |
Default delivery preference for group subscribers. Indicates how the subscriber should be notified. |
EvaluationOperationStatus |
Describes the subscription evaluation operation status. |
EventPublisherQueryFlags |
Set of flags used to determine which set of information is retrieved when querying for event publishers |
EventTypeQueryFlags |
Set of flags used to determine which set of information is retrieved when querying for eventtypes |
NotificationOperation | |
NotificationReasonType | |
NotificationStatisticType | |
NotificationSubscriberDeliveryPreference |
Delivery preference for a subscriber. Indicates how the subscriber should be notified. |
SubscriberFlags | |
SubscriptionFieldType | |
SubscriptionFlags |
Read-only indicators that further describe the subscription. |
SubscriptionPermissions |
The permissions that a user has to a certain subscription |
SubscriptionQueryFlags |
Flags that influence the result set of a subscription query. |
SubscriptionStatus |
Enumerates possible states of a subscription. |
SubscriptionTemplateQueryFlags |
Set of flags used to determine which set of templates is retrieved when querying for subscription templates |
SubscriptionTemplateType | |
OperationStatus |
The status of an operation. |
Operation | |
ConfigurationType | |
GetArtifactExpandOptions |
Expansion options for GetArtifact and ListArtifacts. |
GetLogExpandOptions |
$expand options for GetLog and ListLogs. |
RepositoryType | |
RunResult |
This is not a Flags enum because we don't want to set multiple results on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum. This will make it easier to query multiple results. |
RunState |
This is not a Flags enum because we don't want to set multiple states on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum. This will make it easier to query multiple states. |
PolicyEvaluationStatus |
Status of a policy which is running against a specific pull request. |
AvatarSize |
Small = 34 x 34 pixels; Medium = 44 x 44 pixels; Large = 220 x 220 pixels |
ProfileState |
The state of a profile. |
AggregationType | |
ResultPhase | |
AgentArtifactType | |
ApprovalExecutionOrder | |
ApprovalFilters | |
ApprovalStatus | |
ApprovalType | |
AuthorizationHeaderFor | |
ConditionType | |
DeployPhaseStatus | |
DeployPhaseTypes | |
DeploymentAuthorizationOwner | |
DeploymentExpands | |
DeploymentOperationStatus | |
DeploymentReason | |
DeploymentStatus | |
DeploymentsQueryType | |
EnvironmentStatus | |
EnvironmentTriggerType | |
FolderPathQueryOrder |
Specifies the desired ordering of folders. |
GateStatus | |
IssueSource | |
MailSectionType | |
ManualInterventionStatus |
Describes manual intervention status |
ManualInterventionType |
Describes manual intervention status |
ParallelExecutionTypes | |
PipelineProcessTypes | |
PropertySelectorType | |
PullRequestSystemType | |
ReleaseDefinitionExpands | |
ReleaseDefinitionQueryOrder | |
ReleaseDefinitionSource | |
ReleaseEnvironmentExpands | |
ReleaseExpands | |
ReleaseQueryOrder | |
ReleaseReason | |
ReleaseStatus | |
ReleaseTriggerType | |
SenderType | |
SingleReleaseExpands | |
TaskStatus | |
VariableGroupActionFilter | |
YamlFileSourceTypes | |
AadLoginPromptOption | |
AccessTokenRequestType | |
OAuthConfigurationActionFilter | |
ServiceEndpointActionFilter | |
ServiceEndpointExecutionResult | |
SpnEndpointErrorCode | |
AuthenticationType |
Enumerates consumer authentication types. |
NotificationResult |
Enumerates possible result types of a notification. |
NotificationStatus |
Enumerates possible status' of a notification. |
SubscriptionInputScope |
The scope to which a subscription input applies |
DemandSourceType | |
DeploymentGroupActionFilter |
This is useful in getting a list of deployment groups, filtered for which caller has permissions to take a particular action. |
DeploymentGroupExpands |
Properties to be included or expanded in deployment group objects. This is useful when getting a single or list of deployment grouops. |
DeploymentMachineExpands | |
DeploymentPoolSummaryExpands |
Properties to be included or expanded in deployment pool summary objects. This is useful when getting a single or list of deployment pool summaries. |
DeploymentTargetExpands |
Properties to be included or expanded in deployment target objects. This is useful when getting a single or list of deployment targets. |
ElasticAgentState | |
ElasticComputeState | |
ElasticNodeState | |
ElasticPoolState | |
EnvironmentActionFilter |
This is useful in getting a list of Environments, filtered for which caller has permissions to take a particular action. |
EnvironmentExpands |
Properties to be included or expanded in environment objects. This is useful when getting a single environment. |
EnvironmentResourceType |
EnvironmentResourceType. |
ExclusiveLockType | |
LogLevel | |
MachineGroupActionFilter | |
MaskType | |
OperatingSystemType | |
OperationType | |
OrchestrationType | |
PlanGroupStatus | |
PlanGroupStatusFilter | |
ResourceLockStatus | |
SecureFileActionFilter | |
StageTriggerType | |
TaskAgentJobResultFilter |
This is useful in getting a list of deployment targets, filtered by the result of their last job. |
TaskAgentJobStepType | |
TaskAgentPoolActionFilter |
Filters pools based on whether the calling user has permission to use or manage the pool. |
TaskAgentPoolMaintenanceJobResult | |
TaskAgentPoolMaintenanceJobStatus | |
TaskAgentPoolMaintenanceScheduleDays | |
TaskAgentPoolOptions |
Additional settings and descriptors for a TaskAgentPool |
TaskAgentPoolType |
The type of agent pool. |
TaskAgentQueueActionFilter |
Filters queues based on whether the calling user has permission to use or manage the queue. |
TaskAgentRequestUpdateOptions | |
TaskAgentStatus | |
TaskAgentStatusFilter |
This is useful in getting a list of deployment targets, filtered by the deployment agent status. |
TaskAgentUpdateReasonType | |
TaskCommandMode | |
TaskDefinitionStatus | |
TaskGroupExpands | |
TaskGroupQueryOrder |
Specifies the desired ordering of taskGroups. |
TaskOrchestrationItemType | |
TaskOrchestrationPlanState | |
VariableGroupQueryOrder |
Specifies the desired ordering of variableGroups. |
AttachmentType |
The types of test attachments. |
CloneOperationState |
Enum of type Clone Operation Type. |
CoverageDetailedSummaryStatus |
Represents status of code coverage summary for a build |
CoverageQueryFlags |
Used to choose which coverage data is returned by a QueryXXXCoverage() call. |
CoverageStatus | |
CoverageSummaryStatus |
Represents status of code coverage summary for a build |
CustomTestFieldScope |
Type of the artifact applicable to CustomTestField. |
CustomTestFieldType |
Data type of the custom test field |
FlakyDetectionType | |
Metrics |
Test summary metrics. |
ResultDetails |
Additional details with test result |
ResultGroupType |
Hierarchy type of the result/subresults. |
ResultMetaDataDetails |
Additional details with test result metadata |
ResultMetadata | |
ResultObjectType |
The top level entity that is being cloned as part of a Clone operation |
RunType | |
Service | |
SessionResult | |
SuiteExpand |
Option to get details in response |
TCMServiceDataMigrationStatus | |
TestConfigurationState |
Represents the state of an ITestConfiguration object. |
TestLogScope |
Test Log Context |
TestLogStatusCode |
Test Log Status codes. |
TestLogStoreEndpointType |
Specifies set of possible log store endpoint type. |
TestLogStoreOperationType |
Specifies set of possible operation type on log store. |
TestLogType |
Test Log Types |
TestOutcome |
Valid TestOutcome values. |
TestPointState | |
TestResultGroupBy |
Group by for results |
TestResultsContextType | |
TestResultsSessionState | |
TestResultsSettingsType | |
TestRunOutcome |
The types of outcomes for test run. |
TestRunPublishContext |
The types of publish context for run. |
TestRunState |
The types of states for test run. |
TestRunSubstate |
The types of sub states for test run. It gives the user more info about the test run beyond the high level test run state |
TestSessionSource |
Represents the source from which the test session was created |
TestSessionState |
Represents the state of the test session. |
ExcludeFlags |
Exclude Flags for suite test case object. Exclude Flags exclude various objects from payload depending on the value passed |
FailureType | |
LastResolutionState | |
LibraryTestCasesDataReturnCode |
Enum representing the return code of data provider. |
Outcome | |
PointState | |
ResultState | |
SuiteEntryTypes | |
TestEntityTypes | |
TestPlansLibraryQuery |
Enum used to define the queries used in Test Plans Library. |
TestPlansLibraryWorkItemFilterMode | |
TestSuiteType |
Type of TestSuite |
UserFriendlyTestOutcome | |
ConnectOptions |
Enumeration of the options that can be passed in on Connect. |
DeploymentFlags | |
JWTAlgorithm | |
UserProfileBackupState | |
UserProfileSyncState | |
WikiType |
Wiki types. |
BacklogType |
Definition of the type of backlog level |
BoardBadgeColumnOptions |
Determines what columns to include on the board badge |
BoardColumnType | |
BugsBehavior |
The behavior of the work item types that are in the work item category specified in the BugWorkItems section in the Process Configuration |
FieldType |
Enum for the type of a field. |
IdentityDisplayFormat |
Enum for the various modes of identity picker |
PlanType |
Enum for the various types of plans |
PlanUserPermissions |
Flag for permissions a user can have for this plan. |
TimeFrame | |
TimelineCriteriaStatusCode | |
TimelineIterationStatusCode | |
TimelineTeamStatusCode | |
ClassificationNodesErrorPolicy |
Flag to control error policy in a batch classification nodes get request. |
FieldUsage |
Enum for field usages. |
GetFieldsExpand |
Flag to expand types of fields. |
LinkQueryMode |
The link query mode which determines the behavior of the query. |
LogicalOperation | |
ProvisioningActionType |
Enumerates the possible provisioning actions that can be triggered on process template update. |
QueryErrorPolicy |
Enum to control error policy in a query batch request. |
QueryExpand |
Determines which set of additional query properties to display |
QueryOption | |
QueryRecursionOption |
Determines whether a tree query matches parents or children first. |
QueryResultType |
The query result type |
QueryType |
The type of query. |
ReportingRevisionsExpand |
The reporting revision expand level. |
TemplateType |
Enumerates types of supported xml templates used for customization. |
TreeNodeStructureType |
Types of tree node structures. |
TreeStructureGroup |
Types of tree structures groups. |
WorkItemErrorPolicy |
Enum to control error policy in a bulk get work items request. |
WorkItemExpand |
Flag to control payload properties from get work item command. |
WorkItemRecentActivityType |
Type of the activity |
WorkItemTypeFieldsExpandLevel |
Expand options for the work item field(s) request. |
WorkItemTrackingServiceIds |
Contribution ids of Azure Boards services which can be obtained from DevOps.getService |
CustomizationType |
Indicates the customization-type. Customization-type is System if is system generated or by default. Customization-type is Inherited if the existing workitemtype of inherited process is customized. Customization-type is Custom if the newly created workitemtype is customized. |
GetBehaviorsExpand |
Expand options to fetch fields for behaviors API. |
GetProcessExpandLevel |
The expand level of returned processes. |
GetWorkItemTypeExpand | |
PageType |
Type of page |
ProcessClass | |
ProcessWorkItemTypeFieldsExpandLevel |
Expand options for the work item field(s) request. |
RuleActionType |
Type of action to take when the rule is triggered. |
RuleConditionType |
Type of rule condition. |
WorkItemTypeClass |
Work item type classes' |
Functions
get |
|
issue |
Issue a fetch request. This is a wrapper around the browser fetch method that handles VSS authentication and triggers events that can be listened to by other modules. |
deserialize |
Handle the raw text of a JSON response which may contain MSJSON style dates and deserialize (JSON.parse) the data in a way that restores Date objects rather than strings. MSJSON style dates are in the form:
This format unnecessarily (but intentionally) escapes the "/" character. So the parsed JSON will have no trace of the escape character (). |
combine |
Take url segments and join them with a single slash character. Takes care of path segements that start and/or end with a slash to ensure that the resulting URL does not have double-slashes |
get |
Take a set of routes and find the best match. The best match is the route with the highest number of replacements (of the given routeValues dictionary). In the event of a tie (same number of replacements) the route that came first wins. |
parse |
Parse a route template into a structure that can be used to quickly do route replacements |
replace |
Replace route values for a specific parsed route |
replace |
Take an MVC route template (like "/foo/{id}/{*params}") and replace the templated parts with values from the given dictionary |
route |
Take a set of routes and route values and form a url using the best match. The best match is the route with the highest number of replacements (of the given routeValues dictionary). In the event of a tie (same number of replacements) the route that came first wins. |
Function Details
getClient<T>(RestClientFactory<T>, IVssRestClientOptions)
function getClient<T>(clientClass: RestClientFactory<T>, clientOptions?: IVssRestClientOptions): T
Parameters
- clientClass
- clientOptions
- IVssRestClientOptions
Returns
T
issueRequest(string, RequestInit, IVssRequestOptions)
Issue a fetch request. This is a wrapper around the browser fetch method that handles VSS authentication and triggers events that can be listened to by other modules.
function issueRequest(requestUrl: string, options?: RequestInit, vssRequestOptions?: IVssRequestOptions): Promise<Response>
Parameters
- requestUrl
-
string
Url to send the request to
- options
-
RequestInit
fetch settings/options for the request
- vssRequestOptions
- IVssRequestOptions
VSS specific request options
Triggered Events: afterRequest -> IPostRequestEvent is sent after the request has completed. beforeRequest -> IPreRequestEvent is sent before the request is made.
Returns
Promise<Response>
deserializeVssJsonObject<T>(string)
Handle the raw text of a JSON response which may contain MSJSON style dates and deserialize (JSON.parse) the data in a way that restores Date objects rather than strings.
MSJSON style dates are in the form:
"lastModified": "/Date(1496158224000)/"
This format unnecessarily (but intentionally) escapes the "/" character. So the parsed JSON will have no trace of the escape character ().
function deserializeVssJsonObject<T>(text: string): T | null
Parameters
- text
-
string
The raw JSON text
Returns
T | null
combineUrlPaths(string[])
Take url segments and join them with a single slash character. Takes care of path segements that start and/or end with a slash to ensure that the resulting URL does not have double-slashes
function combineUrlPaths(paths: string[]): string
Parameters
- paths
-
string[]
Path segments to concatenate
Returns
string
getBestRouteMatch(IParsedRoute[], {[name: string]: string})
Take a set of routes and find the best match. The best match is the route with the highest number of replacements (of the given routeValues dictionary). In the event of a tie (same number of replacements) the route that came first wins.
function getBestRouteMatch(routeCollection: IParsedRoute[], routeValues: {[name: string]: string}): IRouteMatchResult | undefined
Parameters
- routeCollection
Array of parsed routes
- routeValues
-
{[name: string]: string}
Replacement values
Returns
IRouteMatchResult | undefined
parseRouteTemplate(string)
Parse a route template into a structure that can be used to quickly do route replacements
function parseRouteTemplate(routeTemplate: string): IParsedRoute
Parameters
- routeTemplate
-
string
MVC route template string (like "/foo/{id}/{*params}")
Returns
replaceParsedRouteValues(IParsedRoute, {[name: string]: string | number | undefined}, boolean)
Replace route values for a specific parsed route
function replaceParsedRouteValues(parsedRoute: IParsedRoute, routeValues: {[name: string]: string | number | undefined}, continueOnUnmatchedSegements?: boolean): IRouteMatchResult | undefined
Parameters
- parsedRoute
- IParsedRoute
The route to evaluate
- routeValues
-
{[name: string]: string | number | undefined}
Dictionary of route replacement parameters
- continueOnUnmatchedSegements
-
boolean
If true, continue with replacements even after a miss. By default (false), stop replacements once a parameter is not present.
Returns
IRouteMatchResult | undefined
replaceRouteValues(string, {[name: string]: string | number | undefined})
Take an MVC route template (like "/foo/{id}/{*params}") and replace the templated parts with values from the given dictionary
function replaceRouteValues(routeTemplate: string, routeValues: {[name: string]: string | number | undefined}): string
Parameters
- routeTemplate
-
string
MVC route template (like "/foo/{id}/{*params}")
- routeValues
-
{[name: string]: string | number | undefined}
Route value replacements
Returns
string
routeUrl(IParsedRoute[], {[name: string]: string})
Take a set of routes and route values and form a url using the best match. The best match is the route with the highest number of replacements (of the given routeValues dictionary). In the event of a tie (same number of replacements) the route that came first wins.
function routeUrl(routeCollection: IParsedRoute[], routeValues: {[name: string]: string}): string
Parameters
- routeCollection
Array of parsed routes
- routeValues
-
{[name: string]: string}
Replacement values
Returns
string