Azure DevOps Go API

When retrieving or updating widgets, the API uses ETags to ensure version consistency.

1. When calling GetWidgets, the returned WidgetsVersionedList contains an ETag field.
2. When performing a ReplaceWidgets or UpdateWidgets operation, you can provide this ETag in the ReplaceWidgetsArgs or UpdateWidgetsArgs to ensure you are modifying the expected version of the dashboard's widget collection.

The Client acts as the central engine for all API interactions. It handles:

• URL Generation: It uses ApiResourceLocation (retrieved from the server) and routeValues to build the correct REST endpoint.
• Request Construction: It automatically injects Authorization, Accept (with api-version), Content-Type, and User-Agent headers.
• Session Management: It tracks a SessionId (a UUID). If the Azure DevOps server provides a new session ID in the X-TFS-Session header of a response, the client updates its internal SessionId to ensure subsequent requests remain within the same session.
• Error Handling: It uses UnwrapError to parse error responses from the server, converting them into structured WrappedError types.

To manage policy configurations in Azure DevOps using the V6 API, use the NewClient function. This requires an existing azuredevops.Connection object. The client provides methods to create, update, delete, and retrieve policy configurations and their revisions.

import (
	"context"
	"github.com/microsoft/azure-devops-go-api/azuredevops/v6"
	"github.com/microsoft/azure-devops-go-api/azuredevops/v6/policy"
)

// Assuming 'connection' is an already initialized *azuredevops.Connection
client, err := policy.NewClient(ctx, connection)
if err != nil {
	// handle error
}

To interact with Azure DevOps, you must create a Client instance. You can do this using NewClient for standard configurations or NewClientWithOptions if you need to provide custom ClientOptionFunc modifiers (such as a custom http.Client).

Both methods require a *Connection object (which contains authorization and TLS settings) and a baseUrl string representing the Azure DevOps organization URL.

// Using NewClient
client := azuredevops.NewClient(connection, "https://dev.azure.com/your-org")

// Using NewClientWithOptions for custom configuration
client := azuredevops.NewClientWithOptions(connection, "https://dev.azure.com/your-org", azuredevops.WithHTTPClient(myCustomHttpClient))

To use the CIX (Continuous Integration eXperience) client, use the NewClient function. This requires an existing azuredevops.Connection object. The NewClient function retrieves the appropriate client for the connection's base URL and returns a Client interface used to manage project connections and resources.

client := cix.NewClient(ctx, connection)

To manage installed extensions in Azure DevOps, use NewClient from the extensionmanagement package. This requires an existing azuredevops.Connection object. The client provides access to preview APIs for installing, uninstalling, listing, and updating extensions.

package main

import (
	"context"
	"github.com/microsoft/azure-devops-go-api/azuredevops/v6"
	"github.com/microsoft/azure-devops-go-api/azuredevops/v6/extensionmanagement"
)

func main() {
	ctx := context.Background()
	// connection is an existing *azuredevops.Connection
	client, err := extensionmanagement.NewClient(ctx, connection)
	if err != nil {
		panic(err)
	}
	_ = client
}

To interact with the Azure DevOps Contributions API (used for querying installed extensions and contribution nodes), use the NewClient function. This requires an existing azuredevops.Connection object.

Note that all methods in this client are currently marked as [Preview API].

import (
	"context"
	"github.com/microsoft/azure-devops-go-api/azuredevops/v7"
	"github.com/microsoft/azure-devops-go-api/azuredevops/v7/contributions"
)

// Assuming 'connection' is an already initialized *azuredevops.Connection
client, err := contributions.NewClient(ctx, connection)
if err != nil {
	// handle error
}

To use the Cloud Load Test API, create a new client using NewClient. This requires a context.Context and an existing azuredevops.Connection object. The client provides methods to manage agent groups, test definitions, test drops, and test runs.

client, err := cloudloadtest.NewClient(ctx, connection)
if err != nil {
	// handle error
}