Microsoft.DevOpsInfrastructure pools

Article
10/24/2024

Bicep resource definition

The pools resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevOpsInfrastructure/pools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevOpsInfrastructure/pools@2024-10-19' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    agentProfile: {
      resourcePredictions: any(Azure.Bicep.Types.Concrete.AnyType)
      resourcePredictionsProfile: {
        kind: 'string'
        // For remaining properties, see ResourcePredictionsProfile objects
      }
      kind: 'string'
      // For remaining properties, see AgentProfile objects
    }
    devCenterProjectResourceId: 'string'
    fabricProfile: {
      kind: 'string'
      // For remaining properties, see FabricProfile objects
    }
    maximumConcurrency: int
    organizationProfile: {
      kind: 'string'
      // For remaining properties, see OrganizationProfile objects
    }
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

AgentProfile objects

Set the kind property to specify the type of object.

For Stateful, use:

{
  gracePeriodTimeSpan: 'string'
  kind: 'Stateful'
  maxAgentLifetime: 'string'
}

For Stateless, use:

{
  kind: 'Stateless'
}

ResourcePredictionsProfile objects

Set the kind property to specify the type of object.

For Automatic, use:

{
  kind: 'Automatic'
  predictionPreference: 'string'
}

For Manual, use:

{
  kind: 'Manual'
}

FabricProfile objects

Set the kind property to specify the type of object.

For Vmss, use:

{
  images: [
    {
      aliases: [
        'string'
      ]
      buffer: 'string'
      resourceId: 'string'
      wellKnownImageName: 'string'
    }
  ]
  kind: 'Vmss'
  networkProfile: {
    subnetId: 'string'
  }
  osProfile: {
    logonType: 'string'
    secretsManagementSettings: {
      certificateStoreLocation: 'string'
      keyExportable: bool
      observedCertificates: [
        'string'
      ]
    }
  }
  sku: {
    name: 'string'
  }
  storageProfile: {
    dataDisks: [
      {
        caching: 'string'
        diskSizeGiB: int
        driveLetter: 'string'
        storageAccountType: 'string'
      }
    ]
    osDiskStorageAccountType: 'string'
  }
}

OrganizationProfile objects

Set the kind property to specify the type of object.

For AzureDevOps, use:

{
  kind: 'AzureDevOps'
  organizations: [
    {
      parallelism: int
      projects: [
        'string'
      ]
      url: 'string'
    }
  ]
  permissionProfile: {
    groups: [
      'string'
    ]
    kind: 'string'
    users: [
      'string'
    ]
  }
}

For GitHub, use:

{
  kind: 'GitHub'
  organizations: [
    {
      repositories: [
        'string'
      ]
      url: 'string'
    }
  ]
}

Property values

AgentProfile

Name	Description	Value
kind	Set to 'Stateful' for type Stateful. Set to 'Stateless' for type StatelessAgentProfile.	'Stateful' 'Stateless' (required)
resourcePredictions	Defines pool buffer/stand-by agents.	any
resourcePredictionsProfile	Defines how the pool buffer/stand-by agents is provided.	ResourcePredictionsProfile

AutomaticResourcePredictionsProfile

Name	Description	Value
kind	Determines how the stand-by scheme should be provided.	'Automatic' (required)
predictionPreference	Determines the balance between cost and performance.	'Balanced' 'BestPerformance' 'MoreCostEffective' 'MorePerformance' 'MostCostEffective'

AzureDevOpsOrganizationProfile

Name	Description	Value
kind	Discriminator property for OrganizationProfile.	'AzureDevOps' (required)
organizations	The list of Azure DevOps organizations the pool should be present in.	Organization[] (required)
permissionProfile	The type of permission which determines which accounts are admins on the Azure DevOps pool.	AzureDevOpsPermissionProfile

AzureDevOpsPermissionProfile

Name	Description	Value
groups	Group email addresses	string[]
kind	Determines who has admin permissions to the Azure DevOps pool.	'CreatorOnly' 'Inherit' 'SpecificAccounts' (required)
users	User email addresses	string[]

DataDisk

Name	Description	Value
caching	The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.	'None' 'ReadOnly' 'ReadWrite'
diskSizeGiB	The initial disk size in gigabytes.	int
driveLetter	The drive letter for the empty data disk. If not specified, it will be the first available letter.	string
storageAccountType	The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs".	'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS'

DevOpsAzureSku

Name	Description	Value
name	The Azure SKU name of the machines in the pool.	string (required)

FabricProfile

Name	Description	Value
kind	Set to 'Vmss' for type VmssFabricProfile.	'Vmss' (required)

GitHubOrganization

Name	Description	Value
repositories	Optional list of repositories in which the pool should be created.	string[]
url	The GitHub organization URL in which the pool should be created.	string (required)

GitHubOrganizationProfile

Name	Description	Value
kind	Discriminator property for OrganizationProfile.	'GitHub' (required)
organizations	The list of GitHub organizations/repositories the pool should be present in.	GitHubOrganization[] (required)

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

ManualResourcePredictionsProfile

Name	Description	Value
kind	Determines how the stand-by scheme should be provided.	'Manual' (required)