Share via

Microsoft.DevCenter devcenters/devboxdefinitions 2023-08-01-preview

  • Article

Bicep resource definition

The devcenters/devboxdefinitions 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/devcenters/devboxdefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevCenter/devcenters/devboxdefinitions@2023-08-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    hibernateSupport: 'string'
    imageReference: {
      id: 'string'
    }
    osStorageType: 'string'
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
      size: 'string'
      tier: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

DevBoxDefinitionProperties

Name Description Value
hibernateSupport Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate 'Disabled'
'Enabled'
imageReference Image reference information. ImageReference
osStorageType The storage type used for the Operating System disk of Dev Boxes created using this definition. string
sku The SKU for Dev Boxes created using this definition. Sku

ImageReference

Name Description Value
id Image ID, or Image version ID. When Image ID is provided, its latest version will be used. string

Microsoft.DevCenter/devcenters/devboxdefinitions

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: devcenters
properties Dev Box definition properties DevBoxDefinitionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

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 devcenters/devboxdefinitions 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/devcenters/devboxdefinitions resource, add the following JSON to your template.

{
  "type": "Microsoft.DevCenter/devcenters/devboxdefinitions",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "hibernateSupport": "string",
    "imageReference": {
      "id": "string"
    },
    "osStorageType": "string",
    "sku": {
      "capacity": "int",
      "family": "string",
      "name": "string",
      "size": "string",
      "tier": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

DevBoxDefinitionProperties

Name Description Value
hibernateSupport Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate 'Disabled'
'Enabled'
imageReference Image reference information. ImageReference
osStorageType The storage type used for the Operating System disk of Dev Boxes created using this definition. string
sku The SKU for Dev Boxes created using this definition. Sku

ImageReference

Name Description Value
id Image ID, or Image version ID. When Image ID is provided, its latest version will be used. string

Microsoft.DevCenter/devcenters/devboxdefinitions

Name Description Value
apiVersion The api version '2023-08-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 Dev Box definition properties DevBoxDefinitionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevCenter/devcenters/devboxdefinitions'

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

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 devcenters/devboxdefinitions 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/devcenters/devboxdefinitions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevCenter/devcenters/devboxdefinitions@2023-08-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      hibernateSupport = "string"
      imageReference = {
        id = "string"
      }
      osStorageType = "string"
      sku = {
        capacity = int
        family = "string"
        name = "string"
        size = "string"
        tier = "string"
      }
    }
  })
}

Property values

DevBoxDefinitionProperties

Name Description Value
hibernateSupport Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate 'Disabled'
'Enabled'
imageReference Image reference information. ImageReference
osStorageType The storage type used for the Operating System disk of Dev Boxes created using this definition. string
sku The SKU for Dev Boxes created using this definition. Sku

ImageReference

Name Description Value
id Image ID, or Image version ID. When Image ID is provided, its latest version will be used. string

Microsoft.DevCenter/devcenters/devboxdefinitions

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: devcenters
properties Dev Box definition properties DevBoxDefinitionProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevCenter/devcenters/devboxdefinitions@2023-08-01-preview"

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value