Documentation
¶
Overview ¶
Package ado holds the connection to an Azure DevOps organization that the per-area tool packages (core, wit, git, …) share.
Azure DevOps spreads its APIs across several hosts. Clients bundles a configured REST client for each host an area might need:
dev.azure.com/{org} primary services (core, wit, git, build, …)
vssps.dev.azure.com/{org} Graph/Identity
vsrm.dev.azure.com/{org} Release Management
feeds.dev.azure.com/{org} Artifacts/Packaging feeds
auditservice.dev.azure.com/{org} Audit log
Index ¶
Constants ¶
View Source
const DefaultAPIVersion = "7.1"
DefaultAPIVersion is the Azure DevOps REST API version targeted by default. Individual requests may override it (e.g. for "-preview" endpoints).
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Clients ¶
type Clients struct {
// Org reaches the primary organization host, https://dev.azure.com/{org}.
Org *client.Client
// VSSPS reaches the Graph/Identity host, https://vssps.dev.azure.com/{org}.
VSSPS *client.Client
// VSRM reaches the Release Management host, https://vsrm.dev.azure.com/{org}.
VSRM *client.Client
// Feeds reaches the Artifacts host, https://feeds.dev.azure.com/{org}.
Feeds *client.Client
// Audit reaches the Audit host, https://auditservice.dev.azure.com/{org}.
Audit *client.Client
// Search reaches the Search host, https://almsearch.dev.azure.com/{org}.
Search *client.Client
// VSAEX reaches the Member Entitlement host, https://vsaex.dev.azure.com/{org}.
VSAEX *client.Client
// ExtMgmt reaches the Extension Management host, https://extmgmt.dev.azure.com/{org}.
ExtMgmt *client.Client
// AdvSec reaches the Advanced Security host, https://advsec.dev.azure.com/{org}.
AdvSec *client.Client
}
Clients bundles the REST clients needed to reach the full Azure DevOps API.
func NewClients ¶
NewClients builds the Azure DevOps clients for the given organization URL (e.g. "https://dev.azure.com/myorg") authenticated with a PAT.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package advsec exposes the Azure DevOps Advanced Security service: querying code scanning alerts (code, secret and dependency) for a repository within a project.
|
Package advsec exposes the Azure DevOps Advanced Security service: querying code scanning alerts (code, secret and dependency) for a repository within a project. |
|
Package approvals exposes Azure DevOps pipeline run approvals and checks: retrieving approvals, listing check configurations for protected resources, and approving or rejecting pending approvals.
|
Package approvals exposes Azure DevOps pipeline run approvals and checks: retrieving approvals, listing check configurations for protected resources, and approving or rejecting pending approvals. |
|
Package artifacts wraps the Azure DevOps Artifacts (packaging feeds) APIs.
|
Package artifacts wraps the Azure DevOps Artifacts (packaging feeds) APIs. |
|
Package audit exposes the Azure DevOps Audit service: querying the organization-level audit log of decorated audit log entries.
|
Package audit exposes the Azure DevOps Audit service: querying the organization-level audit log of decorated audit log entries. |
|
Package boards exposes Azure DevOps Boards / Work tracking endpoints (backlogs, iterations, team capacity, and boards/columns).
|
Package boards exposes Azure DevOps Boards / Work tracking endpoints (backlogs, iterations, team capacity, and boards/columns). |
|
Package core exposes the Azure DevOps Core service: projects, teams, team members and processes.
|
Package core exposes the Azure DevOps Core service: projects, teams, team members and processes. |
|
Package dashboards exposes the Azure DevOps Dashboards service: team-scoped dashboards and the widgets they contain, including creating and deleting dashboards.
|
Package dashboards exposes the Azure DevOps Dashboards service: team-scoped dashboards and the widgets they contain, including creating and deleting dashboards. |
|
Package deliveryplans exposes the Azure DevOps Delivery Plans service: cross-team epic/roadmap timeline plans defined at the project level.
|
Package deliveryplans exposes the Azure DevOps Delivery Plans service: cross-team epic/roadmap timeline plans defined at the project level. |
|
Package distributedtask exposes the Azure DevOps Distributed Task service: pipeline resources such as variable groups, environments, agent pools and secure files, including listing, fetching and creating selected resources.
|
Package distributedtask exposes the Azure DevOps Distributed Task service: pipeline resources such as variable groups, environments, agent pools and secure files, including listing, fetching and creating selected resources. |
|
Package extension exposes the Azure DevOps Extension Management service: listing and retrieving extensions installed in the organization.
|
Package extension exposes the Azure DevOps Extension Management service: listing and retrieving extensions installed in the organization. |
|
Package favorites exposes the Azure DevOps Favorites service: listing, creating, and deleting a caller's favorites (e.g.
|
Package favorites exposes the Azure DevOps Favorites service: listing, creating, and deleting a caller's favorites (e.g. |
|
Package git exposes the Azure DevOps Git service: repositories, refs/branches, commits, file contents, pull requests, PR threads/comments and reviewer votes.
|
Package git exposes the Azure DevOps Git service: repositories, refs/branches, commits, file contents, pull requests, PR threads/comments and reviewer votes. |
|
Package graph exposes the Azure DevOps Graph/Identity service: users, groups and subject memberships.
|
Package graph exposes the Azure DevOps Graph/Identity service: users, groups and subject memberships. |
|
Package identities exposes the Azure DevOps legacy Identity service for looking up identities (users and groups) by search filter or descriptor.
|
Package identities exposes the Azure DevOps legacy Identity service for looking up identities (users and groups) by search filter or descriptor. |
|
Package macros provides composite tools: single MCP tools that orchestrate several Azure DevOps REST calls server-side.
|
Package macros provides composite tools: single MCP tools that orchestrate several Azure DevOps REST calls server-side. |
|
Package memberentitlement exposes the Azure DevOps Member Entitlement Management service: listing and inspecting user and group access-level entitlements (licensing) for an organization.
|
Package memberentitlement exposes the Azure DevOps Member Entitlement Management service: listing and inspecting user and group access-level entitlements (licensing) for an organization. |
|
Package notification exposes the Azure DevOps Notification service: listing, inspecting, creating, updating, and deleting notification subscriptions, and listing the available notification event types for the organization.
|
Package notification exposes the Azure DevOps Notification service: listing, inspecting, creating, updating, and deleting notification subscriptions, and listing the available notification event types for the organization. |
|
Package operations exposes the Azure DevOps Operations service: querying the status of long-running asynchronous operations by their operation ID.
|
Package operations exposes the Azure DevOps Operations service: querying the status of long-running asynchronous operations by their operation ID. |
|
Package pipelines exposes the Azure DevOps Pipelines and Build services: pipelines, pipeline runs, build definitions, builds, build logs and artifacts.
|
Package pipelines exposes the Azure DevOps Pipelines and Build services: pipelines, pipeline runs, build definitions, builds, build logs and artifacts. |
|
Package policy exposes the Azure DevOps Policy service: project-scoped policy configurations (such as branch policies) and the policy types available to configure, including creating new configurations.
|
Package policy exposes the Azure DevOps Policy service: project-scoped policy configurations (such as branch policies) and the policy types available to configure, including creating new configurations. |
|
Package processes exposes the Azure DevOps Work Item Tracking process customization service: organization processes and their work item types, fields, states, and behaviors.
|
Package processes exposes the Azure DevOps Work Item Tracking process customization service: organization processes and their work item types, fields, states, and behaviors. |
|
Package profile exposes the Azure DevOps Profile service: retrieving the profile of the authenticated user.
|
Package profile exposes the Azure DevOps Profile service: retrieving the profile of the authenticated user. |
|
Package release provides Azure DevOps Release Management operations: release definitions, releases, deployments, and approvals.
|
Package release provides Azure DevOps Release Management operations: release definitions, releases, deployments, and approvals. |
|
Package repostats computes Azure DevOps surveys and statistics: repository contributions (commits per author), pull-request activity, work-item breakdowns, and build outcomes — aggregated at the repository, project, or organization level.
|
Package repostats computes Azure DevOps surveys and statistics: repository contributions (commits per author), pull-request activity, work-item breakdowns, and build outcomes — aggregated at the repository, project, or organization level. |
|
Package search exposes the Azure DevOps Search service: full-text search across code, work items, and wiki pages.
|
Package search exposes the Azure DevOps Search service: full-text search across code, work items, and wiki pages. |
|
Package security provides read-only access to Azure DevOps security namespaces and access control lists at the organization level.
|
Package security provides read-only access to Azure DevOps security namespaces and access control lists at the organization level. |
|
Package serviceendpoint exposes Azure DevOps service endpoints (service connections): listing, getting, creating, updating, and deleting them, plus the available endpoint types.
|
Package serviceendpoint exposes Azure DevOps service endpoints (service connections): listing, getting, creating, updating, and deleting them, plus the available endpoint types. |
|
Package servicehooks provides access to Azure DevOps Service Hooks, allowing callers to list, inspect, create, and delete event subscriptions.
|
Package servicehooks provides access to Azure DevOps Service Hooks, allowing callers to list, inspect, create, and delete event subscriptions. |
|
Package test provides read-only access to Azure DevOps Test Plans, test suites, test cases, test runs, and test results.
|
Package test provides read-only access to Azure DevOps Test Plans, test suites, test cases, test runs, and test results. |
|
Package tfvc exposes the Azure DevOps Team Foundation Version Control (TFVC) service: listing and fetching changesets, listing branches, and reading item content.
|
Package tfvc exposes the Azure DevOps Team Foundation Version Control (TFVC) service: listing and fetching changesets, listing branches, and reading item content. |
|
Package wiki exposes the Azure DevOps Wiki service: listing wikis, fetching a wiki, reading wiki pages, and creating or updating pages.
|
Package wiki exposes the Azure DevOps Wiki service: listing wikis, fetching a wiki, reading wiki pages, and creating or updating pages. |
|
Package wit exposes the Azure DevOps Work Item Tracking service: work item CRUD, WIQL queries, comments, tags and metadata (types and fields).
|
Package wit exposes the Azure DevOps Work Item Tracking service: work item CRUD, WIQL queries, comments, tags and metadata (types and fields). |
Click to show internal directories.
Click to hide internal directories.