distributedtask

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

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.

Index

Constants

View Source
const Name = "distributedtask"

Name is the toolset name used for enable/disable filtering.

Variables

This section is empty.

Functions

func Register

func Register(s *server.Server, c *ado.Clients)

Register wires the distributed task tools into the MCP server.

Types

type AgentPool

type AgentPool struct {
	ID       int    `json:"id"`
	Name     string `json:"name"`
	IsHosted bool   `json:"isHosted,omitempty"`
	PoolType string `json:"poolType,omitempty"`
}

AgentPool is an organization-level pool of build/release agents.

type CreateDeploymentGroupInput added in v0.1.2

type CreateDeploymentGroupInput struct {
	Project     string `json:"project" jsonschema:"project name or ID"`
	Name        string `json:"name" jsonschema:"the name of the deployment group"`
	Description string `json:"description,omitempty" jsonschema:"an optional description for the deployment group"`
}

CreateDeploymentGroupInput names the deployment group to create within a project.

type CreateEnvironmentInput

type CreateEnvironmentInput struct {
	Project     string `json:"project" jsonschema:"project name or ID"`
	Name        string `json:"name" jsonschema:"the name of the environment"`
	Description string `json:"description,omitempty" jsonschema:"an optional description for the environment"`
}

CreateEnvironmentInput names the environment to create within a project.

type CreateVariableGroupInput

type CreateVariableGroupInput struct {
	Project string         `json:"project" jsonschema:"project name or ID"`
	Body    map[string]any `json:"body" jsonschema:"the variable group definition body"`
}

CreateVariableGroupInput carries the project and raw variable group body.

type DeleteDeploymentGroupInput added in v0.1.2

type DeleteDeploymentGroupInput struct {
	Project           string `json:"project" jsonschema:"project name or ID"`
	DeploymentGroupID int    `json:"deploymentGroupId" jsonschema:"the deployment group ID"`
}

DeleteDeploymentGroupInput identifies the deployment group to delete.

type DeploymentGroup added in v0.1.2

type DeploymentGroup struct {
	ID          int    `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Machines    any    `json:"machines,omitempty"`
}

DeploymentGroup is a classic-release-era collection of deployment target machines within a project.

type DeploymentMachine added in v0.1.2

type DeploymentMachine struct {
	ID    int      `json:"id"`
	Agent any      `json:"agent,omitempty"`
	Tags  []string `json:"tags,omitempty"`
}

DeploymentMachine is a target machine registered in a deployment group.

type Environment

type Environment struct {
	ID          int    `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}

Environment is a pipeline deployment environment.

type GetDeploymentGroupInput added in v0.1.2

type GetDeploymentGroupInput struct {
	Project           string `json:"project" jsonschema:"project name or ID"`
	DeploymentGroupID int    `json:"deploymentGroupId" jsonschema:"the deployment group ID"`
	IncludeTargets    bool   `json:"includeTargets,omitempty" jsonschema:"include the deployment group's target machines (optional)"`
}

GetDeploymentGroupInput identifies a single deployment group.

type GetEnvironmentInput

type GetEnvironmentInput struct {
	Project       string `json:"project" jsonschema:"project name or ID"`
	EnvironmentID int    `json:"environmentId" jsonschema:"the environment ID"`
}

GetEnvironmentInput identifies a single deployment environment.

type GetVariableGroupInput

type GetVariableGroupInput struct {
	Project string `json:"project" jsonschema:"project name or ID"`
	GroupID int    `json:"groupId" jsonschema:"the variable group ID"`
}

GetVariableGroupInput identifies a single variable group.

type ListAgentPoolsInput

type ListAgentPoolsInput struct {
	PoolName string `json:"poolName,omitempty" jsonschema:"filter to the agent pool with this name (optional)"`
	PoolType string `json:"poolType,omitempty" jsonschema:"filter by pool type, e.g. automation or deployment (optional)"`
}

ListAgentPoolsInput optionally filters agent pools.

type ListDeploymentGroupTargetsInput added in v0.1.2

type ListDeploymentGroupTargetsInput struct {
	Project           string `json:"project" jsonschema:"project name or ID"`
	DeploymentGroupID int    `json:"deploymentGroupId" jsonschema:"the deployment group ID"`
	Top               int    `json:"top,omitempty" jsonschema:"maximum number of targets to return (optional)"`
	ContinuationToken string `` /* 131-byte string literal not displayed */
}

ListDeploymentGroupTargetsInput selects the deployment group whose targets are listed.

type ListDeploymentGroupsInput added in v0.1.2

type ListDeploymentGroupsInput struct {
	Project           string `json:"project" jsonschema:"project name or ID"`
	Name              string `json:"name,omitempty" jsonschema:"filter to the deployment group with this name (optional)"`
	ContinuationToken string `json:"continuationToken,omitempty" jsonschema:"token from a previous call's response, to fetch the next page (optional)"`
}

ListDeploymentGroupsInput selects the project whose deployment groups are listed.

type ListEnvironmentsInput

type ListEnvironmentsInput struct {
	Project           string `json:"project" jsonschema:"project name or ID"`
	ContinuationToken string `json:"continuationToken,omitempty" jsonschema:"token from a previous call's response, to fetch the next page (optional)"`
}

ListEnvironmentsInput selects the project whose environments are listed.

type ListSecureFilesInput

type ListSecureFilesInput struct {
	Project     string `json:"project" jsonschema:"project name or ID"`
	NamePattern string `json:"namePattern,omitempty" jsonschema:"filter to secure files matching this name pattern, supports wildcards (optional)"`
}

ListSecureFilesInput selects the project whose secure files are listed.

type ListVariableGroupsInput

type ListVariableGroupsInput struct {
	Project      string `json:"project" jsonschema:"project name or ID"`
	GroupName    string `json:"groupName,omitempty" jsonschema:"filter to variable groups with this name (optional)"`
	ActionFilter string `json:"actionFilter,omitempty" jsonschema:"filter by the permitted action, e.g. manage (optional)"`
}

ListVariableGroupsInput selects the project whose variable groups are listed.

type SecureFile

type SecureFile struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

SecureFile is a secure file stored for use by pipelines.

type VariableGroup

type VariableGroup struct {
	ID          int    `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Type        string `json:"type,omitempty"`
	Variables   any    `json:"variables,omitempty"`
}

VariableGroup is a named collection of pipeline variables.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL