/
TaskAgent.yml
270 lines (270 loc) · 8.72 KB
/
TaskAgent.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
### YamlMime:TSType
name: TaskAgent
uid: azure-devops-extension-api.TaskAgent
package: azure-devops-extension-api
summary: A task agent.
fullName: TaskAgent
remarks: ''
isDeprecated: false
type: interface
properties:
- name: assignedAgentCloudRequest
uid: azure-devops-extension-api.TaskAgent.assignedAgentCloudRequest
package: azure-devops-extension-api
summary: The agent cloud request that's currently associated with this agent.
fullName: assignedAgentCloudRequest
remarks: ''
isDeprecated: false
syntax:
content: 'assignedAgentCloudRequest: TaskAgentCloudRequest'
return:
description: ''
type: <xref uid="azure-devops-extension-api.TaskAgentCloudRequest" />
- name: assignedRequest
uid: azure-devops-extension-api.TaskAgent.assignedRequest
package: azure-devops-extension-api
summary: The request which is currently assigned to this agent.
fullName: assignedRequest
remarks: ''
isDeprecated: false
syntax:
content: 'assignedRequest: TaskAgentJobRequest'
return:
description: ''
type: <xref uid="azure-devops-extension-api.TaskAgentJobRequest" />
- name: authorization
uid: azure-devops-extension-api.TaskAgent.authorization
package: azure-devops-extension-api
summary: Authorization information for this agent.
fullName: authorization
remarks: ''
isDeprecated: false
syntax:
content: 'authorization: TaskAgentAuthorization'
return:
description: ''
type: <xref uid="azure-devops-extension-api.TaskAgentAuthorization" />
- name: createdOn
uid: azure-devops-extension-api.TaskAgent.createdOn
package: azure-devops-extension-api
summary: Date on which this agent was created.
fullName: createdOn
remarks: ''
isDeprecated: false
syntax:
content: 'createdOn: Date'
return:
description: ''
type: Date
- name: lastCompletedRequest
uid: azure-devops-extension-api.TaskAgent.lastCompletedRequest
package: azure-devops-extension-api
summary: The last request which was completed by this agent.
fullName: lastCompletedRequest
remarks: ''
isDeprecated: false
syntax:
content: 'lastCompletedRequest: TaskAgentJobRequest'
return:
description: ''
type: <xref uid="azure-devops-extension-api.TaskAgentJobRequest" />
- name: maxParallelism
uid: azure-devops-extension-api.TaskAgent.maxParallelism
package: azure-devops-extension-api
summary: Maximum job parallelism allowed for this agent.
fullName: maxParallelism
remarks: ''
isDeprecated: false
syntax:
content: 'maxParallelism: number'
return:
description: ''
type: number
- name: pendingUpdate
uid: azure-devops-extension-api.TaskAgent.pendingUpdate
package: azure-devops-extension-api
summary: Pending update for this agent.
fullName: pendingUpdate
remarks: ''
isDeprecated: false
syntax:
content: 'pendingUpdate: TaskAgentUpdate'
return:
description: ''
type: <xref uid="azure-devops-extension-api.TaskAgentUpdate" />
- name: properties
uid: azure-devops-extension-api.TaskAgent.properties
package: azure-devops-extension-api
summary: ''
fullName: properties
remarks: ''
isDeprecated: false
syntax:
content: 'properties: any'
return:
description: ''
type: any
- name: statusChangedOn
uid: azure-devops-extension-api.TaskAgent.statusChangedOn
package: azure-devops-extension-api
summary: Date on which the last connectivity status change occurred.
fullName: statusChangedOn
remarks: ''
isDeprecated: false
syntax:
content: 'statusChangedOn: Date'
return:
description: ''
type: Date
- name: systemCapabilities
uid: azure-devops-extension-api.TaskAgent.systemCapabilities
package: azure-devops-extension-api
summary: >-
System-defined capabilities supported by this agent's host. Warning: To
set capabilities use the PUT method, PUT will completely overwrite
existing capabilities.
fullName: systemCapabilities
remarks: ''
isDeprecated: false
syntax:
content: 'systemCapabilities: {[key: string]: string}'
return:
description: ''
type: '{[key: string]: string}'
- name: userCapabilities
uid: azure-devops-extension-api.TaskAgent.userCapabilities
package: azure-devops-extension-api
summary: >-
User-defined capabilities supported by this agent's host. Warning: To set
capabilities use the PUT method, PUT will completely overwrite existing
capabilities.
fullName: userCapabilities
remarks: ''
isDeprecated: false
syntax:
content: 'userCapabilities: {[key: string]: string}'
return:
description: ''
type: '{[key: string]: string}'
inheritedProperties:
- name: accessPoint
uid: azure-devops-extension-api.TaskAgent.accessPoint
package: azure-devops-extension-api
summary: This agent's access point.
fullName: accessPoint
remarks: ''
isDeprecated: false
syntax:
content: 'accessPoint: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.accessPoint](xref:azure-devops-extension-api.TaskAgentReference.accessPoint)
- name: enabled
uid: azure-devops-extension-api.TaskAgent.enabled
package: azure-devops-extension-api
summary: Whether or not this agent should run jobs.
fullName: enabled
remarks: ''
isDeprecated: false
syntax:
content: 'enabled: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.enabled](xref:azure-devops-extension-api.TaskAgentReference.enabled)
- name: id
uid: azure-devops-extension-api.TaskAgent.id
package: azure-devops-extension-api
summary: Identifier of the agent.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.id](xref:azure-devops-extension-api.TaskAgentReference.id)
- name: name
uid: azure-devops-extension-api.TaskAgent.name
package: azure-devops-extension-api
summary: Name of the agent.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.name](xref:azure-devops-extension-api.TaskAgentReference.name)
- name: osDescription
uid: azure-devops-extension-api.TaskAgent.osDescription
package: azure-devops-extension-api
summary: Agent OS.
fullName: osDescription
remarks: ''
isDeprecated: false
syntax:
content: 'osDescription: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.osDescription](xref:azure-devops-extension-api.TaskAgentReference.osDescription)
- name: provisioningState
uid: azure-devops-extension-api.TaskAgent.provisioningState
package: azure-devops-extension-api
summary: Provisioning state of this agent.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.provisioningState](xref:azure-devops-extension-api.TaskAgentReference.provisioningState)
- name: status
uid: azure-devops-extension-api.TaskAgent.status
package: azure-devops-extension-api
summary: Whether or not the agent is online.
fullName: status
remarks: ''
isDeprecated: false
syntax:
content: 'status: TaskAgentStatus'
return:
description: ''
type: <xref uid="azure-devops-extension-api.TaskAgentStatus" />
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.status](xref:azure-devops-extension-api.TaskAgentReference.status)
- name: version
uid: azure-devops-extension-api.TaskAgent.version
package: azure-devops-extension-api
summary: Agent version.
fullName: version
remarks: ''
isDeprecated: false
syntax:
content: 'version: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TaskAgentReference.version](xref:azure-devops-extension-api.TaskAgentReference.version)
extends: <xref uid="azure-devops-extension-api.TaskAgentReference" />