Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The projects/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.DevCenter/projects/pools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DevCenter/projects/pools@2022-09-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
devBoxDefinitionName: 'string'
licenseType: 'string'
localAdministrator: 'string'
networkConnectionName: '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 (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 |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying 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 | This template provides a way to configure all resouces required to create a 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:
- 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.DevCenter/projects/pools resource, add the following JSON to your template.
{
"type": "Microsoft.DevCenter/projects/pools",
"apiVersion": "2022-09-01-preview",
"name": "string",
"location": "string",
"properties": {
"devBoxDefinitionName": "string",
"licenseType": "string",
"localAdministrator": "string",
"networkConnectionName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DevCenter/projects/pools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-09-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (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 |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | 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 |
This template provides a way to configure all resouces required to create a 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. |
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@2022-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
devBoxDefinitionName = "string"
licenseType = "string"
localAdministrator = "string"
networkConnectionName = "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 (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@2022-09-01-preview" |
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 |
TrackedResourceTags
| Name | Description | Value |
|---|