Share via

Microsoft.DevCenter projects/pools 2024-05-01-preview

  • Article

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.DevCenter/projects/pools@2024-05-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    devBoxDefinitionName: 'string'
    displayName: 'string'
    licenseType: 'string'
    localAdministrator: 'string'
    managedVirtualNetworkRegions: [
      'string'
    ]
    networkConnectionName: 'string'
    singleSignOnStatus: 'string'
    stopOnDisconnect: {
      gracePeriodMinutes: int
      status: 'string'
    }
    virtualNetworkType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.DevCenter/projects/pools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: projects
properties Pool properties PoolProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

PoolProperties

Name Description Value
devBoxDefinitionName Name of a Dev Box definition in parent Project of this Pool string
displayName The display name of the pool. string
licenseType Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. 'Windows_Client'
localAdministrator Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. 'Disabled'
'Enabled'
managedVirtualNetworkRegions The regions of the managed virtual network (required when managedNetworkType is Managed). string[]
networkConnectionName Name of a Network Connection in parent Project of this Pool string
singleSignOnStatus Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant. 'Disabled'
'Enabled'
stopOnDisconnect Stop on disconnect configuration settings for Dev Boxes created in this pool. StopOnDisconnectConfiguration
virtualNetworkType Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. 'Managed'
'Unmanaged'

StopOnDisconnectConfiguration

Name Description Value
gracePeriodMinutes The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. int
status Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Configure Dev Box service This template would create all Dev Box admin resources as per Dev Box quick start guide (/azure/dev-box/quickstart-create-dev-box). You can view all resources created, or directly go to DevPortal.microsoft.com to create your first Dev Box.
Deploy Dev Box Service with built-in image This template provides a way to deploy an Dev Box service with built-in image.

ARM template resource definition

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

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

Resource format

To create a Microsoft.DevCenter/projects/pools resource, add the following JSON to your template.

{
  "type": "Microsoft.DevCenter/projects/pools",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "devBoxDefinitionName": "string",
    "displayName": "string",
    "licenseType": "string",
    "localAdministrator": "string",
    "managedVirtualNetworkRegions": [ "string" ],
    "networkConnectionName": "string",
    "singleSignOnStatus": "string",
    "stopOnDisconnect": {
      "gracePeriodMinutes": "int",
      "status": "string"
    },
    "virtualNetworkType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.DevCenter/projects/pools

Name Description Value
apiVersion The api version '2024-05-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
properties Pool properties PoolProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevCenter/projects/pools'

PoolProperties

Name Description Value
devBoxDefinitionName Name of a Dev Box definition in parent Project of this Pool string
displayName The display name of the pool. string
licenseType Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. 'Windows_Client'
localAdministrator Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. 'Disabled'
'Enabled'
managedVirtualNetworkRegions The regions of the managed virtual network (required when managedNetworkType is Managed). string[]
networkConnectionName Name of a Network Connection in parent Project of this Pool string
singleSignOnStatus Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant. 'Disabled'
'Enabled'
stopOnDisconnect Stop on disconnect configuration settings for Dev Boxes created in this pool. StopOnDisconnectConfiguration
virtualNetworkType Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. 'Managed'
'Unmanaged'

StopOnDisconnectConfiguration

Name Description Value
gracePeriodMinutes The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. int
status Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Configure Dev Box service

Deploy to Azure		 This template would create all Dev Box admin resources as per Dev Box quick start guide (/azure/dev-box/quickstart-create-dev-box). You can view all resources created, or directly go to DevPortal.microsoft.com to create your first Dev Box.
Deploy Dev Box Service with built-in image

Deploy to Azure		 This template provides a way to deploy an Dev Box service with built-in image.

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

To create a Microsoft.DevCenter/projects/pools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevCenter/projects/pools@2024-05-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      devBoxDefinitionName = "string"
      displayName = "string"
      licenseType = "string"
      localAdministrator = "string"
      managedVirtualNetworkRegions = [
        "string"
      ]
      networkConnectionName = "string"
      singleSignOnStatus = "string"
      stopOnDisconnect = {
        gracePeriodMinutes = int
        status = "string"
      }
      virtualNetworkType = "string"
    }
  })
}

Property values

Microsoft.DevCenter/projects/pools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: projects
properties Pool properties PoolProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevCenter/projects/pools@2024-05-01-preview"

PoolProperties

Name Description Value
devBoxDefinitionName Name of a Dev Box definition in parent Project of this Pool string
displayName The display name of the pool. string
licenseType Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. 'Windows_Client'
localAdministrator Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. 'Disabled'
'Enabled'
managedVirtualNetworkRegions The regions of the managed virtual network (required when managedNetworkType is Managed). string[]
networkConnectionName Name of a Network Connection in parent Project of this Pool string
singleSignOnStatus Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant. 'Disabled'
'Enabled'
stopOnDisconnect Stop on disconnect configuration settings for Dev Boxes created in this pool. StopOnDisconnectConfiguration
virtualNetworkType Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. 'Managed'
'Unmanaged'

StopOnDisconnectConfiguration

Name Description Value
gracePeriodMinutes The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. int
status Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value