Share via

Microsoft.DevCenter projects/pools 2023-01-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@2023-01-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    devBoxDefinitionName: 'string'
    licenseType: 'Windows_Client'
    localAdministrator: 'string'
    networkConnectionName: 'string'
    stopOnDisconnect: {
      gracePeriodMinutes: int
      status: 'string'
    }
  }
}

Property values

projects/pools

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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

PoolProperties

Name Description Value
devBoxDefinitionName Name of a Dev Box definition in parent Project of this 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'
networkConnectionName Name of a Network Connection in parent Project of this Pool string
stopOnDisconnect Stop on disconnect configuration settings for Dev Boxes created in this pool. StopOnDisconnectConfiguration

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'

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": "2023-01-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "devBoxDefinitionName": "string",
    "licenseType": "Windows_Client",
    "localAdministrator": "string",
    "networkConnectionName": "string",
    "stopOnDisconnect": {
      "gracePeriodMinutes": "int",
      "status": "string"
    }
  }
}

Property values

projects/pools

Name Description Value
type The resource type 'Microsoft.DevCenter/projects/pools'
apiVersion The resource api version '2023-01-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Pool properties PoolProperties

PoolProperties

Name Description Value
devBoxDefinitionName Name of a Dev Box definition in parent Project of this 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'
networkConnectionName Name of a Network Connection in parent Project of this Pool string
stopOnDisconnect Stop on disconnect configuration settings for Dev Boxes created in this pool. StopOnDisconnectConfiguration

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'

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@2023-01-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      devBoxDefinitionName = "string"
      licenseType = "Windows_Client"
      localAdministrator = "string"
      networkConnectionName = "string"
      stopOnDisconnect = {
        gracePeriodMinutes = int
        status = "string"
      }
    }
  })
}

Property values

projects/pools

Name Description Value
type The resource type "Microsoft.DevCenter/projects/pools@2023-01-01-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: projects
tags Resource tags. Dictionary of tag names and values.
properties Pool properties PoolProperties

PoolProperties

Name Description Value
devBoxDefinitionName Name of a Dev Box definition in parent Project of this 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"
networkConnectionName Name of a Network Connection in parent Project of this Pool string
stopOnDisconnect Stop on disconnect configuration settings for Dev Boxes created in this pool. StopOnDisconnectConfiguration

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"