You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pipelines/agents/pools-queues.md
+37-37Lines changed: 37 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ monikerRange: '<= azure-devops'
16
16
17
17
An agent pool is a collection of agents. Instead of managing each [agent](agents.md) individually, you organize agents into agent pools. When you configure an agent, it's registered with a single pool. When you create a pipeline, you specify the pool in which the pipeline runs. When you run the pipeline, it runs on an agent from that pool that meets the [demands](/azure/devops/pipelines/yaml-schema/pool-demands) of the pipeline.
18
18
19
-
Managed DevOps Pools agent pools are managed in the Azure portal. If you're using Managed DevOps Pools, see [Create your first Managed DevOps Pool](../../managed-devops-pools/quickstart-azure-portal.md).
19
+
Managed DevOps Pools agent pools are managed in the Azure portal. If you're using Managed DevOps Pools, see the [quickstart for creating a pool](../../managed-devops-pools/quickstart-azure-portal.md).
20
20
21
21
::: moniker-end
22
22
@@ -74,7 +74,7 @@ By default, all contributors in a project are members of the **User** role on ho
74
74
75
75
:::moniker range="<=azure-devops"
76
76
77
-
To choose a Microsoft-hosted agent from the Azure Pipelines pool in your Azure DevOps Services YAML pipeline, specify the name of the image, by using the **YAML VM Image Label** from [this table](hosted.md#use-a-microsoft-hosted-agent).
77
+
To choose a Microsoft-hosted agent from the Azure Pipelines pool in your Azure DevOps Services YAML pipeline, specify the name of the image by using the **YAML VM Image Label** from [this table](hosted.md#use-a-microsoft-hosted-agent).
78
78
79
79
```yaml
80
80
pool:
@@ -93,7 +93,7 @@ For more information, see the [YAML schema](/azure/devops/pipelines/yaml-schema)
93
93
94
94
# [Classic](#tab/classic)
95
95
96
-
To choose a pool and agent in the classic editor, go to the pipeline settings. Select the desired **Agent pool** and the desired image from the **Agent Specification** dropdown menu. The default **Agent Specification** selection is *windows-2019*. For more information about the software installed on Microsoft-hosted images, see the corresponding entry in the **Classic Editor Pool** column from [this table](hosted.md#use-a-microsoft-hosted-agent).
96
+
To choose a pool and agent in the classic editor, go to the pipeline settings. Select the desired **Agent pool** value and the desired image from the **Agent Specification** dropdown menu. The default **Agent Specification** selection is **windows-2019**. For more information about the software installed on Microsoft-hosted images, see the corresponding entry in the **Classic Editor Pool** column from [this table](hosted.md#use-a-microsoft-hosted-agent).
97
97
98
98
:::image type="content" source="media/agent-pool-classic.png" alt-text="Screenshot that shows how to select an agent pool and the desired agent.":::
99
99
@@ -142,11 +142,11 @@ az pipelines pool list [--action {manage, none, use}]
142
142
143
143
#### Parameters
144
144
145
-
* **action**: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
146
-
* **detect**: Automatically detect the organization. Accepted values are `false` and `true`.
147
-
* **org** or **organization**: Azure DevOps organization URL. You can configure the default organization by using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
148
-
* **pool-name**: Filter the list with a matching pool name.
149
-
* **pool-type**: Filter the list with the type of pool. Accepted values are `automation` and `deployment`.
145
+
* `action`: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
146
+
* `detect`: Automatically detect the organization. Accepted values are `false` and `true`.
147
+
* `org` or `organization`: Azure DevOps organization URL. You can configure the default organization by using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
148
+
* `pool-name`: Filter the list with a matching pool name.
149
+
* `pool-type`: Filter the list with the type of pool. Accepted values are `automation` and `deployment`.
150
150
151
151
#### Example
152
152
@@ -180,10 +180,10 @@ az pipelines pool show --id
180
180
181
181
#### Parameters
182
182
183
-
* **id** or **pool-id**: (Required) ID of the pool to list the details.
184
-
* **action**: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
185
-
* **detect**: Automatically detect the organization. Accepted values are `false` and `true`.
186
-
* **org** or **organization**: Azure DevOps organization URL. You can configure the default organization by using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
183
+
* `id` or `pool-id`: (Required) ID of the pool to list the details.
184
+
* `action`: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
185
+
* `detect`: Automatically detect the organization. Accepted values are `false` and `true`.
186
+
* `org` or `organization`: Azure DevOps organization URL. You can configure the default organization by using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
187
187
188
188
#### Example
189
189
@@ -229,11 +229,11 @@ az pipelines queue list [--action {manage, none, use}]
229
229
230
230
#### Parameters
231
231
232
-
* **action**: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
233
-
* **detect**: Automatically detect the organization. Accepted values are `false` and `true`.
234
-
* **org** or **organization**: Azure DevOps organization URL. You can configure the default organization using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
235
-
* **project** or **p**: The name or ID of the project. You can configure the default project by using `az devops configure -d project=NAME_OR_ID`. This process is required if it's not configured as default or picked up via git config.
236
-
* **queue-name**: Filter the list with a matching queue name regex (for example, *ubuntu* for a queue named *Hosted Ubuntu 1604*).
232
+
* `action`: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
233
+
* `detect`: Automatically detect the organization. Accepted values are `false` and `true`.
234
+
* `org` or `organization`: Azure DevOps organization URL. You can configure the default organization using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
235
+
* `project` or `p`: The name or ID of the project. You can configure the default project by using `az devops configure -d project=NAME_OR_ID`. This process is required if it's not configured as default or picked up via git config.
236
+
* `queue-name`: Filter the list with a matching queue name regex (for example, *ubuntu* for a queue named *Hosted Ubuntu 1604*).
237
237
238
238
#### Example
239
239
@@ -267,11 +267,11 @@ az pipelines queue show --id
267
267
268
268
#### Parameters
269
269
270
-
* **id** or **queue-id**: ID of the agent queue to get information about.
271
-
* **action**: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
272
-
* **detect**: Automatically detect the organization. Accepted values are `false` and `true`.
273
-
* **org** or **organization**: Azure DevOps organization URL. You can configure the default organization using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
274
-
* **project** or **p**: Name or ID of the project. You can configure the default project by using `az devops configure -d project=NAME_OR_ID`. This process is required if it's not configured as default or picked up via git config.
270
+
* `id` or `queue-id`: ID of the agent queue to get information about.
271
+
* `action`: Filter the list with user action permitted. Accepted values are `manage`, `none`, and `use`.
272
+
* `detect`: Automatically detect the organization. Accepted values are `false` and `true`.
273
+
* `org` or `organization`: Azure DevOps organization URL. You can configure the default organization using `az devops configure -d organization=ORG_URL`. This process is required if it's not configured as default or picked up via git config. For example: `https://dev.azure.com/MyOrganizationName/`.
274
+
* `project` or `p`: Name or ID of the project. You can configure the default project by using `az devops configure -d project=NAME_OR_ID`. This process is required if it's not configured as default or picked up via git config.
275
275
276
276
#### Example
277
277
@@ -308,46 +308,46 @@ If you have many self-hosted agents that are intended for different teams or pur
308
308
309
309
## Create agent pools
310
310
311
-
Here are some typical situations when you might want to create self-hosted agent pools:
311
+
Here are some typical situations when you might want to create self-hosted agent pools.
312
312
313
313
::: moniker range="azure-devops"
314
314
315
-
You're a member of a project and you want to use a set of machines that your team owns to run build and deployment jobs.
315
+
You're a member of a project and want to use a set of machines that your team owns to run build and deployment jobs:
316
316
317
-
1. Make sure that you have permissions to create pools in your project. In **Project settings**, go to the **Agent pools** pane, and select **Security**. To create new pools, you must have the **Administrator** role.
317
+
1. Make sure that you have permissions to create pools in your project. In **Project settings**, go to the **Agent pools** pane and select **Security**. To create new pools, you must have the **Administrator** role.
318
318
1. Select **Add pool**, and then select the option to create a new pool.
319
319
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
320
320
321
-
You're a member of the infrastructure team and would like to set up a pool of agents to use in all projects.
321
+
You're a member of the infrastructure team and want to set up a pool of agents to use in all projects:
322
322
323
323
1. Make sure that you have permissions to create pools in your project. In **Organization settings**, go to the **Agent pools** pane and select **Security**.
324
324
1. Create a **New agent pool** and select the option **Auto-provision this agent pool in all projects** when you create the pool. This setting ensures that all projects have access to this agent pool.
325
325
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
326
326
327
-
You want to share a set of agent machines with some, but not all, of your projects.
327
+
You want to share a set of agent machines with some, but not all, of your projects:
328
328
329
-
1. Go to **Settings** for one of the projects. Add an agent pool, and select the option to create a **new** pool at the organization level.
329
+
1. Go to **Settings** for one of the projects. Add an agent pool, and select the option to create a new pool at the organization level.
330
330
1. Go to the other projects and create a pool in each of them. Select **Use an existing agent pool from the organization**.
331
331
1. [Install](agents.md#install) and configure agents to be part of the shared agent pool.
332
332
::: moniker-end
333
333
334
334
::: moniker range="<azure-devops"
335
335
336
-
You're a member of a project and want to use a set of machines that your team owns to run build and deployment jobs.
336
+
You're a member of a project and want to use a set of machines that your team owns to run build and deployment jobs:
337
337
338
-
1. Make sure you have permissions to create pools in your project. In **Project settings**, go to the **Agent pools** pane, and select **Security**. To create new pools, you must have the **Administrator** role.
339
-
1. Select **Add pool**, and then select the option to create a **new** pool.
338
+
1. Make sure you have permissions to create pools in your project. In **Project settings**, go to the **Agent pools** pane and select **Security**. To create new pools, you must have the **Administrator** role.
339
+
1. Select **Add pool**, and then select the option to create a new pool.
340
340
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
341
341
342
-
You're a member of the infrastructure team and would like to set up a pool of agents to use in all projects.
342
+
You're a member of the infrastructure team and want to set up a pool of agents to use in all projects:
343
343
344
344
1. Make sure you have the permissions to create pools in your project. In **Organization settings**, go to the **Agent pools** pane and select **Security**.
345
345
1. Create a **New agent pool** and select the option **Auto-provision this agent pool in all projects** when you create the pool. This setting ensures that all projects have access to this agent pool.
346
346
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
347
347
348
-
You want to share a set of agent machines with some, but not all, of your projects.
348
+
You want to share a set of agent machines with some, but not all, of your projects:
349
349
350
-
1. Go to **Settings** for one of the projects. Add an agent pool, and select the option to create a **new** pool at the organization level.
350
+
1. Go to **Settings** for one of the projects. Add an agent pool, and select the option to create a new pool at the organization level.
351
351
1. Go to the other projects and create a pool in each of them. Select **Use an existing agent pool from the organization**.
352
352
1. [Install](agents.md#install) and configure agents to be part of the shared agent pool.
353
353
::: moniker-end
@@ -356,7 +356,7 @@ You want to share a set of agent machines with some, but not all, of your projec
356
356
357
357
When you understand how security works for agent pools, you can better control the sharing and use of agents.
358
358
359
-
**Roles** are defined on each agent pool, and **membership** in these roles governs what operations you can perform on an agent pool.
359
+
*Roles* are defined on each agent pool. *Membership* in these roles governs what operations you can perform on an agent pool.
360
360
361
361
### Organization-level security settings
362
362
@@ -440,7 +440,7 @@ The maintenance is done per agent pool, not per machine. If you have multiple ag
440
440
441
441
### The maintenance job of my self-hosted agent pool looks stuck. Why?
442
442
443
-
Typically, a maintenance job gets *stuck* when it's waiting to run on an agent that's no longer in the agent pool. For example, an agent was purposefully taken offline, or there are issues communicating with it.
443
+
Typically, a maintenance job gets stuck when it's waiting to run on an agent that's no longer in the agent pool. For example, an agent was purposefully taken offline, or there are issues communicating with it.
444
444
445
445
Maintenance jobs that are queued to run wait seven days to run. If they aren't run during that time, they automatically are in a failed state. You can't change this time limit.
446
446
@@ -462,7 +462,7 @@ Ask the owner of your Azure DevOps organization to grant you permission to use t
462
462
463
463
### I need more hosted build resources. What can I do?
464
464
465
-
The Azure Pipelines pool provides all Azure DevOps organizations with cloud-hosted build agents and free build minutes each month. If you need more Microsoft-hosted build resources, or need to run more jobs in parallel, then you can either:
465
+
The Azure Pipelines pool provides all Azure DevOps organizations with cloud-hosted build agents and free build minutes each month. If you need more Microsoft-hosted build resources, or you need to run more jobs in parallel, then you can either:
466
466
467
467
* [Host your own agents on infrastructure that you manage](agents.md)
468
468
* [Buy more parallel jobs](../../pipelines/licensing/concurrent-jobs.md#how-much-do-parallel-jobs-cost)
0 commit comments