Documentation
¶
Index ¶
- Variables
- type AadLoginPromptOption
- type AadOauthTokenRequest
- type AadOauthTokenResult
- type AddAgentArgs
- type AddAgentCloudArgs
- type AddAgentPoolArgs
- type AddAgentQueueArgs
- type AddDeploymentGroupArgs
- type AddTaskGroupArgs
- type AddVariableGroupArgs
- type AgentChangeEvent
- type AgentJobRequestMessage
- type AgentMigrationMessage
- type AgentPoolEvent
- type AgentQueueEvent
- type AgentQueuesEvent
- type AgentRefreshMessage
- type AuditAction
- type AuthenticationSchemeReference
- type AuthorizationHeader
- type AzureKeyVaultPermission
- type AzureKeyVaultVariableGroupProviderData
- type AzureKeyVaultVariableValue
- type AzureManagementGroup
- type AzureManagementGroupQueryResult
- type AzurePermission
- type AzureResourcePermission
- type AzureRoleAssignmentPermission
- type AzureSpnOperationStatus
- type AzureSubscription
- type AzureSubscriptionQueryResult
- type Client
- type ClientCertificate
- type ClientImpl
- func (client *ClientImpl) AddAgent(ctx context.Context, args AddAgentArgs) (*TaskAgent, error)
- func (client *ClientImpl) AddAgentCloud(ctx context.Context, args AddAgentCloudArgs) (*TaskAgentCloud, error)
- func (client *ClientImpl) AddAgentPool(ctx context.Context, args AddAgentPoolArgs) (*TaskAgentPool, error)
- func (client *ClientImpl) AddAgentQueue(ctx context.Context, args AddAgentQueueArgs) (*TaskAgentQueue, error)
- func (client *ClientImpl) AddDeploymentGroup(ctx context.Context, args AddDeploymentGroupArgs) (*DeploymentGroup, error)
- func (client *ClientImpl) AddTaskGroup(ctx context.Context, args AddTaskGroupArgs) (*TaskGroup, error)
- func (client *ClientImpl) AddVariableGroup(ctx context.Context, args AddVariableGroupArgs) (*VariableGroup, error)
- func (client *ClientImpl) DeleteAgent(ctx context.Context, args DeleteAgentArgs) error
- func (client *ClientImpl) DeleteAgentCloud(ctx context.Context, args DeleteAgentCloudArgs) (*TaskAgentCloud, error)
- func (client *ClientImpl) DeleteAgentPool(ctx context.Context, args DeleteAgentPoolArgs) error
- func (client *ClientImpl) DeleteAgentQueue(ctx context.Context, args DeleteAgentQueueArgs) error
- func (client *ClientImpl) DeleteDeploymentGroup(ctx context.Context, args DeleteDeploymentGroupArgs) error
- func (client *ClientImpl) DeleteDeploymentTarget(ctx context.Context, args DeleteDeploymentTargetArgs) error
- func (client *ClientImpl) DeleteTaskGroup(ctx context.Context, args DeleteTaskGroupArgs) error
- func (client *ClientImpl) DeleteVariableGroup(ctx context.Context, args DeleteVariableGroupArgs) error
- func (client *ClientImpl) GetAgent(ctx context.Context, args GetAgentArgs) (*TaskAgent, error)
- func (client *ClientImpl) GetAgentCloud(ctx context.Context, args GetAgentCloudArgs) (*TaskAgentCloud, error)
- func (client *ClientImpl) GetAgentCloudRequests(ctx context.Context, args GetAgentCloudRequestsArgs) (*[]TaskAgentCloudRequest, error)
- func (client *ClientImpl) GetAgentCloudTypes(ctx context.Context, args GetAgentCloudTypesArgs) (*[]TaskAgentCloudType, error)
- func (client *ClientImpl) GetAgentClouds(ctx context.Context, args GetAgentCloudsArgs) (*[]TaskAgentCloud, error)
- func (client *ClientImpl) GetAgentPool(ctx context.Context, args GetAgentPoolArgs) (*TaskAgentPool, error)
- func (client *ClientImpl) GetAgentPools(ctx context.Context, args GetAgentPoolsArgs) (*[]TaskAgentPool, error)
- func (client *ClientImpl) GetAgentPoolsByIds(ctx context.Context, args GetAgentPoolsByIdsArgs) (*[]TaskAgentPool, error)
- func (client *ClientImpl) GetAgentQueue(ctx context.Context, args GetAgentQueueArgs) (*TaskAgentQueue, error)
- func (client *ClientImpl) GetAgentQueues(ctx context.Context, args GetAgentQueuesArgs) (*[]TaskAgentQueue, error)
- func (client *ClientImpl) GetAgentQueuesByIds(ctx context.Context, args GetAgentQueuesByIdsArgs) (*[]TaskAgentQueue, error)
- func (client *ClientImpl) GetAgentQueuesByNames(ctx context.Context, args GetAgentQueuesByNamesArgs) (*[]TaskAgentQueue, error)
- func (client *ClientImpl) GetAgents(ctx context.Context, args GetAgentsArgs) (*[]TaskAgent, error)
- func (client *ClientImpl) GetDeploymentGroup(ctx context.Context, args GetDeploymentGroupArgs) (*DeploymentGroup, error)
- func (client *ClientImpl) GetDeploymentGroups(ctx context.Context, args GetDeploymentGroupsArgs) (*GetDeploymentGroupsResponseValue, error)
- func (client *ClientImpl) GetDeploymentTarget(ctx context.Context, args GetDeploymentTargetArgs) (*DeploymentMachine, error)
- func (client *ClientImpl) GetDeploymentTargets(ctx context.Context, args GetDeploymentTargetsArgs) (*GetDeploymentTargetsResponseValue, error)
- func (client *ClientImpl) GetTaskGroups(ctx context.Context, args GetTaskGroupsArgs) (*[]TaskGroup, error)
- func (client *ClientImpl) GetVariableGroup(ctx context.Context, args GetVariableGroupArgs) (*VariableGroup, error)
- func (client *ClientImpl) GetVariableGroups(ctx context.Context, args GetVariableGroupsArgs) (*[]VariableGroup, error)
- func (client *ClientImpl) GetVariableGroupsById(ctx context.Context, args GetVariableGroupsByIdArgs) (*[]VariableGroup, error)
- func (client *ClientImpl) GetYamlSchema(ctx context.Context, args GetYamlSchemaArgs) (interface{}, error)
- func (client *ClientImpl) ReplaceAgent(ctx context.Context, args ReplaceAgentArgs) (*TaskAgent, error)
- func (client *ClientImpl) UpdateAgent(ctx context.Context, args UpdateAgentArgs) (*TaskAgent, error)
- func (client *ClientImpl) UpdateAgentPool(ctx context.Context, args UpdateAgentPoolArgs) (*TaskAgentPool, error)
- func (client *ClientImpl) UpdateDeploymentGroup(ctx context.Context, args UpdateDeploymentGroupArgs) (*DeploymentGroup, error)
- func (client *ClientImpl) UpdateDeploymentTargets(ctx context.Context, args UpdateDeploymentTargetsArgs) (*[]DeploymentMachine, error)
- func (client *ClientImpl) UpdateTaskGroup(ctx context.Context, args UpdateTaskGroupArgs) (*TaskGroup, error)
- func (client *ClientImpl) UpdateVariableGroup(ctx context.Context, args UpdateVariableGroupArgs) (*VariableGroup, error)
- type CounterVariable
- type DataSource
- type DataSourceBinding
- type DataSourceDetails
- type DeleteAgentArgs
- type DeleteAgentCloudArgs
- type DeleteAgentPoolArgs
- type DeleteAgentQueueArgs
- type DeleteDeploymentGroupArgs
- type DeleteDeploymentTargetArgs
- type DeleteTaskGroupArgs
- type DeleteVariableGroupArgs
- type Demand
- type DemandEquals
- type DemandExists
- type DemandMinimumVersion
- type DependencyBinding
- type DependencyData
- type DependsOn
- type DeploymentGatesChangeEvent
- type DeploymentGroup
- type DeploymentGroupActionFilter
- type DeploymentGroupCreateParameter
- type DeploymentGroupCreateParameterPoolProperty
- type DeploymentGroupExpands
- type DeploymentGroupMetrics
- type DeploymentGroupReference
- type DeploymentGroupUpdateParameter
- type DeploymentMachine
- type DeploymentMachineChangedData
- type DeploymentMachineExpands
- type DeploymentMachineGroup
- type DeploymentMachineGroupReference
- type DeploymentMachinesChangeEvent
- type DeploymentPoolSummary
- type DeploymentPoolSummaryExpands
- type DeploymentTargetExpands
- type DeploymentTargetUpdateParameter
- type DiagnosticLogMetadata
- type EndpointAuthorization
- type EndpointUrl
- type EnvironmentActionFilter
- type EnvironmentCreateParameter
- type EnvironmentDeploymentExecutionRecord
- type EnvironmentExpands
- type EnvironmentInstance
- type EnvironmentLinkedResourceReference
- type EnvironmentReference
- type EnvironmentResource
- type EnvironmentResourceReference
- type EnvironmentResourceType
- type EnvironmentUpdateParameter
- type EventsConfig
- type ExpressionValidationItem
- type GetAgentArgs
- type GetAgentCloudArgs
- type GetAgentCloudRequestsArgs
- type GetAgentCloudTypesArgs
- type GetAgentCloudsArgs
- type GetAgentPoolArgs
- type GetAgentPoolsArgs
- type GetAgentPoolsByIdsArgs
- type GetAgentQueueArgs
- type GetAgentQueuesArgs
- type GetAgentQueuesByIdsArgs
- type GetAgentQueuesByNamesArgs
- type GetAgentsArgs
- type GetDeploymentGroupArgs
- type GetDeploymentGroupsArgs
- type GetDeploymentGroupsResponseValue
- type GetDeploymentTargetArgs
- type GetDeploymentTargetsArgs
- type GetDeploymentTargetsResponseValue
- type GetTaskGroupsArgs
- type GetVariableGroupArgs
- type GetVariableGroupsArgs
- type GetVariableGroupsByIdArgs
- type GetYamlSchemaArgs
- type HelpLink
- type InputBindingContext
- type InputValidationItem
- type InputValidationRequest
- type Issue
- type IssueType
- type JobAssignedEvent
- type JobCancelMessage
- type JobCompletedEvent
- type JobEnvironment
- type JobEvent
- type JobEventConfig
- type JobEventsConfig
- type JobOption
- type JobRequestMessage
- type JobStartedEvent
- type KubernetesResource
- type KubernetesResourceCreateParameters
- type MachineGroupActionFilter
- type MarketplacePurchasedLicense
- type MaskHint
- type MaskType
- type MetricsColumnMetaData
- type MetricsColumnsHeader
- type MetricsRow
- type PackageMetadata
- type PackageVersion
- type PlanEnvironment
- type PlanGroupStatus
- type PlanGroupStatusFilter
- type ProjectReference
- type PublishTaskGroupMetadata
- type ReplaceAgentArgs
- type ResourceFilterOptions
- type ResourceFilters
- type ResourceItem
- type ResourceLimit
- type ResourceUsage
- type ResourcesHubData
- type ResultTransformationDetails
- type SecureFile
- type SecureFileActionFilter
- type SecureFileEvent
- type SendJobResponse
- type ServerExecutionDefinition
- type ServerTaskRequestMessage
- type ServiceEndpoint
- type ServiceEndpointAuthenticationScheme
- type ServiceEndpointDetails
- type ServiceEndpointExecutionData
- type ServiceEndpointExecutionRecord
- type ServiceEndpointExecutionRecordsInput
- type ServiceEndpointRequest
- type ServiceEndpointRequestResult
- type ServiceEndpointType
- type TaskAgent
- type TaskAgentAuthorization
- type TaskAgentCloud
- type TaskAgentCloudRequest
- type TaskAgentCloudType
- type TaskAgentDelaySource
- type TaskAgentJob
- type TaskAgentJobRequest
- type TaskAgentJobResultFilter
- type TaskAgentJobStep
- type TaskAgentJobStepType
- type TaskAgentJobTask
- type TaskAgentJobVariable
- type TaskAgentManualUpdate
- type TaskAgentMessage
- type TaskAgentMinAgentVersionRequiredUpdate
- type TaskAgentPool
- type TaskAgentPoolActionFilter
- type TaskAgentPoolMaintenanceDefinition
- type TaskAgentPoolMaintenanceJob
- type TaskAgentPoolMaintenanceJobResult
- type TaskAgentPoolMaintenanceJobStatus
- type TaskAgentPoolMaintenanceJobTargetAgent
- type TaskAgentPoolMaintenanceOptions
- type TaskAgentPoolMaintenanceRetentionPolicy
- type TaskAgentPoolMaintenanceSchedule
- type TaskAgentPoolMaintenanceScheduleDays
- type TaskAgentPoolReference
- type TaskAgentPoolStatus
- type TaskAgentPoolSummary
- type TaskAgentPoolType
- type TaskAgentPublicKey
- type TaskAgentQueue
- type TaskAgentQueueActionFilter
- type TaskAgentReference
- type TaskAgentSession
- type TaskAgentSessionKey
- type TaskAgentStatus
- type TaskAgentStatusFilter
- type TaskAgentUpdate
- type TaskAgentUpdateReason
- type TaskAgentUpdateReasonType
- type TaskAssignedEvent
- type TaskAttachment
- type TaskCompletedEvent
- type TaskDefinition
- type TaskDefinitionEndpoint
- type TaskDefinitionReference
- type TaskDefinitionStatus
- type TaskEvent
- type TaskExecution
- type TaskGroup
- type TaskGroupCreateParameter
- type TaskGroupDefinition
- type TaskGroupExpands
- type TaskGroupQueryOrder
- type TaskGroupRevision
- type TaskGroupStep
- type TaskGroupUpdateParameter
- type TaskHubLicenseDetails
- type TaskInputDefinition
- type TaskInstance
- type TaskLog
- type TaskLogReference
- type TaskOrchestrationContainer
- type TaskOrchestrationItem
- type TaskOrchestrationItemType
- type TaskOrchestrationJob
- type TaskOrchestrationOwner
- type TaskOrchestrationPlan
- type TaskOrchestrationPlanGroup
- type TaskOrchestrationPlanGroupsQueueMetrics
- type TaskOrchestrationPlanReference
- type TaskOrchestrationPlanState
- type TaskOrchestrationQueuedPlan
- type TaskOrchestrationQueuedPlanGroup
- type TaskOutputVariable
- type TaskPackageMetadata
- type TaskReference
- type TaskResult
- type TaskSourceDefinition
- type TaskStartedEvent
- type TaskVersion
- type Timeline
- type TimelineAttempt
- type TimelineRecord
- type TimelineRecordFeedLinesWrapper
- type TimelineRecordState
- type TimelineReference
- type UpdateAgentArgs
- type UpdateAgentPoolArgs
- type UpdateDeploymentGroupArgs
- type UpdateDeploymentTargetsArgs
- type UpdateTaskGroupArgs
- type UpdateVariableGroupArgs
- type ValidationItem
- type VariableGroup
- type VariableGroupActionFilter
- type VariableGroupParameters
- type VariableGroupProviderData
- type VariableGroupQueryOrder
- type VariableValue
- type VirtualMachine
- type VirtualMachineGroup
- type VirtualMachineGroupCreateParameters
Constants ¶
This section is empty.
Variables ¶
var AadLoginPromptOptionValues = aadLoginPromptOptionValuesType{
NoOption: "noOption",
Login: "login",
SelectAccount: "selectAccount",
FreshLogin: "freshLogin",
FreshLoginWithMfa: "freshLoginWithMfa",
}
var AuditActionValues = auditActionValuesType{
Add: "add",
Update: "update",
Delete: "delete",
Undelete: "undelete",
}
var DeploymentGroupActionFilterValues = deploymentGroupActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var DeploymentGroupExpandsValues = deploymentGroupExpandsValuesType{
None: "none",
Machines: "machines",
Tags: "tags",
}
var DeploymentMachineExpandsValues = deploymentMachineExpandsValuesType{
None: "none",
Capabilities: "capabilities",
AssignedRequest: "assignedRequest",
}
var DeploymentPoolSummaryExpandsValues = deploymentPoolSummaryExpandsValuesType{
None: "none",
DeploymentGroups: "deploymentGroups",
Resource: "resource",
}
var DeploymentTargetExpandsValues = deploymentTargetExpandsValuesType{
None: "none",
Capabilities: "capabilities",
AssignedRequest: "assignedRequest",
LastCompletedRequest: "lastCompletedRequest",
}
var EnvironmentActionFilterValues = environmentActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var EnvironmentExpandsValues = environmentExpandsValuesType{
None: "none",
ResourceReferences: "resourceReferences",
}
var EnvironmentResourceTypeValues = environmentResourceTypeValuesType{
Undefined: "undefined",
Generic: "generic",
VirtualMachine: "virtualMachine",
Kubernetes: "kubernetes",
}
var IssueTypeValues = issueTypeValuesType{
Error: "error",
Warning: "warning",
}
var MachineGroupActionFilterValues = machineGroupActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var MaskTypeValues = maskTypeValuesType{
Variable: "variable",
Regex: "regex",
}
var PlanGroupStatusFilterValues = planGroupStatusFilterValuesType{
Running: "running",
Queued: "queued",
All: "all",
}
var PlanGroupStatusValues = planGroupStatusValuesType{
Running: "running",
Queued: "queued",
All: "all",
}
var ResourceAreaId, _ = uuid.Parse("a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd")
var SecureFileActionFilterValues = secureFileActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var TaskAgentJobResultFilterValues = taskAgentJobResultFilterValuesType{
Failed: "failed",
Passed: "passed",
NeverDeployed: "neverDeployed",
All: "all",
}
var TaskAgentJobStepTypeValues = taskAgentJobStepTypeValuesType{
Task: "task",
Action: "action",
}
var TaskAgentPoolActionFilterValues = taskAgentPoolActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var TaskAgentPoolMaintenanceJobResultValues = taskAgentPoolMaintenanceJobResultValuesType{
Succeeded: "succeeded",
Failed: "failed",
Canceled: "canceled",
}
var TaskAgentPoolMaintenanceJobStatusValues = taskAgentPoolMaintenanceJobStatusValuesType{
InProgress: "inProgress",
Completed: "completed",
Cancelling: "cancelling",
Queued: "queued",
}
var TaskAgentPoolMaintenanceScheduleDaysValues = taskAgentPoolMaintenanceScheduleDaysValuesType{
None: "none",
Monday: "monday",
Tuesday: "tuesday",
Wednesday: "wednesday",
Thursday: "thursday",
Friday: "friday",
Saturday: "saturday",
Sunday: "sunday",
All: "all",
}
var TaskAgentPoolTypeValues = taskAgentPoolTypeValuesType{
Automation: "automation",
Deployment: "deployment",
}
var TaskAgentQueueActionFilterValues = taskAgentQueueActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var TaskAgentStatusFilterValues = taskAgentStatusFilterValuesType{
Offline: "offline",
Online: "online",
All: "all",
}
var TaskAgentStatusValues = taskAgentStatusValuesType{
Offline: "offline",
Online: "online",
}
var TaskAgentUpdateReasonTypeValues = taskAgentUpdateReasonTypeValuesType{
Manual: "manual",
MinAgentVersionRequired: "minAgentVersionRequired",
}
var TaskDefinitionStatusValues = taskDefinitionStatusValuesType{
Preinstalled: "preinstalled",
ReceivedInstallOrUpdate: "receivedInstallOrUpdate",
Installed: "installed",
ReceivedUninstall: "receivedUninstall",
Uninstalled: "uninstalled",
RequestedUpdate: "requestedUpdate",
Updated: "updated",
AlreadyUpToDate: "alreadyUpToDate",
InlineUpdateReceived: "inlineUpdateReceived",
}
var TaskGroupExpandsValues = taskGroupExpandsValuesType{
None: "none",
Tasks: "tasks",
}
var TaskGroupQueryOrderValues = taskGroupQueryOrderValuesType{
CreatedOnAscending: "createdOnAscending",
CreatedOnDescending: "createdOnDescending",
}
var TaskOrchestrationItemTypeValues = taskOrchestrationItemTypeValuesType{
Container: "container",
Job: "job",
}
var TaskOrchestrationPlanStateValues = taskOrchestrationPlanStateValuesType{
InProgress: "inProgress",
Queued: "queued",
Completed: "completed",
Throttled: "throttled",
}
var TaskResultValues = taskResultValuesType{
Succeeded: "succeeded",
SucceededWithIssues: "succeededWithIssues",
Failed: "failed",
Canceled: "canceled",
Skipped: "skipped",
Abandoned: "abandoned",
}
var TimelineRecordStateValues = timelineRecordStateValuesType{
Pending: "pending",
InProgress: "inProgress",
Completed: "completed",
}
var VariableGroupActionFilterValues = variableGroupActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var VariableGroupQueryOrderValues = variableGroupQueryOrderValuesType{
IdAscending: "idAscending",
IdDescending: "idDescending",
}
Functions ¶
This section is empty.
Types ¶
type AadLoginPromptOption ¶
type AadLoginPromptOption string
type AadOauthTokenRequest ¶
type AadOauthTokenResult ¶
type AddAgentArgs ¶
type AddAgentArgs struct {
// (required) Details about the agent being added
Agent *TaskAgent
// (required) The agent pool in which to add the agent
PoolId *int
}
Arguments for the AddAgent function
type AddAgentCloudArgs ¶
type AddAgentCloudArgs struct {
// (required)
AgentCloud *TaskAgentCloud
}
Arguments for the AddAgentCloud function
type AddAgentPoolArgs ¶
type AddAgentPoolArgs struct {
// (required) Details about the new agent pool
Pool *TaskAgentPool
}
Arguments for the AddAgentPool function
type AddAgentQueueArgs ¶
type AddAgentQueueArgs struct {
// (required) Details about the queue to create
Queue *TaskAgentQueue
// (optional) Project ID or project name
Project *string
// (optional) Automatically authorize this queue when using YAML
AuthorizePipelines *bool
}
Arguments for the AddAgentQueue function
type AddDeploymentGroupArgs ¶
type AddDeploymentGroupArgs struct {
// (required) Deployment group to create.
DeploymentGroup *DeploymentGroupCreateParameter
// (required) Project ID or project name
Project *string
}
Arguments for the AddDeploymentGroup function
type AddTaskGroupArgs ¶
type AddTaskGroupArgs struct {
// (required) Task group object to create.
TaskGroup *TaskGroupCreateParameter
// (required) Project ID or project name
Project *string
}
Arguments for the AddTaskGroup function
type AddVariableGroupArgs ¶
type AddVariableGroupArgs struct {
// (required) Variable group to add.
Group *VariableGroupParameters
// (required) Project ID or project name
Project *string
}
Arguments for the AddVariableGroup function
type AgentChangeEvent ¶
type AgentChangeEvent struct {
Agent *TaskAgent `json:"agent,omitempty"`
EventType *string `json:"eventType,omitempty"`
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
// Deprecated:
PoolId *int `json:"poolId,omitempty"`
// Deprecated:
TimeStamp *azuredevops.Time `json:"timeStamp,omitempty"`
}
type AgentJobRequestMessage ¶
type AgentJobRequestMessage struct {
Environment *JobEnvironment `json:"environment,omitempty"`
JobId *uuid.UUID `json:"jobId,omitempty"`
JobName *string `json:"jobName,omitempty"`
JobRefName *string `json:"jobRefName,omitempty"`
MessageType *string `json:"messageType,omitempty"`
Plan *TaskOrchestrationPlanReference `json:"plan,omitempty"`
Timeline *TimelineReference `json:"timeline,omitempty"`
LockedUntil *azuredevops.Time `json:"lockedUntil,omitempty"`
LockToken *uuid.UUID `json:"lockToken,omitempty"`
RequestId *uint64 `json:"requestId,omitempty"`
Tasks *[]TaskInstance `json:"tasks,omitempty"`
}
type AgentMigrationMessage ¶
type AgentMigrationMessage struct {
AccessToken *string `json:"accessToken,omitempty"`
}
type AgentPoolEvent ¶
type AgentPoolEvent struct {
EventType *string `json:"eventType,omitempty"`
Pool *TaskAgentPool `json:"pool,omitempty"`
}
type AgentQueueEvent ¶
type AgentQueueEvent struct {
EventType *string `json:"eventType,omitempty"`
Queue *TaskAgentQueue `json:"queue,omitempty"`
}
type AgentQueuesEvent ¶
type AgentQueuesEvent struct {
EventType *string `json:"eventType,omitempty"`
Queues *[]TaskAgentQueue `json:"queues,omitempty"`
}
type AgentRefreshMessage ¶
type AuditAction ¶
type AuditAction string
type AuthorizationHeader ¶
type AzureKeyVaultPermission ¶
type AzureKeyVaultVariableGroupProviderData ¶
type AzureKeyVaultVariableGroupProviderData struct {
LastRefreshedOn *azuredevops.Time `json:"lastRefreshedOn,omitempty"`
ServiceEndpointId *uuid.UUID `json:"serviceEndpointId,omitempty"`
Vault *string `json:"vault,omitempty"`
}
type AzureManagementGroup ¶
type AzureManagementGroup struct {
// Display name of azure management group
DisplayName *string `json:"displayName,omitempty"`
// Id of azure management group
Id *string `json:"id,omitempty"`
// Azure management group name
Name *string `json:"name,omitempty"`
// Id of tenant from which azure management group belongs
TenantId *string `json:"tenantId,omitempty"`
}
Azure Management Group
type AzureManagementGroupQueryResult ¶
type AzureManagementGroupQueryResult struct {
// Error message in case of an exception
ErrorMessage *string `json:"errorMessage,omitempty"`
// List of azure management groups
Value *[]AzureManagementGroup `json:"value,omitempty"`
}
Azure management group query result
type AzurePermission ¶
type AzureResourcePermission ¶
type AzureSpnOperationStatus ¶
type AzureSubscription ¶
type AzureSubscriptionQueryResult ¶
type AzureSubscriptionQueryResult struct {
ErrorMessage *string `json:"errorMessage,omitempty"`
Value *[]AzureSubscription `json:"value,omitempty"`
}
type Client ¶
type Client interface {
// Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, [configure an agent](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) using the agent download package.
AddAgent(context.Context, AddAgentArgs) (*TaskAgent, error)
// [Preview API]
AddAgentCloud(context.Context, AddAgentCloudArgs) (*TaskAgentCloud, error)
// Create an agent pool.
AddAgentPool(context.Context, AddAgentPoolArgs) (*TaskAgentPool, error)
// [Preview API] Create a new agent queue to connect a project to an agent pool.
AddAgentQueue(context.Context, AddAgentQueueArgs) (*TaskAgentQueue, error)
// [Preview API] Create a deployment group.
AddDeploymentGroup(context.Context, AddDeploymentGroupArgs) (*DeploymentGroup, error)
// [Preview API] Create a task group.
AddTaskGroup(context.Context, AddTaskGroupArgs) (*TaskGroup, error)
// [Preview API] Add a variable group.
AddVariableGroup(context.Context, AddVariableGroupArgs) (*VariableGroup, error)
// Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization.
DeleteAgent(context.Context, DeleteAgentArgs) error
// [Preview API]
DeleteAgentCloud(context.Context, DeleteAgentCloudArgs) (*TaskAgentCloud, error)
// Delete an agent pool.
DeleteAgentPool(context.Context, DeleteAgentPoolArgs) error
// [Preview API] Removes an agent queue from a project.
DeleteAgentQueue(context.Context, DeleteAgentQueueArgs) error
// [Preview API] Delete a deployment group.
DeleteDeploymentGroup(context.Context, DeleteDeploymentGroupArgs) error
// [Preview API] Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.
DeleteDeploymentTarget(context.Context, DeleteDeploymentTargetArgs) error
// [Preview API] Delete a task group.
DeleteTaskGroup(context.Context, DeleteTaskGroupArgs) error
// [Preview API] Delete a variable group
DeleteVariableGroup(context.Context, DeleteVariableGroupArgs) error
// Get information about an agent.
GetAgent(context.Context, GetAgentArgs) (*TaskAgent, error)
// [Preview API]
GetAgentCloud(context.Context, GetAgentCloudArgs) (*TaskAgentCloud, error)
// [Preview API]
GetAgentCloudRequests(context.Context, GetAgentCloudRequestsArgs) (*[]TaskAgentCloudRequest, error)
// [Preview API]
GetAgentClouds(context.Context, GetAgentCloudsArgs) (*[]TaskAgentCloud, error)
// [Preview API] Get agent cloud types.
GetAgentCloudTypes(context.Context, GetAgentCloudTypesArgs) (*[]TaskAgentCloudType, error)
// Get information about an agent pool.
GetAgentPool(context.Context, GetAgentPoolArgs) (*TaskAgentPool, error)
// Get a list of agent pools.
GetAgentPools(context.Context, GetAgentPoolsArgs) (*[]TaskAgentPool, error)
// Get a list of agent pools.
GetAgentPoolsByIds(context.Context, GetAgentPoolsByIdsArgs) (*[]TaskAgentPool, error)
// [Preview API] Get information about an agent queue.
GetAgentQueue(context.Context, GetAgentQueueArgs) (*TaskAgentQueue, error)
// [Preview API] Get a list of agent queues.
GetAgentQueues(context.Context, GetAgentQueuesArgs) (*[]TaskAgentQueue, error)
// [Preview API] Get a list of agent queues by their IDs
GetAgentQueuesByIds(context.Context, GetAgentQueuesByIdsArgs) (*[]TaskAgentQueue, error)
// [Preview API] Get a list of agent queues by their names
GetAgentQueuesByNames(context.Context, GetAgentQueuesByNamesArgs) (*[]TaskAgentQueue, error)
// Get a list of agents.
GetAgents(context.Context, GetAgentsArgs) (*[]TaskAgent, error)
// [Preview API] Get a deployment group by its ID.
GetDeploymentGroup(context.Context, GetDeploymentGroupArgs) (*DeploymentGroup, error)
// [Preview API] Get a list of deployment groups by name or IDs.
GetDeploymentGroups(context.Context, GetDeploymentGroupsArgs) (*GetDeploymentGroupsResponseValue, error)
// [Preview API] Get a deployment target by its ID in a deployment group
GetDeploymentTarget(context.Context, GetDeploymentTargetArgs) (*DeploymentMachine, error)
// [Preview API] Get a list of deployment targets in a deployment group.
GetDeploymentTargets(context.Context, GetDeploymentTargetsArgs) (*GetDeploymentTargetsResponseValue, error)
// [Preview API] List task groups.
GetTaskGroups(context.Context, GetTaskGroupsArgs) (*[]TaskGroup, error)
// [Preview API] Get a variable group.
GetVariableGroup(context.Context, GetVariableGroupArgs) (*VariableGroup, error)
// [Preview API] Get variable groups.
GetVariableGroups(context.Context, GetVariableGroupsArgs) (*[]VariableGroup, error)
// [Preview API] Get variable groups by ids.
GetVariableGroupsById(context.Context, GetVariableGroupsByIdArgs) (*[]VariableGroup, error)
GetYamlSchema(context.Context, GetYamlSchemaArgs) (interface{}, error)
// Replace an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove and reconfigure an agent from your organization.
ReplaceAgent(context.Context, ReplaceAgentArgs) (*TaskAgent, error)
// Update agent details.
UpdateAgent(context.Context, UpdateAgentArgs) (*TaskAgent, error)
// Update properties on an agent pool
UpdateAgentPool(context.Context, UpdateAgentPoolArgs) (*TaskAgentPool, error)
// [Preview API] Update a deployment group.
UpdateDeploymentGroup(context.Context, UpdateDeploymentGroupArgs) (*DeploymentGroup, error)
// [Preview API] Update tags of a list of deployment targets in a deployment group.
UpdateDeploymentTargets(context.Context, UpdateDeploymentTargetsArgs) (*[]DeploymentMachine, error)
// [Preview API] Update a task group.
UpdateTaskGroup(context.Context, UpdateTaskGroupArgs) (*TaskGroup, error)
// [Preview API] Update a variable group.
UpdateVariableGroup(context.Context, UpdateVariableGroupArgs) (*VariableGroup, error)
}
func NewClient ¶
func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)
type ClientCertificate ¶
type ClientCertificate struct {
// Gets or sets the value of client certificate.
Value *string `json:"value,omitempty"`
}
type ClientImpl ¶
type ClientImpl struct {
Client azuredevops.Client
}
func (*ClientImpl) AddAgent ¶
func (client *ClientImpl) AddAgent(ctx context.Context, args AddAgentArgs) (*TaskAgent, error)
Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, [configure an agent](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) using the agent download package.
func (*ClientImpl) AddAgentCloud ¶
func (client *ClientImpl) AddAgentCloud(ctx context.Context, args AddAgentCloudArgs) (*TaskAgentCloud, error)
[Preview API]
func (*ClientImpl) AddAgentPool ¶
func (client *ClientImpl) AddAgentPool(ctx context.Context, args AddAgentPoolArgs) (*TaskAgentPool, error)
Create an agent pool.
func (*ClientImpl) AddAgentQueue ¶
func (client *ClientImpl) AddAgentQueue(ctx context.Context, args AddAgentQueueArgs) (*TaskAgentQueue, error)
[Preview API] Create a new agent queue to connect a project to an agent pool.
func (*ClientImpl) AddDeploymentGroup ¶
func (client *ClientImpl) AddDeploymentGroup(ctx context.Context, args AddDeploymentGroupArgs) (*DeploymentGroup, error)
[Preview API] Create a deployment group.
func (*ClientImpl) AddTaskGroup ¶
func (client *ClientImpl) AddTaskGroup(ctx context.Context, args AddTaskGroupArgs) (*TaskGroup, error)
[Preview API] Create a task group.
func (*ClientImpl) AddVariableGroup ¶
func (client *ClientImpl) AddVariableGroup(ctx context.Context, args AddVariableGroupArgs) (*VariableGroup, error)
[Preview API] Add a variable group.
func (*ClientImpl) DeleteAgent ¶
func (client *ClientImpl) DeleteAgent(ctx context.Context, args DeleteAgentArgs) error
Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization.
func (*ClientImpl) DeleteAgentCloud ¶
func (client *ClientImpl) DeleteAgentCloud(ctx context.Context, args DeleteAgentCloudArgs) (*TaskAgentCloud, error)
[Preview API]
func (*ClientImpl) DeleteAgentPool ¶
func (client *ClientImpl) DeleteAgentPool(ctx context.Context, args DeleteAgentPoolArgs) error
Delete an agent pool.
func (*ClientImpl) DeleteAgentQueue ¶
func (client *ClientImpl) DeleteAgentQueue(ctx context.Context, args DeleteAgentQueueArgs) error
[Preview API] Removes an agent queue from a project.
func (*ClientImpl) DeleteDeploymentGroup ¶
func (client *ClientImpl) DeleteDeploymentGroup(ctx context.Context, args DeleteDeploymentGroupArgs) error
[Preview API] Delete a deployment group.
func (*ClientImpl) DeleteDeploymentTarget ¶
func (client *ClientImpl) DeleteDeploymentTarget(ctx context.Context, args DeleteDeploymentTargetArgs) error
[Preview API] Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.
func (*ClientImpl) DeleteTaskGroup ¶
func (client *ClientImpl) DeleteTaskGroup(ctx context.Context, args DeleteTaskGroupArgs) error
[Preview API] Delete a task group.
func (*ClientImpl) DeleteVariableGroup ¶
func (client *ClientImpl) DeleteVariableGroup(ctx context.Context, args DeleteVariableGroupArgs) error
[Preview API] Delete a variable group
func (*ClientImpl) GetAgent ¶
func (client *ClientImpl) GetAgent(ctx context.Context, args GetAgentArgs) (*TaskAgent, error)
Get information about an agent.
func (*ClientImpl) GetAgentCloud ¶
func (client *ClientImpl) GetAgentCloud(ctx context.Context, args GetAgentCloudArgs) (*TaskAgentCloud, error)
[Preview API]
func (*ClientImpl) GetAgentCloudRequests ¶
func (client *ClientImpl) GetAgentCloudRequests(ctx context.Context, args GetAgentCloudRequestsArgs) (*[]TaskAgentCloudRequest, error)
[Preview API]
func (*ClientImpl) GetAgentCloudTypes ¶
func (client *ClientImpl) GetAgentCloudTypes(ctx context.Context, args GetAgentCloudTypesArgs) (*[]TaskAgentCloudType, error)
[Preview API] Get agent cloud types.
func (*ClientImpl) GetAgentClouds ¶
func (client *ClientImpl) GetAgentClouds(ctx context.Context, args GetAgentCloudsArgs) (*[]TaskAgentCloud, error)
[Preview API]
func (*ClientImpl) GetAgentPool ¶
func (client *ClientImpl) GetAgentPool(ctx context.Context, args GetAgentPoolArgs) (*TaskAgentPool, error)
Get information about an agent pool.
func (*ClientImpl) GetAgentPools ¶
func (client *ClientImpl) GetAgentPools(ctx context.Context, args GetAgentPoolsArgs) (*[]TaskAgentPool, error)
Get a list of agent pools.
func (*ClientImpl) GetAgentPoolsByIds ¶
func (client *ClientImpl) GetAgentPoolsByIds(ctx context.Context, args GetAgentPoolsByIdsArgs) (*[]TaskAgentPool, error)
Get a list of agent pools.
func (*ClientImpl) GetAgentQueue ¶
func (client *ClientImpl) GetAgentQueue(ctx context.Context, args GetAgentQueueArgs) (*TaskAgentQueue, error)
[Preview API] Get information about an agent queue.
func (*ClientImpl) GetAgentQueues ¶
func (client *ClientImpl) GetAgentQueues(ctx context.Context, args GetAgentQueuesArgs) (*[]TaskAgentQueue, error)
[Preview API] Get a list of agent queues.
func (*ClientImpl) GetAgentQueuesByIds ¶
func (client *ClientImpl) GetAgentQueuesByIds(ctx context.Context, args GetAgentQueuesByIdsArgs) (*[]TaskAgentQueue, error)
[Preview API] Get a list of agent queues by their IDs
func (*ClientImpl) GetAgentQueuesByNames ¶
func (client *ClientImpl) GetAgentQueuesByNames(ctx context.Context, args GetAgentQueuesByNamesArgs) (*[]TaskAgentQueue, error)
[Preview API] Get a list of agent queues by their names
func (*ClientImpl) GetAgents ¶
func (client *ClientImpl) GetAgents(ctx context.Context, args GetAgentsArgs) (*[]TaskAgent, error)
Get a list of agents.
func (*ClientImpl) GetDeploymentGroup ¶
func (client *ClientImpl) GetDeploymentGroup(ctx context.Context, args GetDeploymentGroupArgs) (*DeploymentGroup, error)
[Preview API] Get a deployment group by its ID.
func (*ClientImpl) GetDeploymentGroups ¶
func (client *ClientImpl) GetDeploymentGroups(ctx context.Context, args GetDeploymentGroupsArgs) (*GetDeploymentGroupsResponseValue, error)
[Preview API] Get a list of deployment groups by name or IDs.
func (*ClientImpl) GetDeploymentTarget ¶
func (client *ClientImpl) GetDeploymentTarget(ctx context.Context, args GetDeploymentTargetArgs) (*DeploymentMachine, error)
[Preview API] Get a deployment target by its ID in a deployment group
func (*ClientImpl) GetDeploymentTargets ¶
func (client *ClientImpl) GetDeploymentTargets(ctx context.Context, args GetDeploymentTargetsArgs) (*GetDeploymentTargetsResponseValue, error)
[Preview API] Get a list of deployment targets in a deployment group.
func (*ClientImpl) GetTaskGroups ¶
func (client *ClientImpl) GetTaskGroups(ctx context.Context, args GetTaskGroupsArgs) (*[]TaskGroup, error)
[Preview API] List task groups.
func (*ClientImpl) GetVariableGroup ¶
func (client *ClientImpl) GetVariableGroup(ctx context.Context, args GetVariableGroupArgs) (*VariableGroup, error)
[Preview API] Get a variable group.
func (*ClientImpl) GetVariableGroups ¶
func (client *ClientImpl) GetVariableGroups(ctx context.Context, args GetVariableGroupsArgs) (*[]VariableGroup, error)
[Preview API] Get variable groups.
func (*ClientImpl) GetVariableGroupsById ¶
func (client *ClientImpl) GetVariableGroupsById(ctx context.Context, args GetVariableGroupsByIdArgs) (*[]VariableGroup, error)
[Preview API] Get variable groups by ids.
func (*ClientImpl) GetYamlSchema ¶
func (client *ClientImpl) GetYamlSchema(ctx context.Context, args GetYamlSchemaArgs) (interface{}, error)
func (*ClientImpl) ReplaceAgent ¶
func (client *ClientImpl) ReplaceAgent(ctx context.Context, args ReplaceAgentArgs) (*TaskAgent, error)
Replace an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove and reconfigure an agent from your organization.
func (*ClientImpl) UpdateAgent ¶
func (client *ClientImpl) UpdateAgent(ctx context.Context, args UpdateAgentArgs) (*TaskAgent, error)
Update agent details.
func (*ClientImpl) UpdateAgentPool ¶
func (client *ClientImpl) UpdateAgentPool(ctx context.Context, args UpdateAgentPoolArgs) (*TaskAgentPool, error)
Update properties on an agent pool
func (*ClientImpl) UpdateDeploymentGroup ¶
func (client *ClientImpl) UpdateDeploymentGroup(ctx context.Context, args UpdateDeploymentGroupArgs) (*DeploymentGroup, error)
[Preview API] Update a deployment group.
func (*ClientImpl) UpdateDeploymentTargets ¶
func (client *ClientImpl) UpdateDeploymentTargets(ctx context.Context, args UpdateDeploymentTargetsArgs) (*[]DeploymentMachine, error)
[Preview API] Update tags of a list of deployment targets in a deployment group.
func (*ClientImpl) UpdateTaskGroup ¶
func (client *ClientImpl) UpdateTaskGroup(ctx context.Context, args UpdateTaskGroupArgs) (*TaskGroup, error)
[Preview API] Update a task group.
func (*ClientImpl) UpdateVariableGroup ¶
func (client *ClientImpl) UpdateVariableGroup(ctx context.Context, args UpdateVariableGroupArgs) (*VariableGroup, error)
[Preview API] Update a variable group.
type CounterVariable ¶
type DataSource ¶
type DataSource struct {
AuthenticationScheme *AuthenticationSchemeReference `json:"authenticationScheme,omitempty"`
EndpointUrl *string `json:"endpointUrl,omitempty"`
Headers *[]AuthorizationHeader `json:"headers,omitempty"`
Name *string `json:"name,omitempty"`
ResourceUrl *string `json:"resourceUrl,omitempty"`
ResultSelector *string `json:"resultSelector,omitempty"`
}
type DataSourceBinding ¶
type DataSourceBinding struct {
// Pagination format supported by this data source(ContinuationToken/SkipTop).
CallbackContextTemplate *string `json:"callbackContextTemplate,omitempty"`
// Subsequent calls needed?
CallbackRequiredTemplate *string `json:"callbackRequiredTemplate,omitempty"`
// Gets or sets the name of the data source.
DataSourceName *string `json:"dataSourceName,omitempty"`
// Gets or sets the endpoint Id.
EndpointId *string `json:"endpointId,omitempty"`
// Gets or sets the url of the service endpoint.
EndpointUrl *string `json:"endpointUrl,omitempty"`
// Gets or sets the authorization headers.
Headers *[]distributedtaskcommon.AuthorizationHeader `json:"headers,omitempty"`
// Defines the initial value of the query params
InitialContextTemplate *string `json:"initialContextTemplate,omitempty"`
// Gets or sets the parameters for the data source.
Parameters *map[string]string `json:"parameters,omitempty"`
// Gets or sets http request body
RequestContent *string `json:"requestContent,omitempty"`
// Gets or sets http request verb
RequestVerb *string `json:"requestVerb,omitempty"`
// Gets or sets the result selector.
ResultSelector *string `json:"resultSelector,omitempty"`
// Gets or sets the result template.
ResultTemplate *string `json:"resultTemplate,omitempty"`
// Gets or sets the target of the data source.
Target *string `json:"target,omitempty"`
}
type DataSourceDetails ¶
type DataSourceDetails struct {
DataSourceName *string `json:"dataSourceName,omitempty"`
DataSourceUrl *string `json:"dataSourceUrl,omitempty"`
Headers *[]AuthorizationHeader `json:"headers,omitempty"`
Parameters *map[string]string `json:"parameters,omitempty"`
ResourceUrl *string `json:"resourceUrl,omitempty"`
ResultSelector *string `json:"resultSelector,omitempty"`
}
type DeleteAgentArgs ¶
type DeleteAgentArgs struct {
// (required) The pool ID to remove the agent from
PoolId *int
// (required) The agent ID to remove
AgentId *int
}
Arguments for the DeleteAgent function
type DeleteAgentCloudArgs ¶
type DeleteAgentCloudArgs struct {
// (required)
AgentCloudId *int
}
Arguments for the DeleteAgentCloud function
type DeleteAgentPoolArgs ¶
type DeleteAgentPoolArgs struct {
// (required) ID of the agent pool to delete
PoolId *int
}
Arguments for the DeleteAgentPool function
type DeleteAgentQueueArgs ¶
type DeleteAgentQueueArgs struct {
// (required) The agent queue to remove
QueueId *int
// (optional) Project ID or project name
Project *string
}
Arguments for the DeleteAgentQueue function
type DeleteDeploymentGroupArgs ¶
type DeleteDeploymentGroupArgs struct {
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group to be deleted.
DeploymentGroupId *int
}
Arguments for the DeleteDeploymentGroup function
type DeleteDeploymentTargetArgs ¶
type DeleteDeploymentTargetArgs struct {
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group in which deployment target is deleted.
DeploymentGroupId *int
// (required) ID of the deployment target to delete.
TargetId *int
}
Arguments for the DeleteDeploymentTarget function
type DeleteTaskGroupArgs ¶
type DeleteTaskGroupArgs struct {
// (required) Project ID or project name
Project *string
// (required) Id of the task group to be deleted.
TaskGroupId *uuid.UUID
// (optional) Comments to delete.
Comment *string
}
Arguments for the DeleteTaskGroup function
type DeleteVariableGroupArgs ¶
type DeleteVariableGroupArgs struct {
// (required) Project ID or project name
Project *string
// (required) Id of the variable group.
GroupId *int
}
Arguments for the DeleteVariableGroup function
type DemandEquals ¶
type DemandExists ¶
type DemandMinimumVersion ¶
type DependencyBinding ¶
type DependencyData ¶
type DependencyData struct {
Input *string `json:"input,omitempty"`
Map *[]azuredevops.KeyValuePair `json:"map,omitempty"`
}
type DependsOn ¶
type DependsOn struct {
Input *string `json:"input,omitempty"`
Map *[]DependencyBinding `json:"map,omitempty"`
}
type DeploymentGatesChangeEvent ¶
type DeploymentGatesChangeEvent struct {
GateNames *[]string `json:"gateNames,omitempty"`
}
type DeploymentGroup ¶
type DeploymentGroup struct {
// Deployment group identifier.
Id *int `json:"id,omitempty"`
// Name of the deployment group.
Name *string `json:"name,omitempty"`
// Deployment pool in which deployment agents are registered.
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
// Project to which the deployment group belongs.
Project *ProjectReference `json:"project,omitempty"`
// Description of the deployment group.
Description *string `json:"description,omitempty"`
// Number of deployment targets in the deployment group.
MachineCount *int `json:"machineCount,omitempty"`
// List of deployment targets in the deployment group.
Machines *[]DeploymentMachine `json:"machines,omitempty"`
// List of unique tags across all deployment targets in the deployment group.
MachineTags *[]string `json:"machineTags,omitempty"`
}
Deployment group.
type DeploymentGroupActionFilter ¶
type DeploymentGroupActionFilter string
[Flags] This is useful in getting a list of deployment groups, filtered for which caller has permissions to take a particular action.
type DeploymentGroupCreateParameter ¶
type DeploymentGroupCreateParameter struct {
// Description of the deployment group.
Description *string `json:"description,omitempty"`
// Name of the deployment group.
Name *string `json:"name,omitempty"`
// Identifier of the deployment pool in which deployment agents are registered.
PoolId *int `json:"poolId,omitempty"`
}
Properties to create Deployment group.
type DeploymentGroupCreateParameterPoolProperty ¶
type DeploymentGroupCreateParameterPoolProperty struct {
// Deployment pool identifier.
Id *int `json:"id,omitempty"`
}
Properties of Deployment pool to create Deployment group.
type DeploymentGroupExpands ¶
type DeploymentGroupExpands string
[Flags] Properties to be included or expanded in deployment group objects. This is useful when getting a single or list of deployment grouops.
type DeploymentGroupMetrics ¶
type DeploymentGroupMetrics struct {
// List of deployment group properties. And types of metrics provided for those properties.
ColumnsHeader *MetricsColumnsHeader `json:"columnsHeader,omitempty"`
// Deployment group.
DeploymentGroup *DeploymentGroupReference `json:"deploymentGroup,omitempty"`
// Values of properties and the metrics. E.g. 1: total count of deployment targets for which 'TargetState' is 'offline'. E.g. 2: Average time of deployment to the deployment targets for which 'LastJobStatus' is 'passed' and 'TargetState' is 'online'.
Rows *[]MetricsRow `json:"rows,omitempty"`
}
Deployment group metrics.
type DeploymentGroupReference ¶
type DeploymentGroupReference struct {
// Deployment group identifier.
Id *int `json:"id,omitempty"`
// Name of the deployment group.
Name *string `json:"name,omitempty"`
// Deployment pool in which deployment agents are registered.
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
// Project to which the deployment group belongs.
Project *ProjectReference `json:"project,omitempty"`
}
Deployment group reference. This is useful for referring a deployment group in another object.
type DeploymentGroupUpdateParameter ¶
type DeploymentGroupUpdateParameter struct {
// Description of the deployment group.
Description *string `json:"description,omitempty"`
// Name of the deployment group.
Name *string `json:"name,omitempty"`
}
Deployment group update parameter.
type DeploymentMachine ¶
type DeploymentMachine struct {
// Deployment agent.
Agent *TaskAgent `json:"agent,omitempty"`
// Deployment target Identifier.
Id *int `json:"id,omitempty"`
// Properties of the deployment target.
Properties interface{} `json:"properties,omitempty"`
// Tags of the deployment target.
Tags *[]string `json:"tags,omitempty"`
}
Deployment target.
type DeploymentMachineChangedData ¶
type DeploymentMachineChangedData struct {
// Deployment agent.
Agent *TaskAgent `json:"agent,omitempty"`
// Deployment target Identifier.
Id *int `json:"id,omitempty"`
// Properties of the deployment target.
Properties interface{} `json:"properties,omitempty"`
// Tags of the deployment target.
Tags *[]string `json:"tags,omitempty"`
AddedTags *[]string `json:"addedTags,omitempty"`
DeletedTags *[]string `json:"deletedTags,omitempty"`
}
type DeploymentMachineGroup ¶
type DeploymentMachineGroup struct {
Id *int `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
Project *ProjectReference `json:"project,omitempty"`
Machines *[]DeploymentMachine `json:"machines,omitempty"`
Size *int `json:"size,omitempty"`
}
type DeploymentMachineGroupReference ¶
type DeploymentMachineGroupReference struct {
Id *int `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
Project *ProjectReference `json:"project,omitempty"`
}
type DeploymentMachinesChangeEvent ¶
type DeploymentMachinesChangeEvent struct {
MachineGroupReference *DeploymentGroupReference `json:"machineGroupReference,omitempty"`
Machines *[]DeploymentMachineChangedData `json:"machines,omitempty"`
}
type DeploymentPoolSummary ¶
type DeploymentPoolSummary struct {
// List of deployment groups referring to the deployment pool.
DeploymentGroups *[]DeploymentGroupReference `json:"deploymentGroups,omitempty"`
// Number of deployment agents that are offline.
OfflineAgentsCount *int `json:"offlineAgentsCount,omitempty"`
// Number of deployment agents that are online.
OnlineAgentsCount *int `json:"onlineAgentsCount,omitempty"`
// Deployment pool.
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
// Virtual machine Resource referring in pool.
Resource *EnvironmentResourceReference `json:"resource,omitempty"`
}
Deployment pool summary.
type DeploymentPoolSummaryExpands ¶
type DeploymentPoolSummaryExpands string
[Flags] Properties to be included or expanded in deployment pool summary objects. This is useful when getting a single or list of deployment pool summaries.
type DeploymentTargetExpands ¶
type DeploymentTargetExpands string
[Flags] Properties to be included or expanded in deployment target objects. This is useful when getting a single or list of deployment targets.
type DeploymentTargetUpdateParameter ¶
type DeploymentTargetUpdateParameter struct {
// Identifier of the deployment target.
Id *int `json:"id,omitempty"`
Tags *[]string `json:"tags,omitempty"`
}
Deployment target update parameter.
type DiagnosticLogMetadata ¶
type DiagnosticLogMetadata struct {
AgentId *int `json:"agentId,omitempty"`
AgentName *string `json:"agentName,omitempty"`
FileName *string `json:"fileName,omitempty"`
PhaseName *string `json:"phaseName,omitempty"`
PhaseResult *string `json:"phaseResult,omitempty"`
PoolId *int `json:"poolId,omitempty"`
}
type EndpointAuthorization ¶
type EndpointUrl ¶
type EndpointUrl struct {
// Gets or sets the dependency bindings.
DependsOn *DependsOn `json:"dependsOn,omitempty"`
// Gets or sets the display name of service endpoint url.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the help text of service endpoint url.
HelpText *string `json:"helpText,omitempty"`
// Gets or sets the visibility of service endpoint url.
IsVisible *string `json:"isVisible,omitempty"`
// Gets or sets the value of service endpoint url.
Value *string `json:"value,omitempty"`
}
Represents url of the service endpoint.
type EnvironmentActionFilter ¶
type EnvironmentActionFilter string
[Flags] This is useful in getting a list of Environments, filtered for which caller has permissions to take a particular action.
type EnvironmentCreateParameter ¶
type EnvironmentCreateParameter struct {
// Description of the environment.
Description *string `json:"description,omitempty"`
// Name of the environment.
Name *string `json:"name,omitempty"`
}
Properties to create Environment.
type EnvironmentDeploymentExecutionRecord ¶
type EnvironmentDeploymentExecutionRecord struct {
// Definition of the environment deployment execution owner
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
// Id of the Environment
EnvironmentId *int `json:"environmentId,omitempty"`
// Finish time of the environment deployment execution
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
// Id of the Environment deployment execution history record
Id *uint64 `json:"id,omitempty"`
// Job Attempt
JobAttempt *int `json:"jobAttempt,omitempty"`
// Job name
JobName *string `json:"jobName,omitempty"`
// Owner of the environment deployment execution record
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
// Plan Id
PlanId *uuid.UUID `json:"planId,omitempty"`
// Plan type of the environment deployment execution record
PlanType *string `json:"planType,omitempty"`
// Queue time of the environment deployment execution
QueueTime *azuredevops.Time `json:"queueTime,omitempty"`
// Request identifier of the Environment deployment execution history record
RequestIdentifier *string `json:"requestIdentifier,omitempty"`
// Resource Id
ResourceId *int `json:"resourceId,omitempty"`
// Result of the environment deployment execution
Result *TaskResult `json:"result,omitempty"`
// Project Id
ScopeId *uuid.UUID `json:"scopeId,omitempty"`
// Service owner Id
ServiceOwner *uuid.UUID `json:"serviceOwner,omitempty"`
// Stage Attempt
StageAttempt *int `json:"stageAttempt,omitempty"`
// Stage name
StageName *string `json:"stageName,omitempty"`
// Start time of the environment deployment execution
StartTime *azuredevops.Time `json:"startTime,omitempty"`
}
EnvironmentDeploymentExecutionRecord.
type EnvironmentExpands ¶
type EnvironmentExpands string
[Flags] Properties to be included or expanded in environment objects. This is useful when getting a single environment.
type EnvironmentInstance ¶
type EnvironmentInstance struct {
// Identity reference of the user who created the Environment.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// Creation time of the Environment
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// Description of the Environment.
Description *string `json:"description,omitempty"`
// Id of the Environment
Id *int `json:"id,omitempty"`
// Identity reference of the user who last modified the Environment.
LastModifiedBy *webapi.IdentityRef `json:"lastModifiedBy,omitempty"`
// Last modified time of the Environment
LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"`
// Name of the Environment.
Name *string `json:"name,omitempty"`
Resources *[]EnvironmentResourceReference `json:"resources,omitempty"`
}
Environment.
type EnvironmentLinkedResourceReference ¶
type EnvironmentLinkedResourceReference struct {
// Id of the resource.
Id *string `json:"id,omitempty"`
// Type of resource.
TypeName *string `json:"typeName,omitempty"`
}
EnvironmentLinkedResourceReference.
type EnvironmentReference ¶
type EnvironmentResource ¶
type EnvironmentResource struct {
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
EnvironmentReference *EnvironmentReference `json:"environmentReference,omitempty"`
Id *int `json:"id,omitempty"`
LastModifiedBy *webapi.IdentityRef `json:"lastModifiedBy,omitempty"`
LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"`
Name *string `json:"name,omitempty"`
// Environment resource type
Type *EnvironmentResourceType `json:"type,omitempty"`
}
type EnvironmentResourceReference ¶
type EnvironmentResourceReference struct {
// Id of the resource.
Id *int `json:"id,omitempty"`
// Name of the resource.
Name *string `json:"name,omitempty"`
// Type of the resource.
Type *EnvironmentResourceType `json:"type,omitempty"`
}
EnvironmentResourceReference.
type EnvironmentUpdateParameter ¶
type EnvironmentUpdateParameter struct {
// Description of the environment.
Description *string `json:"description,omitempty"`
// Name of the environment.
Name *string `json:"name,omitempty"`
}
Properties to update Environment.
type EventsConfig ¶
type EventsConfig struct {
}
type ExpressionValidationItem ¶
type ExpressionValidationItem struct {
// Tells whether the current input is valid or not
IsValid *bool `json:"isValid,omitempty"`
// Reason for input validation failure
Reason *string `json:"reason,omitempty"`
// Type of validation item
Type *string `json:"type,omitempty"`
// Value to validate. The conditional expression to validate for the input for "expression" type Eg:eq(variables['Build.SourceBranch'], 'refs/heads/master');eq(value, 'refs/heads/master')
Value *string `json:"value,omitempty"`
}
type GetAgentArgs ¶
type GetAgentArgs struct {
// (required) The agent pool containing the agent
PoolId *int
// (required) The agent ID to get information about
AgentId *int
// (optional) Whether to include the agent's capabilities in the response
IncludeCapabilities *bool
// (optional) Whether to include details about the agent's current work
IncludeAssignedRequest *bool
// (optional) Whether to include details about the agents' most recent completed work
IncludeLastCompletedRequest *bool
// (optional) Filter which custom properties will be returned
PropertyFilters *[]string
}
Arguments for the GetAgent function
type GetAgentCloudArgs ¶
type GetAgentCloudArgs struct {
// (required)
AgentCloudId *int
}
Arguments for the GetAgentCloud function
type GetAgentCloudRequestsArgs ¶
type GetAgentCloudRequestsArgs struct {
// (required)
AgentCloudId *int
}
Arguments for the GetAgentCloudRequests function
type GetAgentCloudTypesArgs ¶
type GetAgentCloudTypesArgs struct {
}
Arguments for the GetAgentCloudTypes function
type GetAgentCloudsArgs ¶
type GetAgentCloudsArgs struct {
}
Arguments for the GetAgentClouds function
type GetAgentPoolArgs ¶
type GetAgentPoolArgs struct {
// (required) An agent pool ID
PoolId *int
// (optional) Agent pool properties (comma-separated)
Properties *[]string
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentPoolActionFilter
}
Arguments for the GetAgentPool function
type GetAgentPoolsArgs ¶
type GetAgentPoolsArgs struct {
// (optional) Filter by name
PoolName *string
// (optional) Filter by agent pool properties (comma-separated)
Properties *[]string
// (optional) Filter by pool type
PoolType *TaskAgentPoolType
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentPoolActionFilter
}
Arguments for the GetAgentPools function
type GetAgentPoolsByIdsArgs ¶
type GetAgentPoolsByIdsArgs struct {
// (required) pool Ids to fetch
PoolIds *[]int
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentPoolActionFilter
}
Arguments for the GetAgentPoolsByIds function
type GetAgentQueueArgs ¶
type GetAgentQueueArgs struct {
// (required) The agent queue to get information about
QueueId *int
// (optional) Project ID or project name
Project *string
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentQueueActionFilter
}
Arguments for the GetAgentQueue function
type GetAgentQueuesArgs ¶
type GetAgentQueuesArgs struct {
// (optional) Project ID or project name
Project *string
// (optional) Filter on the agent queue name
QueueName *string
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentQueueActionFilter
}
Arguments for the GetAgentQueues function
type GetAgentQueuesByIdsArgs ¶
type GetAgentQueuesByIdsArgs struct {
// (required) A comma-separated list of agent queue IDs to retrieve
QueueIds *[]int
// (optional) Project ID or project name
Project *string
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentQueueActionFilter
}
Arguments for the GetAgentQueuesByIds function
type GetAgentQueuesByNamesArgs ¶
type GetAgentQueuesByNamesArgs struct {
// (required) A comma-separated list of agent names to retrieve
QueueNames *[]string
// (optional) Project ID or project name
Project *string
// (optional) Filter by whether the calling user has use or manage permissions
ActionFilter *TaskAgentQueueActionFilter
}
Arguments for the GetAgentQueuesByNames function
type GetAgentsArgs ¶
type GetAgentsArgs struct {
// (required) The agent pool containing the agents
PoolId *int
// (optional) Filter on agent name
AgentName *string
// (optional) Whether to include the agents' capabilities in the response
IncludeCapabilities *bool
// (optional) Whether to include details about the agents' current work
IncludeAssignedRequest *bool
// (optional) Whether to include details about the agents' most recent completed work
IncludeLastCompletedRequest *bool
// (optional) Filter which custom properties will be returned
PropertyFilters *[]string
// (optional) Filter by demands the agents can satisfy
Demands *[]string
}
Arguments for the GetAgents function
type GetDeploymentGroupArgs ¶
type GetDeploymentGroupArgs struct {
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group.
DeploymentGroupId *int
// (optional) Get the deployment group only if this action can be performed on it.
ActionFilter *DeploymentGroupActionFilter
// (optional) Include these additional details in the returned object.
Expand *DeploymentGroupExpands
}
Arguments for the GetDeploymentGroup function
type GetDeploymentGroupsArgs ¶
type GetDeploymentGroupsArgs struct {
// (required) Project ID or project name
Project *string
// (optional) Name of the deployment group.
Name *string
// (optional) Get only deployment groups on which this action can be performed.
ActionFilter *DeploymentGroupActionFilter
// (optional) Include these additional details in the returned objects.
Expand *DeploymentGroupExpands
// (optional) Get deployment groups with names greater than this continuationToken lexicographically.
ContinuationToken *string
// (optional) Maximum number of deployment groups to return. Default is **1000**.
Top *int
// (optional) Comma separated list of IDs of the deployment groups.
Ids *[]int
}
Arguments for the GetDeploymentGroups function
type GetDeploymentGroupsResponseValue ¶
type GetDeploymentGroupsResponseValue struct {
Value []DeploymentGroup
// The continuation token to be used to get the next page of results.
ContinuationToken string
}
Return type for the GetDeploymentGroups function
type GetDeploymentTargetArgs ¶
type GetDeploymentTargetArgs struct {
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group to which deployment target belongs.
DeploymentGroupId *int
// (required) ID of the deployment target to return.
TargetId *int
// (optional) Include these additional details in the returned objects.
Expand *DeploymentTargetExpands
}
Arguments for the GetDeploymentTarget function
type GetDeploymentTargetsArgs ¶
type GetDeploymentTargetsArgs struct {
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group.
DeploymentGroupId *int
// (optional) Get only the deployment targets that contain all these comma separted list of tags.
Tags *[]string
// (optional) Name pattern of the deployment targets to return.
Name *string
// (optional) When set to true, treats **name** as pattern. Else treats it as absolute match. Default is **false**.
PartialNameMatch *bool
// (optional) Include these additional details in the returned objects.
Expand *DeploymentTargetExpands
// (optional) Get only deployment targets that have this status.
AgentStatus *TaskAgentStatusFilter
// (optional) Get only deployment targets that have this last job result.
AgentJobResult *TaskAgentJobResultFilter
// (optional) Get deployment targets with names greater than this continuationToken lexicographically.
ContinuationToken *string
// (optional) Maximum number of deployment targets to return. Default is **1000**.
Top *int
// (optional) Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.
Enabled *bool
// (optional)
PropertyFilters *[]string
}
Arguments for the GetDeploymentTargets function
type GetDeploymentTargetsResponseValue ¶
type GetDeploymentTargetsResponseValue struct {
Value []DeploymentMachine
// The continuation token to be used to get the next page of results.
ContinuationToken string
}
Return type for the GetDeploymentTargets function
type GetTaskGroupsArgs ¶
type GetTaskGroupsArgs struct {
// (required) Project ID or project name
Project *string
// (optional) Id of the task group.
TaskGroupId *uuid.UUID
// (optional) 'true' to recursively expand task groups. Default is 'false'.
Expanded *bool
// (optional) Guid of the taskId to filter.
TaskIdFilter *uuid.UUID
// (optional) 'true'to include deleted task groups. Default is 'false'.
Deleted *bool
// (optional) Number of task groups to get.
Top *int
// (optional) Gets the task groups after the continuation token provided.
ContinuationToken *azuredevops.Time
// (optional) Gets the results in the defined order. Default is 'CreatedOnDescending'.
QueryOrder *TaskGroupQueryOrder
}
Arguments for the GetTaskGroups function
type GetVariableGroupArgs ¶
type GetVariableGroupArgs struct {
// (required) Project ID or project name
Project *string
// (required) Id of the variable group.
GroupId *int
}
Arguments for the GetVariableGroup function
type GetVariableGroupsArgs ¶
type GetVariableGroupsArgs struct {
// (required) Project ID or project name
Project *string
// (optional) Name of variable group.
GroupName *string
// (optional) Action filter for the variable group. It specifies the action which can be performed on the variable groups.
ActionFilter *VariableGroupActionFilter
// (optional) Number of variable groups to get.
Top *int
// (optional) Gets the variable groups after the continuation token provided.
ContinuationToken *int
// (optional) Gets the results in the defined order. Default is 'IdDescending'.
QueryOrder *VariableGroupQueryOrder
}
Arguments for the GetVariableGroups function
type GetVariableGroupsByIdArgs ¶
type GetVariableGroupsByIdArgs struct {
// (required) Project ID or project name
Project *string
// (required) Comma separated list of Ids of variable groups.
GroupIds *[]int
}
Arguments for the GetVariableGroupsById function
type InputBindingContext ¶
type InputBindingContext struct {
// Value of the input
Value *string `json:"value,omitempty"`
}
type InputValidationItem ¶
type InputValidationItem struct {
// Tells whether the current input is valid or not
IsValid *bool `json:"isValid,omitempty"`
// Reason for input validation failure
Reason *string `json:"reason,omitempty"`
// Type of validation item
Type *string `json:"type,omitempty"`
// Value to validate. The conditional expression to validate for the input for "expression" type Eg:eq(variables['Build.SourceBranch'], 'refs/heads/master');eq(value, 'refs/heads/master')
Value *string `json:"value,omitempty"`
// Provides binding context for the expression to evaluate
Context *InputBindingContext `json:"context,omitempty"`
}
type InputValidationRequest ¶
type InputValidationRequest struct {
Inputs *map[string]ValidationItem `json:"inputs,omitempty"`
}
type JobAssignedEvent ¶
type JobAssignedEvent struct {
JobId *uuid.UUID `json:"jobId,omitempty"`
Name *string `json:"name,omitempty"`
Request *TaskAgentJobRequest `json:"request,omitempty"`
}
type JobCancelMessage ¶
type JobCompletedEvent ¶
type JobCompletedEvent struct {
JobId *uuid.UUID `json:"jobId,omitempty"`
Name *string `json:"name,omitempty"`
RequestId *uint64 `json:"requestId,omitempty"`
Result *TaskResult `json:"result,omitempty"`
}
type JobEnvironment ¶
type JobEnvironment struct {
Endpoints *[]ServiceEndpoint `json:"endpoints,omitempty"`
Mask *[]MaskHint `json:"mask,omitempty"`
Options *map[uuid.UUID]JobOption `json:"options,omitempty"`
SecureFiles *[]SecureFile `json:"secureFiles,omitempty"`
// Gets or sets the endpoint used for communicating back to the calling service.
SystemConnection *ServiceEndpoint `json:"systemConnection,omitempty"`
Variables *map[string]string `json:"variables,omitempty"`
}
Represents the context of variables and vectors for a job request.
type JobEventConfig ¶
type JobEventConfig struct {
Timeout *string `json:"timeout,omitempty"`
}
type JobEventsConfig ¶
type JobEventsConfig struct {
JobAssigned *JobEventConfig `json:"jobAssigned,omitempty"`
JobCompleted *JobEventConfig `json:"jobCompleted,omitempty"`
JobStarted *JobEventConfig `json:"jobStarted,omitempty"`
}
type JobOption ¶
type JobOption struct {
Data *map[string]string `json:"data,omitempty"`
// Gets the id of the option.
Id *uuid.UUID `json:"id,omitempty"`
}
Represents an option that may affect the way an agent runs the job.
type JobRequestMessage ¶
type JobRequestMessage struct {
Environment *JobEnvironment `json:"environment,omitempty"`
JobId *uuid.UUID `json:"jobId,omitempty"`
JobName *string `json:"jobName,omitempty"`
JobRefName *string `json:"jobRefName,omitempty"`
MessageType *string `json:"messageType,omitempty"`
Plan *TaskOrchestrationPlanReference `json:"plan,omitempty"`
Timeline *TimelineReference `json:"timeline,omitempty"`
}
type JobStartedEvent ¶
type KubernetesResource ¶
type KubernetesResource struct {
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
EnvironmentReference *EnvironmentReference `json:"environmentReference,omitempty"`
Id *int `json:"id,omitempty"`
LastModifiedBy *webapi.IdentityRef `json:"lastModifiedBy,omitempty"`
LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"`
Name *string `json:"name,omitempty"`
// Environment resource type
Type *EnvironmentResourceType `json:"type,omitempty"`
ClusterName *string `json:"clusterName,omitempty"`
Namespace *string `json:"namespace,omitempty"`
ServiceEndpointId *uuid.UUID `json:"serviceEndpointId,omitempty"`
}
type MarketplacePurchasedLicense ¶
type MarketplacePurchasedLicense struct {
// The Marketplace display name.
MarketplaceName *string `json:"marketplaceName,omitempty"`
// The name of the identity making the purchase as seen by the marketplace
PurchaserName *string `json:"purchaserName,omitempty"`
// The quantity purchased.
PurchaseUnitCount *int `json:"purchaseUnitCount,omitempty"`
}
Represents a purchase of resource units in a secondary marketplace.
type MetricsColumnMetaData ¶
type MetricsColumnMetaData struct {
// Name.
ColumnName *string `json:"columnName,omitempty"`
// Data type.
ColumnValueType *string `json:"columnValueType,omitempty"`
}
Meta data for a metrics column.
type MetricsColumnsHeader ¶
type MetricsColumnsHeader struct {
// Properties of deployment group for which metrics are provided. E.g. 1: LastJobStatus E.g. 2: TargetState
Dimensions *[]MetricsColumnMetaData `json:"dimensions,omitempty"`
// The types of metrics. E.g. 1: total count of deployment targets. E.g. 2: Average time of deployment to the deployment targets.
Metrics *[]MetricsColumnMetaData `json:"metrics,omitempty"`
}
Metrics columns header
type MetricsRow ¶
type MetricsRow struct {
// The values of the properties mentioned as 'Dimensions' in column header. E.g. 1: For a property 'LastJobStatus' - metrics will be provided for 'passed', 'failed', etc. E.g. 2: For a property 'TargetState' - metrics will be provided for 'online', 'offline' targets.
Dimensions *[]string `json:"dimensions,omitempty"`
// Metrics in serialized format. Should be deserialized based on the data type provided in header.
Metrics *[]string `json:"metrics,omitempty"`
}
Metrics row.
type PackageMetadata ¶
type PackageMetadata struct {
// The date the package was created
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// A direct link to download the package.
DownloadUrl *string `json:"downloadUrl,omitempty"`
// The UI uses this to display instructions, i.e. "unzip MyAgent.zip"
Filename *string `json:"filename,omitempty"`
// MD5 hash as a base64 string
HashValue *string `json:"hashValue,omitempty"`
// A link to documentation
InfoUrl *string `json:"infoUrl,omitempty"`
// The platform (win7, linux, etc.)
Platform *string `json:"platform,omitempty"`
// The type of package (e.g. "agent")
Type *string `json:"type,omitempty"`
// The package version.
Version *PackageVersion `json:"version,omitempty"`
}
Represents a downloadable package.
type PackageVersion ¶
type PlanEnvironment ¶
type ProjectReference ¶
type PublishTaskGroupMetadata ¶
type PublishTaskGroupMetadata struct {
Comment *string `json:"comment,omitempty"`
ParentDefinitionRevision *int `json:"parentDefinitionRevision,omitempty"`
Preview *bool `json:"preview,omitempty"`
TaskGroupId *uuid.UUID `json:"taskGroupId,omitempty"`
TaskGroupRevision *int `json:"taskGroupRevision,omitempty"`
}
type ReplaceAgentArgs ¶
type ReplaceAgentArgs struct {
// (required) Updated details about the replacing agent
Agent *TaskAgent
// (required) The agent pool to use
PoolId *int
// (required) The agent to replace
AgentId *int
}
Arguments for the ReplaceAgent function
type ResourceFilterOptions ¶
type ResourceFilterOptions struct {
Identities *[]webapi.IdentityRef `json:"identities,omitempty"`
ResourceTypes *[]string `json:"resourceTypes,omitempty"`
}
type ResourceFilters ¶
type ResourceItem ¶
type ResourceItem struct {
// Gets or sets the identity who created the resource.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// Gets or sets description of the resource.
Description *string `json:"description,omitempty"`
// Gets or sets icon url of the resource.
IconUrl *string `json:"iconUrl,omitempty"`
// Gets or sets Id of the resource.
Id *string `json:"id,omitempty"`
IsShared *bool `json:"isShared,omitempty"`
// Gets or sets name of the resource.
Name *string `json:"name,omitempty"`
// Gets or sets internal properties of the resource.
Properties *map[string]string `json:"properties,omitempty"`
// Gets or sets resource type.
ResourceType *string `json:"resourceType,omitempty"`
}
Resources include Service Connections, Variable Groups and Secure Files.
type ResourceLimit ¶
type ResourceLimit struct {
FailedToReachAllProviders *bool `json:"failedToReachAllProviders,omitempty"`
HostId *uuid.UUID `json:"hostId,omitempty"`
IsHosted *bool `json:"isHosted,omitempty"`
IsPremium *bool `json:"isPremium,omitempty"`
ParallelismTag *string `json:"parallelismTag,omitempty"`
ResourceLimitsData *map[string]string `json:"resourceLimitsData,omitempty"`
TotalCount *int `json:"totalCount,omitempty"`
TotalMinutes *int `json:"totalMinutes,omitempty"`
}
type ResourceUsage ¶
type ResourceUsage struct {
ResourceLimit *ResourceLimit `json:"resourceLimit,omitempty"`
RunningRequests *[]TaskAgentJobRequest `json:"runningRequests,omitempty"`
UsedCount *int `json:"usedCount,omitempty"`
UsedMinutes *int `json:"usedMinutes,omitempty"`
}
type ResourcesHubData ¶
type ResourcesHubData struct {
ContinuationToken *string `json:"continuationToken,omitempty"`
ResourceFilterOptions *ResourceFilterOptions `json:"resourceFilterOptions,omitempty"`
ResourceFilters *ResourceFilters `json:"resourceFilters,omitempty"`
ResourceItems *[]ResourceItem `json:"resourceItems,omitempty"`
}
type ResultTransformationDetails ¶
type ResultTransformationDetails struct {
ResultTemplate *string `json:"resultTemplate,omitempty"`
}
type SecureFile ¶
type SecureFile struct {
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"`
Name *string `json:"name,omitempty"`
Properties *map[string]string `json:"properties,omitempty"`
Ticket *string `json:"ticket,omitempty"`
}
type SecureFileEvent ¶
type SecureFileEvent struct {
EventType *string `json:"eventType,omitempty"`
ProjectId *uuid.UUID `json:"projectId,omitempty"`
SecureFiles *[]SecureFile `json:"secureFiles,omitempty"`
}
type SendJobResponse ¶
type SendJobResponse struct {
Events *JobEventsConfig `json:"events,omitempty"`
Variables *map[string]string `json:"variables,omitempty"`
}
type ServerExecutionDefinition ¶
type ServerExecutionDefinition struct {
Events *EventsConfig `json:"events,omitempty"`
HandlerName *string `json:"handlerName,omitempty"`
}
type ServerTaskRequestMessage ¶
type ServerTaskRequestMessage struct {
Environment *JobEnvironment `json:"environment,omitempty"`
JobId *uuid.UUID `json:"jobId,omitempty"`
JobName *string `json:"jobName,omitempty"`
JobRefName *string `json:"jobRefName,omitempty"`
MessageType *string `json:"messageType,omitempty"`
Plan *TaskOrchestrationPlanReference `json:"plan,omitempty"`
Timeline *TimelineReference `json:"timeline,omitempty"`
TaskDefinition *TaskDefinition `json:"taskDefinition,omitempty"`
TaskInstance *TaskInstance `json:"taskInstance,omitempty"`
}
type ServiceEndpoint ¶
type ServiceEndpoint struct {
// Gets or sets the identity reference for the administrators group of the service endpoint.
AdministratorsGroup *webapi.IdentityRef `json:"administratorsGroup,omitempty"`
// Gets or sets the authorization data for talking to the endpoint.
Authorization *EndpointAuthorization `json:"authorization,omitempty"`
// Gets or sets the identity reference for the user who created the Service endpoint.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
Data *map[string]string `json:"data,omitempty"`
// Gets or sets the description of endpoint.
Description *string `json:"description,omitempty"`
GroupScopeId *uuid.UUID `json:"groupScopeId,omitempty"`
// Gets or sets the identifier of this endpoint.
Id *uuid.UUID `json:"id,omitempty"`
// EndPoint state indicator
IsReady *bool `json:"isReady,omitempty"`
IsShared *bool `json:"isShared,omitempty"`
// Gets or sets the friendly name of the endpoint.
Name *string `json:"name,omitempty"`
// Error message during creation/deletion of endpoint
OperationStatus interface{} `json:"operationStatus,omitempty"`
// Gets or sets the owner of the endpoint.
Owner *string `json:"owner,omitempty"`
// Gets or sets the identity reference for the readers group of the service endpoint.
ReadersGroup *webapi.IdentityRef `json:"readersGroup,omitempty"`
// Gets or sets the type of the endpoint.
Type *string `json:"type,omitempty"`
// Gets or sets the url of the endpoint.
Url *string `json:"url,omitempty"`
}
Represents an endpoint which may be used by an orchestration job.
type ServiceEndpointAuthenticationScheme ¶
type ServiceEndpointAuthenticationScheme struct {
// Gets or sets the authorization headers of service endpoint authentication scheme.
AuthorizationHeaders *[]AuthorizationHeader `json:"authorizationHeaders,omitempty"`
// Gets or sets the certificates of service endpoint authentication scheme.
ClientCertificates *[]ClientCertificate `json:"clientCertificates,omitempty"`
// Gets or sets the display name for the service endpoint authentication scheme.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the input descriptors for the service endpoint authentication scheme.
InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"`
// Gets or sets the scheme for service endpoint authentication.
Scheme *string `json:"scheme,omitempty"`
}
type ServiceEndpointDetails ¶
type ServiceEndpointDetails struct {
Authorization *EndpointAuthorization `json:"authorization,omitempty"`
Data *map[string]string `json:"data,omitempty"`
Type *string `json:"type,omitempty"`
Url *string `json:"url,omitempty"`
}
type ServiceEndpointExecutionData ¶
type ServiceEndpointExecutionData struct {
// Gets the definition of service endpoint execution owner.
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
// Gets the finish time of service endpoint execution.
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
// Gets the Id of service endpoint execution data.
Id *uint64 `json:"id,omitempty"`
// Gets the owner of service endpoint execution data.
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
// Gets the plan type of service endpoint execution data.
PlanType *string `json:"planType,omitempty"`
// Gets the result of service endpoint execution.
Result *TaskResult `json:"result,omitempty"`
// Gets the start time of service endpoint execution.
StartTime *azuredevops.Time `json:"startTime,omitempty"`
}
Represents service endpoint execution data.
type ServiceEndpointExecutionRecord ¶
type ServiceEndpointExecutionRecord struct {
// Gets the execution data of service endpoint execution.
Data *ServiceEndpointExecutionData `json:"data,omitempty"`
// Gets the Id of service endpoint.
EndpointId *uuid.UUID `json:"endpointId,omitempty"`
}
type ServiceEndpointExecutionRecordsInput ¶
type ServiceEndpointExecutionRecordsInput struct {
Data *ServiceEndpointExecutionData `json:"data,omitempty"`
EndpointIds *[]uuid.UUID `json:"endpointIds,omitempty"`
}
type ServiceEndpointRequest ¶
type ServiceEndpointRequest struct {
DataSourceDetails *DataSourceDetails `json:"dataSourceDetails,omitempty"`
ResultTransformationDetails *ResultTransformationDetails `json:"resultTransformationDetails,omitempty"`
ServiceEndpointDetails *ServiceEndpointDetails `json:"serviceEndpointDetails,omitempty"`
}
type ServiceEndpointType ¶
type ServiceEndpointType struct {
// Authentication scheme of service endpoint type.
AuthenticationSchemes *[]ServiceEndpointAuthenticationScheme `json:"authenticationSchemes,omitempty"`
// Data sources of service endpoint type.
DataSources *[]DataSource `json:"dataSources,omitempty"`
// Dependency data of service endpoint type.
DependencyData *[]DependencyData `json:"dependencyData,omitempty"`
// Gets or sets the description of service endpoint type.
Description *string `json:"description,omitempty"`
// Gets or sets the display name of service endpoint type.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the endpoint url of service endpoint type.
EndpointUrl *EndpointUrl `json:"endpointUrl,omitempty"`
// Gets or sets the help link of service endpoint type.
HelpLink *HelpLink `json:"helpLink,omitempty"`
HelpMarkDown *string `json:"helpMarkDown,omitempty"`
// Gets or sets the icon url of service endpoint type.
IconUrl *string `json:"iconUrl,omitempty"`
// Input descriptor of service endpoint type.
InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"`
// Gets or sets the name of service endpoint type.
Name *string `json:"name,omitempty"`
// Trusted hosts of a service endpoint type.
TrustedHosts *[]string `json:"trustedHosts,omitempty"`
// Gets or sets the ui contribution id of service endpoint type.
UiContributionId *string `json:"uiContributionId,omitempty"`
}
Represents type of the service endpoint.
type TaskAgent ¶
type TaskAgent struct {
Links interface{} `json:"_links,omitempty"`
// This agent's access point.
AccessPoint *string `json:"accessPoint,omitempty"`
// Whether or not this agent should run jobs.
Enabled *bool `json:"enabled,omitempty"`
// Identifier of the agent.
Id *int `json:"id,omitempty"`
// Name of the agent.
Name *string `json:"name,omitempty"`
// Agent OS.
OsDescription *string `json:"osDescription,omitempty"`
// Provisioning state of this agent.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Whether or not the agent is online.
Status *TaskAgentStatus `json:"status,omitempty"`
// Agent version.
Version *string `json:"version,omitempty"`
// The agent cloud request that's currently associated with this agent.
AssignedAgentCloudRequest *TaskAgentCloudRequest `json:"assignedAgentCloudRequest,omitempty"`
// The request which is currently assigned to this agent.
AssignedRequest *TaskAgentJobRequest `json:"assignedRequest,omitempty"`
// Authorization information for this agent.
Authorization *TaskAgentAuthorization `json:"authorization,omitempty"`
// Date on which this agent was created.
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// The last request which was completed by this agent.
LastCompletedRequest *TaskAgentJobRequest `json:"lastCompletedRequest,omitempty"`
// Maximum job parallelism allowed for this agent.
MaxParallelism *int `json:"maxParallelism,omitempty"`
// Pending update for this agent.
PendingUpdate *TaskAgentUpdate `json:"pendingUpdate,omitempty"`
Properties interface{} `json:"properties,omitempty"`
// Date on which the last connectivity status change occurred.
StatusChangedOn *azuredevops.Time `json:"statusChangedOn,omitempty"`
SystemCapabilities *map[string]string `json:"systemCapabilities,omitempty"`
UserCapabilities *map[string]string `json:"userCapabilities,omitempty"`
}
A task agent.
type TaskAgentAuthorization ¶
type TaskAgentAuthorization struct {
// Endpoint used to obtain access tokens from the configured token service.
AuthorizationUrl *string `json:"authorizationUrl,omitempty"`
// Client identifier for this agent.
ClientId *uuid.UUID `json:"clientId,omitempty"`
// Public key used to verify the identity of this agent.
PublicKey *TaskAgentPublicKey `json:"publicKey,omitempty"`
}
Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows.
type TaskAgentCloud ¶
type TaskAgentCloud struct {
// Gets or sets a AcquireAgentEndpoint using which a request can be made to acquire new agent
AcquireAgentEndpoint *string `json:"acquireAgentEndpoint,omitempty"`
AcquisitionTimeout *int `json:"acquisitionTimeout,omitempty"`
AgentCloudId *int `json:"agentCloudId,omitempty"`
GetAccountParallelismEndpoint *string `json:"getAccountParallelismEndpoint,omitempty"`
GetAgentDefinitionEndpoint *string `json:"getAgentDefinitionEndpoint,omitempty"`
GetAgentRequestStatusEndpoint *string `json:"getAgentRequestStatusEndpoint,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
// Signifies that this Agent Cloud is internal and should not be user-manageable
Internal *bool `json:"internal,omitempty"`
MaxParallelism *int `json:"maxParallelism,omitempty"`
Name *string `json:"name,omitempty"`
ReleaseAgentEndpoint *string `json:"releaseAgentEndpoint,omitempty"`
// Gets or sets the type of the endpoint.
Type *string `json:"type,omitempty"`
}
type TaskAgentCloudRequest ¶
type TaskAgentCloudRequest struct {
Agent *TaskAgentReference `json:"agent,omitempty"`
AgentCloudId *int `json:"agentCloudId,omitempty"`
AgentConnectedTime *azuredevops.Time `json:"agentConnectedTime,omitempty"`
AgentData interface{} `json:"agentData,omitempty"`
AgentSpecification interface{} `json:"agentSpecification,omitempty"`
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
ProvisionedTime *azuredevops.Time `json:"provisionedTime,omitempty"`
ProvisionRequestTime *azuredevops.Time `json:"provisionRequestTime,omitempty"`
ReleaseRequestTime *azuredevops.Time `json:"releaseRequestTime,omitempty"`
RequestId *uuid.UUID `json:"requestId,omitempty"`
}
type TaskAgentCloudType ¶
type TaskAgentCloudType struct {
// Gets or sets the display name of agent cloud type.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the input descriptors
InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"`
// Gets or sets the name of agent cloud type.
Name *string `json:"name,omitempty"`
}
type TaskAgentDelaySource ¶
type TaskAgentDelaySource struct {
Delays *[]interface{} `json:"delays,omitempty"`
TaskAgent *TaskAgentReference `json:"taskAgent,omitempty"`
}
type TaskAgentJob ¶
type TaskAgentJob struct {
Container *string `json:"container,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
SidecarContainers *map[string]string `json:"sidecarContainers,omitempty"`
Steps *[]TaskAgentJobStep `json:"steps,omitempty"`
Variables *[]TaskAgentJobVariable `json:"variables,omitempty"`
}
type TaskAgentJobRequest ¶
type TaskAgentJobRequest struct {
AgentDelays *[]TaskAgentDelaySource `json:"agentDelays,omitempty"`
AgentSpecification interface{} `json:"agentSpecification,omitempty"`
// The date/time this request was assigned.
AssignTime *azuredevops.Time `json:"assignTime,omitempty"`
// Additional data about the request.
Data *map[string]string `json:"data,omitempty"`
// The pipeline definition associated with this request
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
// A list of demands required to fulfill this request.
Demands *[]interface{} `json:"demands,omitempty"`
ExpectedDuration interface{} `json:"expectedDuration,omitempty"`
// The date/time this request was finished.
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
// The host which triggered this request.
HostId *uuid.UUID `json:"hostId,omitempty"`
// ID of the job resulting from this request.
JobId *uuid.UUID `json:"jobId,omitempty"`
// Name of the job resulting from this request.
JobName *string `json:"jobName,omitempty"`
// The deadline for the agent to renew the lock.
LockedUntil *azuredevops.Time `json:"lockedUntil,omitempty"`
MatchedAgents *[]TaskAgentReference `json:"matchedAgents,omitempty"`
MatchesAllAgentsInPool *bool `json:"matchesAllAgentsInPool,omitempty"`
OrchestrationId *string `json:"orchestrationId,omitempty"`
// The pipeline associated with this request
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
PlanGroup *string `json:"planGroup,omitempty"`
// Internal ID for the orchestration plan connected with this request.
PlanId *uuid.UUID `json:"planId,omitempty"`
// Internal detail representing the type of orchestration plan.
PlanType *string `json:"planType,omitempty"`
// The ID of the pool this request targets
PoolId *int `json:"poolId,omitempty"`
// The ID of the queue this request targets
QueueId *int `json:"queueId,omitempty"`
// The date/time this request was queued.
QueueTime *azuredevops.Time `json:"queueTime,omitempty"`
// The date/time this request was receieved by an agent.
ReceiveTime *azuredevops.Time `json:"receiveTime,omitempty"`
// ID of the request.
RequestId *uint64 `json:"requestId,omitempty"`
// The agent allocated for this request.
ReservedAgent *TaskAgentReference `json:"reservedAgent,omitempty"`
// The result of this request.
Result *TaskResult `json:"result,omitempty"`
// Scope of the pipeline; matches the project ID.
ScopeId *uuid.UUID `json:"scopeId,omitempty"`
// The service which owns this request.
ServiceOwner *uuid.UUID `json:"serviceOwner,omitempty"`
StatusMessage *string `json:"statusMessage,omitempty"`
UserDelayed *bool `json:"userDelayed,omitempty"`
}
A job request for an agent.
type TaskAgentJobResultFilter ¶
type TaskAgentJobResultFilter string
[Flags] This is useful in getting a list of deployment targets, filtered by the result of their last job.
type TaskAgentJobStep ¶
type TaskAgentJobStep struct {
Condition *string `json:"condition,omitempty"`
ContinueOnError *bool `json:"continueOnError,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Env *map[string]string `json:"env,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
Inputs *map[string]string `json:"inputs,omitempty"`
Name *string `json:"name,omitempty"`
Task *TaskAgentJobTask `json:"task,omitempty"`
TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"`
Type *TaskAgentJobStepType `json:"type,omitempty"`
}
type TaskAgentJobStepType ¶
type TaskAgentJobStepType string
type TaskAgentJobTask ¶
type TaskAgentJobVariable ¶
type TaskAgentManualUpdate ¶
type TaskAgentManualUpdate struct {
Code *TaskAgentUpdateReasonType `json:"code,omitempty"`
}
type TaskAgentMessage ¶
type TaskAgentMessage struct {
// Gets or sets the body of the message. If the <c>IV</c> property is provided the body will need to be decrypted using the <c>TaskAgentSession.EncryptionKey</c> value in addition to the <c>IV</c>.
Body *string `json:"body,omitempty"`
// Gets or sets the initialization vector used to encrypt this message.
Iv *[]byte `json:"iv,omitempty"`
// Gets or sets the message identifier.
MessageId *uint64 `json:"messageId,omitempty"`
// Gets or sets the message type, describing the data contract found in <c>TaskAgentMessage.Body</c>.
MessageType *string `json:"messageType,omitempty"`
}
Provides a contract for receiving messages from the task orchestrator.
type TaskAgentMinAgentVersionRequiredUpdate ¶
type TaskAgentMinAgentVersionRequiredUpdate struct {
Code *TaskAgentUpdateReasonType `json:"code,omitempty"`
JobDefinition *TaskOrchestrationOwner `json:"jobDefinition,omitempty"`
JobOwner *TaskOrchestrationOwner `json:"jobOwner,omitempty"`
MinAgentVersion interface{} `json:"minAgentVersion,omitempty"`
}
type TaskAgentPool ¶
type TaskAgentPool struct {
Id *int `json:"id,omitempty"`
// Gets or sets a value indicating whether or not this pool is managed by the service.
IsHosted *bool `json:"isHosted,omitempty"`
// Determines whether the pool is legacy.
IsLegacy *bool `json:"isLegacy,omitempty"`
Name *string `json:"name,omitempty"`
// Gets or sets the type of the pool
PoolType *TaskAgentPoolType `json:"poolType,omitempty"`
Scope *uuid.UUID `json:"scope,omitempty"`
// Gets the current size of the pool.
Size *int `json:"size,omitempty"`
// The ID of the associated agent cloud.
AgentCloudId *int `json:"agentCloudId,omitempty"`
// Whether or not a queue should be automatically provisioned for each project collection.
AutoProvision *bool `json:"autoProvision,omitempty"`
// Whether or not the pool should autosize itself based on the Agent Cloud Provider settings.
AutoSize *bool `json:"autoSize,omitempty"`
// Creator of the pool. The creator of the pool is automatically added into the administrators group for the pool on creation.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// The date/time of the pool creation.
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// Owner or administrator of the pool.
Owner *webapi.IdentityRef `json:"owner,omitempty"`
Properties interface{} `json:"properties,omitempty"`
// Target parallelism.
TargetSize *int `json:"targetSize,omitempty"`
}
An organization-level grouping of agents.
type TaskAgentPoolActionFilter ¶
type TaskAgentPoolActionFilter string
[Flags] Filters pools based on whether the calling user has permission to use or manage the pool.
type TaskAgentPoolMaintenanceDefinition ¶
type TaskAgentPoolMaintenanceDefinition struct {
// Enable maintenance
Enabled *bool `json:"enabled,omitempty"`
// Id
Id *int `json:"id,omitempty"`
// Maintenance job timeout per agent
JobTimeoutInMinutes *int `json:"jobTimeoutInMinutes,omitempty"`
// Max percentage of agents within a pool running maintenance job at given time
MaxConcurrentAgentsPercentage *int `json:"maxConcurrentAgentsPercentage,omitempty"`
Options *TaskAgentPoolMaintenanceOptions `json:"options,omitempty"`
// Pool reference for the maintenance definition
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
RetentionPolicy *TaskAgentPoolMaintenanceRetentionPolicy `json:"retentionPolicy,omitempty"`
ScheduleSetting *TaskAgentPoolMaintenanceSchedule `json:"scheduleSetting,omitempty"`
}
type TaskAgentPoolMaintenanceJob ¶
type TaskAgentPoolMaintenanceJob struct {
// The maintenance definition for the maintenance job
DefinitionId *int `json:"definitionId,omitempty"`
// The total error counts during the maintenance job
ErrorCount *int `json:"errorCount,omitempty"`
// Time that the maintenance job was completed
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
// Id of the maintenance job
JobId *int `json:"jobId,omitempty"`
// The log download url for the maintenance job
LogsDownloadUrl *string `json:"logsDownloadUrl,omitempty"`
// Orchestration/Plan Id for the maintenance job
OrchestrationId *uuid.UUID `json:"orchestrationId,omitempty"`
// Pool reference for the maintenance job
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
// Time that the maintenance job was queued
QueueTime *azuredevops.Time `json:"queueTime,omitempty"`
// The identity that queued the maintenance job
RequestedBy *webapi.IdentityRef `json:"requestedBy,omitempty"`
// The maintenance job result
Result *TaskAgentPoolMaintenanceJobResult `json:"result,omitempty"`
// Time that the maintenance job was started
StartTime *azuredevops.Time `json:"startTime,omitempty"`
// Status of the maintenance job
Status *TaskAgentPoolMaintenanceJobStatus `json:"status,omitempty"`
TargetAgents *[]TaskAgentPoolMaintenanceJobTargetAgent `json:"targetAgents,omitempty"`
// The total warning counts during the maintenance job
WarningCount *int `json:"warningCount,omitempty"`
}
type TaskAgentPoolMaintenanceJobResult ¶
type TaskAgentPoolMaintenanceJobResult string
type TaskAgentPoolMaintenanceJobStatus ¶
type TaskAgentPoolMaintenanceJobStatus string
type TaskAgentPoolMaintenanceJobTargetAgent ¶
type TaskAgentPoolMaintenanceJobTargetAgent struct {
Agent *TaskAgentReference `json:"agent,omitempty"`
JobId *int `json:"jobId,omitempty"`
Result *TaskAgentPoolMaintenanceJobResult `json:"result,omitempty"`
Status *TaskAgentPoolMaintenanceJobStatus `json:"status,omitempty"`
}
type TaskAgentPoolMaintenanceOptions ¶
type TaskAgentPoolMaintenanceOptions struct {
// time to consider a System.DefaultWorkingDirectory is stale
WorkingDirectoryExpirationInDays *int `json:"workingDirectoryExpirationInDays,omitempty"`
}
type TaskAgentPoolMaintenanceRetentionPolicy ¶
type TaskAgentPoolMaintenanceRetentionPolicy struct {
// Number of records to keep for maintenance job executed with this definition.
NumberOfHistoryRecordsToKeep *int `json:"numberOfHistoryRecordsToKeep,omitempty"`
}
type TaskAgentPoolMaintenanceSchedule ¶
type TaskAgentPoolMaintenanceSchedule struct {
// Days for a build (flags enum for days of the week)
DaysToBuild *TaskAgentPoolMaintenanceScheduleDays `json:"daysToBuild,omitempty"`
// The Job Id of the Scheduled job that will queue the pool maintenance job.
ScheduleJobId *uuid.UUID `json:"scheduleJobId,omitempty"`
// Local timezone hour to start
StartHours *int `json:"startHours,omitempty"`
// Local timezone minute to start
StartMinutes *int `json:"startMinutes,omitempty"`
// Time zone of the build schedule (string representation of the time zone id)
TimeZoneId *string `json:"timeZoneId,omitempty"`
}
type TaskAgentPoolMaintenanceScheduleDays ¶
type TaskAgentPoolMaintenanceScheduleDays string
type TaskAgentPoolReference ¶
type TaskAgentPoolReference struct {
Id *int `json:"id,omitempty"`
// Gets or sets a value indicating whether or not this pool is managed by the service.
IsHosted *bool `json:"isHosted,omitempty"`
// Determines whether the pool is legacy.
IsLegacy *bool `json:"isLegacy,omitempty"`
Name *string `json:"name,omitempty"`
// Gets or sets the type of the pool
PoolType *TaskAgentPoolType `json:"poolType,omitempty"`
Scope *uuid.UUID `json:"scope,omitempty"`
// Gets the current size of the pool.
Size *int `json:"size,omitempty"`
}
type TaskAgentPoolStatus ¶
type TaskAgentPoolStatus struct {
Id *int `json:"id,omitempty"`
// Gets or sets a value indicating whether or not this pool is managed by the service.
IsHosted *bool `json:"isHosted,omitempty"`
// Determines whether the pool is legacy.
IsLegacy *bool `json:"isLegacy,omitempty"`
Name *string `json:"name,omitempty"`
// Gets or sets the type of the pool
PoolType *TaskAgentPoolType `json:"poolType,omitempty"`
Scope *uuid.UUID `json:"scope,omitempty"`
// Gets the current size of the pool.
Size *int `json:"size,omitempty"`
// Number of requests queued and assigned to an agent. Not running yet.
AssignedRequestCount *int `json:"assignedRequestCount,omitempty"`
// Number of queued requests which are not assigned to any agents
QueuedRequestCount *int `json:"queuedRequestCount,omitempty"`
// Number of currently running requests
RunningRequestCount *int `json:"runningRequestCount,omitempty"`
}
type TaskAgentPoolSummary ¶
type TaskAgentPoolSummary struct {
ColumnsHeader *MetricsColumnsHeader `json:"columnsHeader,omitempty"`
DeploymentGroups *[]DeploymentGroupReference `json:"deploymentGroups,omitempty"`
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
Queues *[]TaskAgentQueue `json:"queues,omitempty"`
Rows *[]MetricsRow `json:"rows,omitempty"`
}
type TaskAgentPublicKey ¶
type TaskAgentPublicKey struct {
// Gets or sets the exponent for the public key.
Exponent *[]byte `json:"exponent,omitempty"`
// Gets or sets the modulus for the public key.
Modulus *[]byte `json:"modulus,omitempty"`
}
Represents the public key portion of an RSA asymmetric key.
type TaskAgentQueue ¶
type TaskAgentQueue struct {
// ID of the queue
Id *int `json:"id,omitempty"`
// Name of the queue
Name *string `json:"name,omitempty"`
// Pool reference for this queue
Pool *TaskAgentPoolReference `json:"pool,omitempty"`
// Project ID
ProjectId *uuid.UUID `json:"projectId,omitempty"`
}
An agent queue.
type TaskAgentQueueActionFilter ¶
type TaskAgentQueueActionFilter string
[Flags] Filters queues based on whether the calling user has permission to use or manage the queue.
type TaskAgentReference ¶
type TaskAgentReference struct {
Links interface{} `json:"_links,omitempty"`
// This agent's access point.
AccessPoint *string `json:"accessPoint,omitempty"`
// Whether or not this agent should run jobs.
Enabled *bool `json:"enabled,omitempty"`
// Identifier of the agent.
Id *int `json:"id,omitempty"`
// Name of the agent.
Name *string `json:"name,omitempty"`
// Agent OS.
OsDescription *string `json:"osDescription,omitempty"`
// Provisioning state of this agent.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Whether or not the agent is online.
Status *TaskAgentStatus `json:"status,omitempty"`
// Agent version.
Version *string `json:"version,omitempty"`
}
A reference to an agent.
type TaskAgentSession ¶
type TaskAgentSession struct {
// Gets or sets the agent which is the target of the session.
Agent *TaskAgentReference `json:"agent,omitempty"`
// Gets the key used to encrypt message traffic for this session.
EncryptionKey *TaskAgentSessionKey `json:"encryptionKey,omitempty"`
// Gets or sets the owner name of this session. Generally this will be the machine of origination.
OwnerName *string `json:"ownerName,omitempty"`
// Gets the unique identifier for this session.
SessionId *uuid.UUID `json:"sessionId,omitempty"`
SystemCapabilities *map[string]string `json:"systemCapabilities,omitempty"`
}
Represents a session for performing message exchanges from an agent.
type TaskAgentSessionKey ¶
type TaskAgentSessionKey struct {
// Gets or sets a value indicating whether or not the key value is encrypted. If this value is true, the Value property should be decrypted using the <c>RSA</c> key exchanged with the server during registration.
Encrypted *bool `json:"encrypted,omitempty"`
// Gets or sets the symmetric key value.
Value *[]byte `json:"value,omitempty"`
}
Represents a symmetric key used for message-level encryption for communication sent to an agent.
type TaskAgentStatus ¶
type TaskAgentStatus string
type TaskAgentStatusFilter ¶
type TaskAgentStatusFilter string
[Flags] This is useful in getting a list of deployment targets, filtered by the deployment agent status.
type TaskAgentUpdate ¶
type TaskAgentUpdate struct {
// Current state of this agent update.
CurrentState *string `json:"currentState,omitempty"`
// Reason for this update.
Reason *TaskAgentUpdateReason `json:"reason,omitempty"`
// Identity which requested this update.
RequestedBy *webapi.IdentityRef `json:"requestedBy,omitempty"`
// Date on which this update was requested.
RequestTime *azuredevops.Time `json:"requestTime,omitempty"`
// Source agent version of the update.
SourceVersion *PackageVersion `json:"sourceVersion,omitempty"`
// Target agent version of the update.
TargetVersion *PackageVersion `json:"targetVersion,omitempty"`
}
Details about an agent update.
type TaskAgentUpdateReason ¶
type TaskAgentUpdateReason struct {
Code *TaskAgentUpdateReasonType `json:"code,omitempty"`
}
type TaskAgentUpdateReasonType ¶
type TaskAgentUpdateReasonType string
type TaskAssignedEvent ¶
type TaskAttachment ¶
type TaskAttachment struct {
Links interface{} `json:"_links,omitempty"`
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
LastChangedBy *uuid.UUID `json:"lastChangedBy,omitempty"`
LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"`
Name *string `json:"name,omitempty"`
RecordId *uuid.UUID `json:"recordId,omitempty"`
TimelineId *uuid.UUID `json:"timelineId,omitempty"`
Type *string `json:"type,omitempty"`
}
type TaskCompletedEvent ¶
type TaskDefinition ¶
type TaskDefinition struct {
AgentExecution *TaskExecution `json:"agentExecution,omitempty"`
Author *string `json:"author,omitempty"`
Category *string `json:"category,omitempty"`
ContentsUploaded *bool `json:"contentsUploaded,omitempty"`
ContributionIdentifier *string `json:"contributionIdentifier,omitempty"`
ContributionVersion *string `json:"contributionVersion,omitempty"`
DataSourceBindings *[]DataSourceBinding `json:"dataSourceBindings,omitempty"`
DefinitionType *string `json:"definitionType,omitempty"`
Demands *[]interface{} `json:"demands,omitempty"`
Deprecated *bool `json:"deprecated,omitempty"`
Description *string `json:"description,omitempty"`
Disabled *bool `json:"disabled,omitempty"`
// Deprecated: Ecosystem property is not currently supported.
Ecosystem *string `json:"ecosystem,omitempty"`
Execution *map[string]interface{} `json:"execution,omitempty"`
FriendlyName *string `json:"friendlyName,omitempty"`
Groups *[]TaskGroupDefinition `json:"groups,omitempty"`
HelpMarkDown *string `json:"helpMarkDown,omitempty"`
HelpUrl *string `json:"helpUrl,omitempty"`
HostType *string `json:"hostType,omitempty"`
IconUrl *string `json:"iconUrl,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
Inputs *[]TaskInputDefinition `json:"inputs,omitempty"`
InstanceNameFormat *string `json:"instanceNameFormat,omitempty"`
MinimumAgentVersion *string `json:"minimumAgentVersion,omitempty"`
Name *string `json:"name,omitempty"`
OutputVariables *[]TaskOutputVariable `json:"outputVariables,omitempty"`
PackageLocation *string `json:"packageLocation,omitempty"`
PackageType *string `json:"packageType,omitempty"`
PostJobExecution *map[string]interface{} `json:"postJobExecution,omitempty"`
PreJobExecution *map[string]interface{} `json:"preJobExecution,omitempty"`
Preview *bool `json:"preview,omitempty"`
ReleaseNotes *string `json:"releaseNotes,omitempty"`
RunsOn *[]string `json:"runsOn,omitempty"`
Satisfies *[]string `json:"satisfies,omitempty"`
ServerOwned *bool `json:"serverOwned,omitempty"`
ShowEnvironmentVariables *bool `json:"showEnvironmentVariables,omitempty"`
SourceDefinitions *[]TaskSourceDefinition `json:"sourceDefinitions,omitempty"`
SourceLocation *string `json:"sourceLocation,omitempty"`
Version *TaskVersion `json:"version,omitempty"`
Visibility *[]string `json:"visibility,omitempty"`
}
type TaskDefinitionEndpoint ¶
type TaskDefinitionEndpoint struct {
// An ID that identifies a service connection to be used for authenticating endpoint requests.
ConnectionId *string `json:"connectionId,omitempty"`
// An Json based keyselector to filter response returned by fetching the endpoint <c>Url</c>.A Json based keyselector must be prefixed with "jsonpath:". KeySelector can be used to specify the filter to get the keys for the values specified with Selector. <example> The following keyselector defines an Json for extracting nodes named 'ServiceName'. <code> endpoint.KeySelector = "jsonpath://ServiceName"; </code></example>
KeySelector *string `json:"keySelector,omitempty"`
// The scope as understood by Connected Services. Essentially, a project-id for now.
Scope *string `json:"scope,omitempty"`
// An XPath/Json based selector to filter response returned by fetching the endpoint <c>Url</c>. An XPath based selector must be prefixed with the string "xpath:". A Json based selector must be prefixed with "jsonpath:". <example> The following selector defines an XPath for extracting nodes named 'ServiceName'. <code> endpoint.Selector = "xpath://ServiceName"; </code></example>
Selector *string `json:"selector,omitempty"`
// TaskId that this endpoint belongs to.
TaskId *string `json:"taskId,omitempty"`
// URL to GET.
Url *string `json:"url,omitempty"`
}
type TaskDefinitionReference ¶
type TaskDefinitionReference struct {
// Gets or sets the definition type. Values can be 'task' or 'metaTask'.
DefinitionType *string `json:"definitionType,omitempty"`
// Gets or sets the unique identifier of task.
Id *uuid.UUID `json:"id,omitempty"`
// Gets or sets the version specification of task.
VersionSpec *string `json:"versionSpec,omitempty"`
}
type TaskDefinitionStatus ¶
type TaskDefinitionStatus string
type TaskExecution ¶
type TaskExecution struct {
// The utility task to run. Specifying this means that this task definition is simply a meta task to call another task. This is useful for tasks that call utility tasks like powershell and commandline
ExecTask *TaskReference `json:"execTask,omitempty"`
// If a task is going to run code, then this provides the type/script etc... information by platform. For example, it might look like. net45: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } net20: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } java: { jar: "powershelltask.tasks.automation.teamfoundation.microsoft.com", } node: { script: "powershellhost.js", }
PlatformInstructions *map[string]map[string]string `json:"platformInstructions,omitempty"`
}
type TaskGroup ¶
type TaskGroup struct {
AgentExecution *TaskExecution `json:"agentExecution,omitempty"`
Author *string `json:"author,omitempty"`
Category *string `json:"category,omitempty"`
ContentsUploaded *bool `json:"contentsUploaded,omitempty"`
ContributionIdentifier *string `json:"contributionIdentifier,omitempty"`
ContributionVersion *string `json:"contributionVersion,omitempty"`
DataSourceBindings *[]DataSourceBinding `json:"dataSourceBindings,omitempty"`
DefinitionType *string `json:"definitionType,omitempty"`
Demands *[]interface{} `json:"demands,omitempty"`
Deprecated *bool `json:"deprecated,omitempty"`
Description *string `json:"description,omitempty"`
Disabled *bool `json:"disabled,omitempty"`
Ecosystem *string `json:"ecosystem,omitempty"`
Execution *map[string]interface{} `json:"execution,omitempty"`
FriendlyName *string `json:"friendlyName,omitempty"`
Groups *[]TaskGroupDefinition `json:"groups,omitempty"`
HelpMarkDown *string `json:"helpMarkDown,omitempty"`
HelpUrl *string `json:"helpUrl,omitempty"`
HostType *string `json:"hostType,omitempty"`
IconUrl *string `json:"iconUrl,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
Inputs *[]TaskInputDefinition `json:"inputs,omitempty"`
InstanceNameFormat *string `json:"instanceNameFormat,omitempty"`
MinimumAgentVersion *string `json:"minimumAgentVersion,omitempty"`
Name *string `json:"name,omitempty"`
OutputVariables *[]TaskOutputVariable `json:"outputVariables,omitempty"`
PackageLocation *string `json:"packageLocation,omitempty"`
PackageType *string `json:"packageType,omitempty"`
PostJobExecution *map[string]interface{} `json:"postJobExecution,omitempty"`
PreJobExecution *map[string]interface{} `json:"preJobExecution,omitempty"`
Preview *bool `json:"preview,omitempty"`
ReleaseNotes *string `json:"releaseNotes,omitempty"`
RunsOn *[]string `json:"runsOn,omitempty"`
Satisfies *[]string `json:"satisfies,omitempty"`
ServerOwned *bool `json:"serverOwned,omitempty"`
ShowEnvironmentVariables *bool `json:"showEnvironmentVariables,omitempty"`
SourceDefinitions *[]TaskSourceDefinition `json:"sourceDefinitions,omitempty"`
SourceLocation *string `json:"sourceLocation,omitempty"`
Version *TaskVersion `json:"version,omitempty"`
Visibility *[]string `json:"visibility,omitempty"`
// Gets or sets comment.
Comment *string `json:"comment,omitempty"`
// Gets or sets the identity who created.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// Gets or sets date on which it got created.
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// Gets or sets as 'true' to indicate as deleted, 'false' otherwise.
Deleted *bool `json:"deleted,omitempty"`
// Gets or sets the identity who modified.
ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
// Gets or sets date on which it got modified.
ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"`
// Gets or sets the owner.
Owner *string `json:"owner,omitempty"`
// Gets or sets parent task group Id. This is used while creating a draft task group.
ParentDefinitionId *uuid.UUID `json:"parentDefinitionId,omitempty"`
// Gets or sets revision.
Revision *int `json:"revision,omitempty"`
// Gets or sets the tasks.
Tasks *[]TaskGroupStep `json:"tasks,omitempty"`
}
type TaskGroupCreateParameter ¶
type TaskGroupCreateParameter struct {
// Sets author name of the task group.
Author *string `json:"author,omitempty"`
// Sets category of the task group.
Category *string `json:"category,omitempty"`
// Sets description of the task group.
Description *string `json:"description,omitempty"`
// Sets friendly name of the task group.
FriendlyName *string `json:"friendlyName,omitempty"`
// Sets url icon of the task group.
IconUrl *string `json:"iconUrl,omitempty"`
// Sets input for the task group.
Inputs *[]TaskInputDefinition `json:"inputs,omitempty"`
// Sets display name of the task group.
InstanceNameFormat *string `json:"instanceNameFormat,omitempty"`
// Sets name of the task group.
Name *string `json:"name,omitempty"`
// Sets parent task group Id. This is used while creating a draft task group.
ParentDefinitionId *uuid.UUID `json:"parentDefinitionId,omitempty"`
// Sets RunsOn of the task group. Value can be 'Agent', 'Server' or 'DeploymentGroup'.
RunsOn *[]string `json:"runsOn,omitempty"`
// Sets tasks for the task group.
Tasks *[]TaskGroupStep `json:"tasks,omitempty"`
// Sets version of the task group.
Version *TaskVersion `json:"version,omitempty"`
}
type TaskGroupDefinition ¶
type TaskGroupQueryOrder ¶
type TaskGroupQueryOrder string
Specifies the desired ordering of taskGroups.
type TaskGroupRevision ¶
type TaskGroupRevision struct {
ChangedBy *webapi.IdentityRef `json:"changedBy,omitempty"`
ChangedDate *azuredevops.Time `json:"changedDate,omitempty"`
ChangeType *AuditAction `json:"changeType,omitempty"`
Comment *string `json:"comment,omitempty"`
FileId *int `json:"fileId,omitempty"`
MajorVersion *int `json:"majorVersion,omitempty"`
Revision *int `json:"revision,omitempty"`
TaskGroupId *uuid.UUID `json:"taskGroupId,omitempty"`
}
type TaskGroupStep ¶
type TaskGroupStep struct {
// Gets or sets as 'true' to run the task always, 'false' otherwise.
AlwaysRun *bool `json:"alwaysRun,omitempty"`
// Gets or sets condition for the task.
Condition *string `json:"condition,omitempty"`
// Gets or sets as 'true' to continue on error, 'false' otherwise.
ContinueOnError *bool `json:"continueOnError,omitempty"`
// Gets or sets the display name.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets as task is enabled or not.
Enabled *bool `json:"enabled,omitempty"`
// Gets dictionary of environment variables.
Environment *map[string]string `json:"environment,omitempty"`
// Gets or sets dictionary of inputs.
Inputs *map[string]string `json:"inputs,omitempty"`
// Gets or sets the reference of the task.
Task *TaskDefinitionReference `json:"task,omitempty"`
// Gets or sets the maximum time, in minutes, that a task is allowed to execute on agent before being cancelled by server. A zero value indicates an infinite timeout.
TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"`
}
Represents tasks in the task group.
type TaskGroupUpdateParameter ¶
type TaskGroupUpdateParameter struct {
// Sets author name of the task group.
Author *string `json:"author,omitempty"`
// Sets category of the task group.
Category *string `json:"category,omitempty"`
// Sets comment of the task group.
Comment *string `json:"comment,omitempty"`
// Sets description of the task group.
Description *string `json:"description,omitempty"`
// Sets friendly name of the task group.
FriendlyName *string `json:"friendlyName,omitempty"`
// Sets url icon of the task group.
IconUrl *string `json:"iconUrl,omitempty"`
// Sets the unique identifier of this field.
Id *uuid.UUID `json:"id,omitempty"`
// Sets input for the task group.
Inputs *[]TaskInputDefinition `json:"inputs,omitempty"`
// Sets display name of the task group.
InstanceNameFormat *string `json:"instanceNameFormat,omitempty"`
// Sets name of the task group.
Name *string `json:"name,omitempty"`
// Gets or sets parent task group Id. This is used while creating a draft task group.
ParentDefinitionId *uuid.UUID `json:"parentDefinitionId,omitempty"`
// Sets revision of the task group.
Revision *int `json:"revision,omitempty"`
// Sets RunsOn of the task group. Value can be 'Agent', 'Server' or 'DeploymentGroup'.
RunsOn *[]string `json:"runsOn,omitempty"`
// Sets tasks for the task group.
Tasks *[]TaskGroupStep `json:"tasks,omitempty"`
// Sets version of the task group.
Version *TaskVersion `json:"version,omitempty"`
}
type TaskHubLicenseDetails ¶
type TaskHubLicenseDetails struct {
EnterpriseUsersCount *int `json:"enterpriseUsersCount,omitempty"`
FailedToReachAllProviders *bool `json:"failedToReachAllProviders,omitempty"`
FreeHostedLicenseCount *int `json:"freeHostedLicenseCount,omitempty"`
FreeLicenseCount *int `json:"freeLicenseCount,omitempty"`
HasLicenseCountEverUpdated *bool `json:"hasLicenseCountEverUpdated,omitempty"`
HostedAgentMinutesFreeCount *int `json:"hostedAgentMinutesFreeCount,omitempty"`
HostedAgentMinutesUsedCount *int `json:"hostedAgentMinutesUsedCount,omitempty"`
HostedLicensesArePremium *bool `json:"hostedLicensesArePremium,omitempty"`
MarketplacePurchasedHostedLicenses *[]MarketplacePurchasedLicense `json:"marketplacePurchasedHostedLicenses,omitempty"`
MsdnUsersCount *int `json:"msdnUsersCount,omitempty"`
// Microsoft-hosted licenses purchased from VSTS directly.
PurchasedHostedLicenseCount *int `json:"purchasedHostedLicenseCount,omitempty"`
// Self-hosted licenses purchased from VSTS directly.
PurchasedLicenseCount *int `json:"purchasedLicenseCount,omitempty"`
TotalHostedLicenseCount *int `json:"totalHostedLicenseCount,omitempty"`
TotalLicenseCount *int `json:"totalLicenseCount,omitempty"`
TotalPrivateLicenseCount *int `json:"totalPrivateLicenseCount,omitempty"`
}
type TaskInputDefinition ¶
type TaskInputDefinition struct {
Aliases *[]string `json:"aliases,omitempty"`
DefaultValue *string `json:"defaultValue,omitempty"`
GroupName *string `json:"groupName,omitempty"`
HelpMarkDown *string `json:"helpMarkDown,omitempty"`
Label *string `json:"label,omitempty"`
Name *string `json:"name,omitempty"`
Options *map[string]string `json:"options,omitempty"`
Properties *map[string]string `json:"properties,omitempty"`
Required *bool `json:"required,omitempty"`
Type *string `json:"type,omitempty"`
Validation *distributedtaskcommon.TaskInputValidation `json:"validation,omitempty"`
VisibleRule *string `json:"visibleRule,omitempty"`
}
type TaskInstance ¶
type TaskInstance struct {
Id *uuid.UUID `json:"id,omitempty"`
Inputs *map[string]string `json:"inputs,omitempty"`
Name *string `json:"name,omitempty"`
Version *string `json:"version,omitempty"`
AlwaysRun *bool `json:"alwaysRun,omitempty"`
Condition *string `json:"condition,omitempty"`
ContinueOnError *bool `json:"continueOnError,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Environment *map[string]string `json:"environment,omitempty"`
InstanceId *uuid.UUID `json:"instanceId,omitempty"`
RefName *string `json:"refName,omitempty"`
TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"`
}
type TaskLog ¶
type TaskLog struct {
Id *int `json:"id,omitempty"`
Location *string `json:"location,omitempty"`
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
IndexLocation *string `json:"indexLocation,omitempty"`
LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"`
LineCount *uint64 `json:"lineCount,omitempty"`
Path *string `json:"path,omitempty"`
}
type TaskLogReference ¶
type TaskOrchestrationContainer ¶
type TaskOrchestrationContainer struct {
ItemType *TaskOrchestrationItemType `json:"itemType,omitempty"`
Children *[]TaskOrchestrationItem `json:"children,omitempty"`
ContinueOnError *bool `json:"continueOnError,omitempty"`
Data *map[string]string `json:"data,omitempty"`
MaxConcurrency *int `json:"maxConcurrency,omitempty"`
Parallel *bool `json:"parallel,omitempty"`
Rollback *TaskOrchestrationContainer `json:"rollback,omitempty"`
}
type TaskOrchestrationItem ¶
type TaskOrchestrationItem struct {
ItemType *TaskOrchestrationItemType `json:"itemType,omitempty"`
}
type TaskOrchestrationItemType ¶
type TaskOrchestrationItemType string
type TaskOrchestrationJob ¶
type TaskOrchestrationJob struct {
ItemType *TaskOrchestrationItemType `json:"itemType,omitempty"`
Demands *[]interface{} `json:"demands,omitempty"`
ExecuteAs *webapi.IdentityRef `json:"executeAs,omitempty"`
ExecutionMode *string `json:"executionMode,omitempty"`
ExecutionTimeout interface{} `json:"executionTimeout,omitempty"`
InstanceId *uuid.UUID `json:"instanceId,omitempty"`
Name *string `json:"name,omitempty"`
RefName *string `json:"refName,omitempty"`
Tasks *[]TaskInstance `json:"tasks,omitempty"`
Variables *map[string]string `json:"variables,omitempty"`
}
type TaskOrchestrationOwner ¶
type TaskOrchestrationPlan ¶
type TaskOrchestrationPlan struct {
ArtifactLocation *string `json:"artifactLocation,omitempty"`
ArtifactUri *string `json:"artifactUri,omitempty"`
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
PlanGroup *string `json:"planGroup,omitempty"`
PlanId *uuid.UUID `json:"planId,omitempty"`
PlanType *string `json:"planType,omitempty"`
ScopeIdentifier *uuid.UUID `json:"scopeIdentifier,omitempty"`
Version *int `json:"version,omitempty"`
Environment *PlanEnvironment `json:"environment,omitempty"`
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
Implementation *TaskOrchestrationContainer `json:"implementation,omitempty"`
InitializationLog *TaskLogReference `json:"initializationLog,omitempty"`
RequestedById *uuid.UUID `json:"requestedById,omitempty"`
RequestedForId *uuid.UUID `json:"requestedForId,omitempty"`
Result *TaskResult `json:"result,omitempty"`
ResultCode *string `json:"resultCode,omitempty"`
StartTime *azuredevops.Time `json:"startTime,omitempty"`
State *TaskOrchestrationPlanState `json:"state,omitempty"`
Timeline *TimelineReference `json:"timeline,omitempty"`
}
type TaskOrchestrationPlanGroup ¶
type TaskOrchestrationPlanGroup struct {
PlanGroup *string `json:"planGroup,omitempty"`
Project *ProjectReference `json:"project,omitempty"`
RunningRequests *[]TaskAgentJobRequest `json:"runningRequests,omitempty"`
}
type TaskOrchestrationPlanGroupsQueueMetrics ¶
type TaskOrchestrationPlanGroupsQueueMetrics struct {
Count *int `json:"count,omitempty"`
Status *PlanGroupStatus `json:"status,omitempty"`
}
type TaskOrchestrationPlanReference ¶
type TaskOrchestrationPlanReference struct {
ArtifactLocation *string `json:"artifactLocation,omitempty"`
ArtifactUri *string `json:"artifactUri,omitempty"`
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
PlanGroup *string `json:"planGroup,omitempty"`
PlanId *uuid.UUID `json:"planId,omitempty"`
PlanType *string `json:"planType,omitempty"`
ScopeIdentifier *uuid.UUID `json:"scopeIdentifier,omitempty"`
Version *int `json:"version,omitempty"`
}
type TaskOrchestrationPlanState ¶
type TaskOrchestrationPlanState string
type TaskOrchestrationQueuedPlan ¶
type TaskOrchestrationQueuedPlan struct {
AssignTime *azuredevops.Time `json:"assignTime,omitempty"`
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
PlanGroup *string `json:"planGroup,omitempty"`
PlanId *uuid.UUID `json:"planId,omitempty"`
PoolId *int `json:"poolId,omitempty"`
QueuePosition *int `json:"queuePosition,omitempty"`
QueueTime *azuredevops.Time `json:"queueTime,omitempty"`
ScopeIdentifier *uuid.UUID `json:"scopeIdentifier,omitempty"`
}
type TaskOrchestrationQueuedPlanGroup ¶
type TaskOrchestrationQueuedPlanGroup struct {
Definition *TaskOrchestrationOwner `json:"definition,omitempty"`
Owner *TaskOrchestrationOwner `json:"owner,omitempty"`
PlanGroup *string `json:"planGroup,omitempty"`
Plans *[]TaskOrchestrationQueuedPlan `json:"plans,omitempty"`
Project *ProjectReference `json:"project,omitempty"`
QueuePosition *int `json:"queuePosition,omitempty"`
}
type TaskOutputVariable ¶
type TaskPackageMetadata ¶
type TaskReference ¶
type TaskResult ¶
type TaskResult string
type TaskSourceDefinition ¶
type TaskStartedEvent ¶
type TaskVersion ¶
type Timeline ¶
type Timeline struct {
ChangeId *int `json:"changeId,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
Location *string `json:"location,omitempty"`
LastChangedBy *uuid.UUID `json:"lastChangedBy,omitempty"`
LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"`
Records *[]TimelineRecord `json:"records,omitempty"`
}
type TimelineAttempt ¶
type TimelineAttempt struct {
// Gets or sets the attempt of the record.
Attempt *int `json:"attempt,omitempty"`
// Gets or sets the unique identifier for the record.
Identifier *string `json:"identifier,omitempty"`
// Gets or sets the record identifier located within the specified timeline.
RecordId *uuid.UUID `json:"recordId,omitempty"`
// Gets or sets the timeline identifier which owns the record representing this attempt.
TimelineId *uuid.UUID `json:"timelineId,omitempty"`
}
type TimelineRecord ¶
type TimelineRecord struct {
Attempt *int `json:"attempt,omitempty"`
ChangeId *int `json:"changeId,omitempty"`
CurrentOperation *string `json:"currentOperation,omitempty"`
Details *TimelineReference `json:"details,omitempty"`
ErrorCount *int `json:"errorCount,omitempty"`
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
Id *uuid.UUID `json:"id,omitempty"`
Identifier *string `json:"identifier,omitempty"`
Issues *[]Issue `json:"issues,omitempty"`
LastModified *azuredevops.Time `json:"lastModified,omitempty"`
Location *string `json:"location,omitempty"`
Log *TaskLogReference `json:"log,omitempty"`
Name *string `json:"name,omitempty"`
Order *int `json:"order,omitempty"`
ParentId *uuid.UUID `json:"parentId,omitempty"`
PercentComplete *int `json:"percentComplete,omitempty"`
PreviousAttempts *[]TimelineAttempt `json:"previousAttempts,omitempty"`
RefName *string `json:"refName,omitempty"`
Result *TaskResult `json:"result,omitempty"`
ResultCode *string `json:"resultCode,omitempty"`
StartTime *azuredevops.Time `json:"startTime,omitempty"`
State *TimelineRecordState `json:"state,omitempty"`
Task *TaskReference `json:"task,omitempty"`
Type *string `json:"type,omitempty"`
Variables *map[string]interface{} `json:"variables,omitempty"`
WarningCount *int `json:"warningCount,omitempty"`
WorkerName *string `json:"workerName,omitempty"`
}
type TimelineRecordState ¶
type TimelineRecordState string
type TimelineReference ¶
type UpdateAgentArgs ¶
type UpdateAgentArgs struct {
// (required) Updated details about the agent
Agent *TaskAgent
// (required) The agent pool to use
PoolId *int
// (required) The agent to update
AgentId *int
}
Arguments for the UpdateAgent function
type UpdateAgentPoolArgs ¶
type UpdateAgentPoolArgs struct {
// (required) Updated agent pool details
Pool *TaskAgentPool
// (required) The agent pool to update
PoolId *int
}
Arguments for the UpdateAgentPool function
type UpdateDeploymentGroupArgs ¶
type UpdateDeploymentGroupArgs struct {
// (required) Deployment group to update.
DeploymentGroup *DeploymentGroupUpdateParameter
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group.
DeploymentGroupId *int
}
Arguments for the UpdateDeploymentGroup function
type UpdateDeploymentTargetsArgs ¶
type UpdateDeploymentTargetsArgs struct {
// (required) Deployment targets with tags to udpdate.
Machines *[]DeploymentTargetUpdateParameter
// (required) Project ID or project name
Project *string
// (required) ID of the deployment group in which deployment targets are updated.
DeploymentGroupId *int
}
Arguments for the UpdateDeploymentTargets function
type UpdateTaskGroupArgs ¶
type UpdateTaskGroupArgs struct {
// (required) Task group to update.
TaskGroup *TaskGroupUpdateParameter
// (required) Project ID or project name
Project *string
// (required) Id of the task group to update.
TaskGroupId *uuid.UUID
}
Arguments for the UpdateTaskGroup function
type UpdateVariableGroupArgs ¶
type UpdateVariableGroupArgs struct {
// (required) Variable group to update.
Group *VariableGroupParameters
// (required) Project ID or project name
Project *string
// (required) Id of the variable group to update.
GroupId *int
}
Arguments for the UpdateVariableGroup function
type ValidationItem ¶
type ValidationItem struct {
// Tells whether the current input is valid or not
IsValid *bool `json:"isValid,omitempty"`
// Reason for input validation failure
Reason *string `json:"reason,omitempty"`
// Type of validation item
Type *string `json:"type,omitempty"`
// Value to validate. The conditional expression to validate for the input for "expression" type Eg:eq(variables['Build.SourceBranch'], 'refs/heads/master');eq(value, 'refs/heads/master')
Value *string `json:"value,omitempty"`
}
type VariableGroup ¶
type VariableGroup struct {
// Gets or sets the identity who created the variable group.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// Gets or sets the time when variable group was created.
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// Gets or sets description of the variable group.
Description *string `json:"description,omitempty"`
// Gets or sets id of the variable group.
Id *int `json:"id,omitempty"`
IsShared *bool `json:"isShared,omitempty"`
// Gets or sets the identity who modified the variable group.
ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
// Gets or sets the time when variable group was modified
ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"`
// Gets or sets name of the variable group.
Name *string `json:"name,omitempty"`
// Gets or sets provider data.
ProviderData interface{} `json:"providerData,omitempty"`
// Gets or sets type of the variable group.
Type *string `json:"type,omitempty"`
// Gets or sets variables contained in the variable group.
Variables *map[string]interface{} `json:"variables,omitempty"`
}
A variable group is a collection of related variables.
type VariableGroupParameters ¶
type VariableGroupParameters struct {
// Sets description of the variable group.
Description *string `json:"description,omitempty"`
// Sets name of the variable group.
Name *string `json:"name,omitempty"`
// Sets provider data.
ProviderData interface{} `json:"providerData,omitempty"`
// Sets type of the variable group.
Type *string `json:"type,omitempty"`
// Sets variables contained in the variable group.
Variables *map[string]interface{} `json:"variables,omitempty"`
}
type VariableGroupProviderData ¶
type VariableGroupProviderData struct {
}
Defines provider data of the variable group.
type VariableGroupQueryOrder ¶
type VariableGroupQueryOrder string
Specifies the desired ordering of variableGroups.
type VariableValue ¶
type VirtualMachine ¶
type VirtualMachineGroup ¶
type VirtualMachineGroup struct {
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
EnvironmentReference *EnvironmentReference `json:"environmentReference,omitempty"`
Id *int `json:"id,omitempty"`
LastModifiedBy *webapi.IdentityRef `json:"lastModifiedBy,omitempty"`
LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"`
Name *string `json:"name,omitempty"`
// Environment resource type
Type *EnvironmentResourceType `json:"type,omitempty"`
PoolId *int `json:"poolId,omitempty"`
}
type VirtualMachineGroupCreateParameters ¶
type VirtualMachineGroupCreateParameters struct {
Name *string `json:"name,omitempty"`
}