Skip to content

Commit e090e68

Browse files
authored
Fix formatting and improve clarity in pools-queues.md
1 parent ac748fc commit e090e68

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

docs/pipelines/agents/pools-queues.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ monikerRange: '<= azure-devops'
1616

1717
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.
1818

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).
2020

2121
::: moniker-end
2222

@@ -74,7 +74,7 @@ By default, all contributors in a project are members of the **User** role on ho
7474

7575
:::moniker range="<=azure-devops"
7676

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).
7878

7979
```yaml
8080
pool:
@@ -93,7 +93,7 @@ For more information, see the [YAML schema](/azure/devops/pipelines/yaml-schema)
9393
9494
# [Classic](#tab/classic)
9595
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).
9797
9898
:::image type="content" source="media/agent-pool-classic.png" alt-text="Screenshot that shows how to select an agent pool and the desired agent.":::
9999
@@ -142,11 +142,11 @@ az pipelines pool list [--action {manage, none, use}]
142142

143143
#### Parameters
144144

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`.
150150

151151
#### Example
152152

@@ -180,10 +180,10 @@ az pipelines pool show --id
180180

181181
#### Parameters
182182

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/`.
187187

188188
#### Example
189189

@@ -229,11 +229,11 @@ az pipelines queue list [--action {manage, none, use}]
229229

230230
#### Parameters
231231

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*).
237237

238238
#### Example
239239

@@ -267,11 +267,11 @@ az pipelines queue show --id
267267

268268
#### Parameters
269269

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.
275275

276276
#### Example
277277

@@ -308,46 +308,46 @@ If you have many self-hosted agents that are intended for different teams or pur
308308

309309
## Create agent pools
310310

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.
312312

313313
::: moniker range="azure-devops"
314314

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:
316316

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.
318318
1. Select **Add pool**, and then select the option to create a new pool.
319319
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
320320

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:
322322

323323
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**.
324324
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.
325325
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
326326

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:
328328

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.
330330
1. Go to the other projects and create a pool in each of them. Select **Use an existing agent pool from the organization**.
331331
1. [Install](agents.md#install) and configure agents to be part of the shared agent pool.
332332
::: moniker-end
333333

334334
::: moniker range="<azure-devops"
335335

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:
337337

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.
340340
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
341341

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:
343343

344344
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**.
345345
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.
346346
1. [Install](agents.md#install) and configure agents to be part of the new agent pool.
347347

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:
349349

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.
351351
1. Go to the other projects and create a pool in each of them. Select **Use an existing agent pool from the organization**.
352352
1. [Install](agents.md#install) and configure agents to be part of the shared agent pool.
353353
::: moniker-end
@@ -356,7 +356,7 @@ You want to share a set of agent machines with some, but not all, of your projec
356356

357357
When you understand how security works for agent pools, you can better control the sharing and use of agents.
358358

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.
360360

361361
### Organization-level security settings
362362

@@ -440,7 +440,7 @@ The maintenance is done per agent pool, not per machine. If you have multiple ag
440440

441441
### The maintenance job of my self-hosted agent pool looks stuck. Why?
442442

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.
444444

445445
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.
446446

@@ -462,7 +462,7 @@ Ask the owner of your Azure DevOps organization to grant you permission to use t
462462

463463
### I need more hosted build resources. What can I do?
464464

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:
466466

467467
* [Host your own agents on infrastructure that you manage](agents.md)
468468
* [Buy more parallel jobs](../../pipelines/licensing/concurrent-jobs.md#how-much-do-parallel-jobs-cost)

0 commit comments

Comments
 (0)