Quickstart: Create a Managed DevOps Pool using an ARM template

Article
10/18/2024

Important

Managed DevOps Pools is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

This article shows you how to create a Managed DevOps Pool using an ARM template, and run a pipeline in the new pool.

Prerequisites

Before completing the steps in this article, you must have configured your Azure subscription and Azure DevOps organization for use with Managed DevOps Pools, as described in the Prerequisites article. These steps need to be completed only once per Azure subscription and Azure DevOps organization.

Open a command prompt (on Windows, use Windows Command Prompt or PowerShell) and run the following commands.

Sign in the to Azure CLI.
```
az login
```
If you have more than one Azure subscription, set your default Azure subscription.
```
az account set --subscription "My subscription name"
```
To get a list of your subscriptions, you can run the following command.
```
az account list -o table
```
If you have multiple tenants, or want to see more information about working with Azure subscription using Azure CLI, see How to manage Azure subscriptions with the Azure CLI.

Create a resource group, Dev Center, and Dev Center Project

Follow the Create a dev center steps in Create and configure a dev center for Azure Deployment Environments by using the Azure CLI.

You only need to follow the steps in the Create a dev center section. Make a note of the resource group name and Dev Center name.
Follow the Create a project steps in Create and configure a project by using the Azure CLI.

Make a note of the id of the created project (not the devCenterId).

Review and save the template

Create a local file name mdp-azure-deploy.json with the following contents. This file is a parameterized ARM template that creates a microsoft.devopsinfrastructure/pools resource.

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "poolName": {
            "type": "string"
        },
        "adoOrg": {
            "type": "string"
        },
        "devCenterResourceId": {
            "type": "string"
        },
        "imageName": {
            "type": "string"
        },
        "poolSize": {
            "type": "int"
        },
        "location": {
            "type": "string",
            "defaultValue": "eastus"
        }
    },
    "variables": {},
    "resources": [
        {
            "name": "[parameters('poolName')]",
            "type": "microsoft.devopsinfrastructure/pools",
            "apiVersion": "2024-04-04-preview",
            "location": "[parameters('location')]",
            "tags": {},
            "properties": {
                "organizationProfile": {
                    "organizations": [
                        {
                            "url": "[parameters('adoOrg')]",
                            "parallelism": 1
                        }
                    ],
                    "permissionProfile": {
                        "kind": "CreatorOnly"
                    },
                    "kind": "AzureDevOps"
                },
                "devCenterProjectResourceId": "[parameters('devCenterResourceId')]",
                "maximumConcurrency": "[parameters('poolSize')]",
                "agentProfile": {
                    "kind": "Stateless"
                },
                "fabricProfile": {
                    "sku": {
                        "name": "Standard_D2ads_v5"
                    },
                    "images": [
                        {
                            "wellKnownImageName": "[parameters('imageName')]",
                            "buffer": "*"
                        }
                    ],
                    "kind": "Vmss"
                }
            }
        }
    ]
}

Create another local file named mdp-azure-deploy-parameters.json and save it in the same folder as the first file. Update the following properties to match the details of your environment.

Parameter	Value
`poolName`	Update `value` with the desired name of your pool. The name must consist of alphanumeric characters, `.`, `-`, or `_`, and be between 3 and 44 characters in length. The name must be globally unique in Azure.
`adoOrg`	Update `value` and replace `your-organization` with the name of your Azure DevOps organization.
`devCenterResourceId`	Update `value` with the `id` from the previous Create a resource group, Dev Center, and Dev Center Project step.
`imageName`	This example is configured to use an Azure Pipelines image, and uses the Windows Server 2022 image. If you want to change it, choose from the Azure Pipelines image predefined aliases. Managed DevOps Pools also supports Azure Compute Gallery images and selected marketplace images. For information on configuring a Managed DevOps Pools resource for these image types, see Configure Managed DevOps Pools images.
`poolSize`	Update `value` with the maximum number of agents you want to be able to run concurrent jobs. In this example the `poolSize` is `1`.
`location`	The Azure region for the pool. In this example the region is `eastus`.

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "poolName": {
            "value": "my-first-managed-pool"
        },
        "adoOrg": {
            "value": "https://dev.azure.com/your-organization"
        },
        "devCenterResourceId": {
            "value": "/subscriptions/subscription_id_placeholder/resourceGroups/fabrikam-managed-devops-pools/providers/Microsoft.DevCenter/projects/fabrikam-dev-center-project"
        },
        "imageName": {
            "value": "windows-2022"
        },
        "poolSize": {
            "value": 1
        },
        "location": {
            "value": "eastus"
        }
    }
}

Create the Managed DevOps Pool

Open a command prompt (on Windows, use Windows Command Prompt or PowerShell) and run the following commands. You can skip the first two commands if your Azure CLI session from the first procedure is still active.

Sign in the to Azure CLI.
```
az login
```
If you have more than one Azure subscription, set your default Azure subscription.
```
az account set --subscription "My subscription name"
```
To get a list of your subscriptions, you can run the following command.
```
az account list -o table
```
If you have multiple tenants, or want to see more information about working with Azure subscription using Azure CLI, see How to manage Azure subscriptions with the Azure CLI.
Go to the folder when you saved the two JSON files from the previous step. In this example, the files are saved to C:\examples.
```
cd c:\examples
```
Create the Managed DevOps Pool. Replace <resourceGroupName> with the resource group created in the first step.
```
az deployment group create --resource-group <resourceGroupName> --template-file mdp-azure-deploy.json --parameters mdp-azure-deploy-parameters.json
```
If your subscription doesn't have the capacity to configure your pool with desired Azure VM SKU and maximum agents count, pool creation fails with an error similar to the following message. Cores needed to complete this request is 8, which exceeds the current limit of 0 for SKU family standardDDSv4Family in region eastus. Please choose a different region if possible, or request additional quota at https://portal.azure.com/#view/Microsoft_Azure_Support/NewSupportRequestV3Blade/issueType/quota/subscriptionId/subscription_id_placeholder/topicId/3eadc5d3-b59a-3658-d8c6-9c729ba35b97. To resolve the issue, see Review Managed DevOps Pools quotas.

View your created pool in the Azure portal

Sign in to the Azure portal.
Search for Managed DevOps Pools and select it from the available options.
Choose your new Managed DevOps Pool from the list.
Choose JSON View to see the JSON format of your Managed DevOps Pools resource.

View the agent pool in Azure DevOps

Go to the Azure DevOps portal and sign in to your Azure DevOps organization (https://dev.azure.com/{your-organization}).
Go to Azure DevOps > Organization settings.
Go to Pipelines > Agent pools, and verify that your new pool is listed. If you just created the Managed DevOps Pool, it can take a few moments for the new pool to appear in the agents list.

Run a pipeline in your new pool

In this step, we'll create a simple pipeline in the default repository of an Azure DevOps project and run it in your new Managed DevOps Pool.

Go to the Azure DevOps portal and sign in to your Azure DevOps organization (https://dev.azure.com/{your-organization}).
Go to the project where you want to run the pipeline, and choose Pipelines.
Choose New pipeline (or Create Pipeline if this is your first pipeline).
Choose Azure Repos Git.
Choose the repository that has the same name as your project. In this example, the project is named FabrikamFiber, so we choose the repository with the same name.
Choose Starter pipeline.
By default the starter template uses a Microsoft hosted Linux agent. Edit the pipeline template and change the pool section so that it refers to the pool you created in the previous steps.
```
# Change these two lines as shown in the following example.
 pool:
  vmImage: ubuntu-latest
```
In this example, the Managed DevOps Pools is named fabrikam-managed-pool, so replace vmImage: ubuntu-latest with name: fabrikam-managed-pools, and specify the name of your Managed DevOps Pool.
```
# Replace fabrikam-managed-pools with the name
# of your Managed DevOps Pool.
pool:
  name: fabrikam-managed-pool
```
Choose Save and run, and choose Save and run a second time to confirm.
If this is the first pipeline run in this pool, you may be asked to grant permissions before the pipeline runs.
Watch the pipeline run in Azure DevOps, and you can switch over to the Azure portal and see the running agent in the Agents view.