你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.DevCenter 项目/池

Bicep 资源定义

可以使用目标操作部署项目/池资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DevCenter/projects/pools 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DevCenter/projects/pools@2025-10-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    activeHoursConfiguration: {
      autoStartEnableStatus: 'string'
      daysOfWeekLimit: int
      defaultDaysOfWeek: [
        'string'
      ]
      defaultEndTimeHour: int
      defaultStartTimeHour: int
      defaultTimeZone: 'string'
      keepAwakeEnableStatus: 'string'
    }
    devBoxDefinition: {
      imageReference: {
        id: 'string'
      }
      sku: {
        capacity: int
        family: 'string'
        name: 'string'
        size: 'string'
        tier: 'string'
      }
    }
    devBoxDefinitionName: 'string'
    devBoxDefinitionType: 'string'
    devBoxTunnelEnableStatus: 'string'
    displayName: 'string'
    licenseType: 'string'
    localAdministrator: 'string'
    managedVirtualNetworkRegions: [
      'string'
    ]
    networkConnectionName: 'string'
    singleSignOnStatus: 'string'
    stopOnDisconnect: {
      gracePeriodMinutes: int
      status: 'string'
    }
    stopOnNoConnect: {
      gracePeriodMinutes: int
      status: 'string'
    }
    virtualNetworkType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.DevCenter/projects/pools

Name Description Value
位置 资源所在的地理位置 string (必需)
name 资源名称 string

Constraints:
最小长度 = 3
最大长度 = 63
模式 = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (必需)
父级 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:项目
properties 池属性 PoolProperties
tags 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ActiveHoursConfiguration

Name Description Value
autoStartEnableStatus 启用或禁用是否应在活动时间开始时自动启动 Dev Box。 'Disabled'
'Enabled'
周限制天数 用户每周可以启用使用时段相关功能的最大天数。 int
默认星期几 将启用使用时段功能的星期几。 这是每个用户都可以更新的默认值。 包含任一项的字符串数组:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
defaultEndTimeHour 活动小时数的默认结束时间。 int
defaultStartTimeHour 活动小时的默认开始时间。 int
defaultTimeZone 活动小时的默认 IANA 时区 ID。 字符串
keepAwakeEnableStatus 启用或禁用开发框是否应在活动时间内保持唤醒状态。 'Disabled'
'Enabled'

ImageReference

Name Description Value
id 映像 ID 或映像版本 ID。 提供映像 ID 时,将使用其最新版本。 字符串

PoolDevBoxDefinition

Name Description Value
imageReference 图像参考信息。 ImageReference
sku 从池创建的开发框的 SKU。 Sku

PoolProperties

Name Description Value
activeHoursConfiguration 在此池中创建的 Dev Box 的使用时段配置设置。 ActiveHoursConfiguration
devBoxDefinition 从此池创建的计算机的定义。 如果 devBoxDefinitionType 为 Reference 或未提供,则将被忽略。 PoolDevBoxDefinition
devBoxDefinitionName 此池的父项目中的 Dev Box 定义的名称。 如果 devBoxDefinitionType 为 Value,则将被忽略。 字符串
devBoxDefinitionType 指示池是从现有 Dev Box 定义创建的,还是直接提供池。 'Reference'
'Value'
devBoxTunnelEnableStatus 指示是否为池启用了 Dev Box Tunnel。 'Disabled'
'Enabled'
displayName 池的显示名称。 字符串
licenseType 指定指示调用方已获取要创建的开发框的许可证的许可证类型。 'Windows_Client'
localAdministrator 指示此池中的 Dev Box 所有者是否作为本地管理员添加到 Dev Box。 'Disabled'
'Enabled'
managedVirtualNetworkRegions 托管虚拟网络的区域(托管NetworkType 托管时需要)。 string[]
networkConnectionName 此池的父项目中的网络连接的名称。 字符串
singleSignOnStatus 指示是否使用此池中的 Dev Boxes 启用了单一登录。 还需要在租户上启用单一登录。 'Disabled'
'Enabled'
stopOnDisconnect 停止在此池中创建的开发框的连接配置设置。 StopOnDisconnectConfiguration
stopOnNoConnect 停止在此池中创建的开发框没有连接配置设置。 StopOnNoConnectConfiguration
virtualNetworkType 指示池是使用由Microsoft管理的虚拟网络还是客户提供的网络。 'Managed'
'Unmanaged'

Sku

Name Description Value
产能 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略此范围。 int
family 如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。 字符串
name SKU 的名称。 例如 P3。 它通常是字母+数字代码 string (必需)
size SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。 字符串
分层 如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。 'Basic'
'Free'
'Premium'
'Standard'

StopOnDisconnectConfiguration

Name Description Value
gracePeriodMinutes 检测到断开连接后,在停止 Dev Box 之前等待的指定时间(以分钟为单位)。 int
状态 启用宽限期后,是否在断开连接时停止 Dev Box 的功能。 'Disabled'
'Enabled'

StopOnNoConnectConfiguration

Name Description Value
gracePeriodMinutes 在未建立连接的情况下停止 Dev Box 之前等待的指定时间(以分钟为单位)。 int
状态 使该功能能够在未连接到开发框时停止启动的 Dev Box,一旦宽限期失效。 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

用法示例

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

Bicep 文件 Description
配置 Dev Box 服务 此模板将按照 Dev Box 快速入门指南(/azure/dev-box/quickstart-create-dev-box)创建所有 Dev Box 管理员资源。 可以查看创建的所有资源,也可以直接转到 DevPortal.microsoft.com 创建第一个 Dev Box。
部署 Dev Box 服务 此模板提供了一种配置创建 Dev Box 所需的所有资源的方法。
使用内置映像 部署 Dev Box Service 此模板提供了使用内置映像部署 Dev Box 服务的方法。

ARM 模板资源定义

可以使用目标操作部署项目/池资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DevCenter/projects/pools 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DevCenter/projects/pools",
  "apiVersion": "2025-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "activeHoursConfiguration": {
      "autoStartEnableStatus": "string",
      "daysOfWeekLimit": "int",
      "defaultDaysOfWeek": [ "string" ],
      "defaultEndTimeHour": "int",
      "defaultStartTimeHour": "int",
      "defaultTimeZone": "string",
      "keepAwakeEnableStatus": "string"
    },
    "devBoxDefinition": {
      "imageReference": {
        "id": "string"
      },
      "sku": {
        "capacity": "int",
        "family": "string",
        "name": "string",
        "size": "string",
        "tier": "string"
      }
    },
    "devBoxDefinitionName": "string",
    "devBoxDefinitionType": "string",
    "devBoxTunnelEnableStatus": "string",
    "displayName": "string",
    "licenseType": "string",
    "localAdministrator": "string",
    "managedVirtualNetworkRegions": [ "string" ],
    "networkConnectionName": "string",
    "singleSignOnStatus": "string",
    "stopOnDisconnect": {
      "gracePeriodMinutes": "int",
      "status": "string"
    },
    "stopOnNoConnect": {
      "gracePeriodMinutes": "int",
      "status": "string"
    },
    "virtualNetworkType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.DevCenter/projects/pools

Name Description Value
apiVersion API 版本 “2025-10-01-预览”
位置 资源所在的地理位置 string (必需)
name 资源名称 string

Constraints:
最小长度 = 3
最大长度 = 63
模式 = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (必需)
properties 池属性 PoolProperties
tags 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 'Microsoft.DevCenter/projects/pools'

ActiveHoursConfiguration

Name Description Value
autoStartEnableStatus 启用或禁用是否应在活动时间开始时自动启动 Dev Box。 'Disabled'
'Enabled'
周限制天数 用户每周可以启用使用时段相关功能的最大天数。 int
默认星期几 将启用使用时段功能的星期几。 这是每个用户都可以更新的默认值。 包含任一项的字符串数组:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
defaultEndTimeHour 活动小时数的默认结束时间。 int
defaultStartTimeHour 活动小时的默认开始时间。 int
defaultTimeZone 活动小时的默认 IANA 时区 ID。 字符串
keepAwakeEnableStatus 启用或禁用开发框是否应在活动时间内保持唤醒状态。 'Disabled'
'Enabled'

ImageReference

Name Description Value
id 映像 ID 或映像版本 ID。 提供映像 ID 时,将使用其最新版本。 字符串

PoolDevBoxDefinition

Name Description Value
imageReference 图像参考信息。 ImageReference
sku 从池创建的开发框的 SKU。 Sku

PoolProperties

Name Description Value
activeHoursConfiguration 在此池中创建的 Dev Box 的使用时段配置设置。 ActiveHoursConfiguration
devBoxDefinition 从此池创建的计算机的定义。 如果 devBoxDefinitionType 为 Reference 或未提供,则将被忽略。 PoolDevBoxDefinition
devBoxDefinitionName 此池的父项目中的 Dev Box 定义的名称。 如果 devBoxDefinitionType 为 Value,则将被忽略。 字符串
devBoxDefinitionType 指示池是从现有 Dev Box 定义创建的,还是直接提供池。 'Reference'
'Value'
devBoxTunnelEnableStatus 指示是否为池启用了 Dev Box Tunnel。 'Disabled'
'Enabled'
displayName 池的显示名称。 字符串
licenseType 指定指示调用方已获取要创建的开发框的许可证的许可证类型。 'Windows_Client'
localAdministrator 指示此池中的 Dev Box 所有者是否作为本地管理员添加到 Dev Box。 'Disabled'
'Enabled'
managedVirtualNetworkRegions 托管虚拟网络的区域(托管NetworkType 托管时需要)。 string[]
networkConnectionName 此池的父项目中的网络连接的名称。 字符串
singleSignOnStatus 指示是否使用此池中的 Dev Boxes 启用了单一登录。 还需要在租户上启用单一登录。 'Disabled'
'Enabled'
stopOnDisconnect 停止在此池中创建的开发框的连接配置设置。 StopOnDisconnectConfiguration
stopOnNoConnect 停止在此池中创建的开发框没有连接配置设置。 StopOnNoConnectConfiguration
virtualNetworkType 指示池是使用由Microsoft管理的虚拟网络还是客户提供的网络。 'Managed'
'Unmanaged'

Sku

Name Description Value
产能 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略此范围。 int
family 如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。 字符串
name SKU 的名称。 例如 P3。 它通常是字母+数字代码 string (必需)
size SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。 字符串
分层 如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。 'Basic'
'Free'
'Premium'
'Standard'

StopOnDisconnectConfiguration

Name Description Value
gracePeriodMinutes 检测到断开连接后,在停止 Dev Box 之前等待的指定时间(以分钟为单位)。 int
状态 启用宽限期后,是否在断开连接时停止 Dev Box 的功能。 'Disabled'
'Enabled'

StopOnNoConnectConfiguration

Name Description Value
gracePeriodMinutes 在未建立连接的情况下停止 Dev Box 之前等待的指定时间(以分钟为单位)。 int
状态 使该功能能够在未连接到开发框时停止启动的 Dev Box,一旦宽限期失效。 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

Template Description
配置 Dev Box 服务

部署到 Azure
此模板将按照 Dev Box 快速入门指南(/azure/dev-box/quickstart-create-dev-box)创建所有 Dev Box 管理员资源。 可以查看创建的所有资源,也可以直接转到 DevPortal.microsoft.com 创建第一个 Dev Box。
部署 Dev Box 服务

部署到 Azure
此模板提供了一种配置创建 Dev Box 所需的所有资源的方法。
使用内置映像 部署 Dev Box Service

部署到 Azure
此模板提供了使用内置映像部署 Dev Box 服务的方法。

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署项目/池资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DevCenter/projects/pools 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevCenter/projects/pools@2025-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      activeHoursConfiguration = {
        autoStartEnableStatus = "string"
        daysOfWeekLimit = int
        defaultDaysOfWeek = [
          "string"
        ]
        defaultEndTimeHour = int
        defaultStartTimeHour = int
        defaultTimeZone = "string"
        keepAwakeEnableStatus = "string"
      }
      devBoxDefinition = {
        imageReference = {
          id = "string"
        }
        sku = {
          capacity = int
          family = "string"
          name = "string"
          size = "string"
          tier = "string"
        }
      }
      devBoxDefinitionName = "string"
      devBoxDefinitionType = "string"
      devBoxTunnelEnableStatus = "string"
      displayName = "string"
      licenseType = "string"
      localAdministrator = "string"
      managedVirtualNetworkRegions = [
        "string"
      ]
      networkConnectionName = "string"
      singleSignOnStatus = "string"
      stopOnDisconnect = {
        gracePeriodMinutes = int
        status = "string"
      }
      stopOnNoConnect = {
        gracePeriodMinutes = int
        status = "string"
      }
      virtualNetworkType = "string"
    }
  }
}

属性值

Microsoft.DevCenter/projects/pools

Name Description Value
位置 资源所在的地理位置 string (必需)
name 资源名称 string

Constraints:
最小长度 = 3
最大长度 = 63
模式 = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:项目
properties 池属性 PoolProperties
tags 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DevCenter/projects/pools@2025-10-01-preview”

ActiveHoursConfiguration

Name Description Value
autoStartEnableStatus 启用或禁用是否应在活动时间开始时自动启动 Dev Box。 'Disabled'
'Enabled'
周限制天数 用户每周可以启用使用时段相关功能的最大天数。 int
默认星期几 将启用使用时段功能的星期几。 这是每个用户都可以更新的默认值。 包含任一项的字符串数组:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
defaultEndTimeHour 活动小时数的默认结束时间。 int
defaultStartTimeHour 活动小时的默认开始时间。 int
defaultTimeZone 活动小时的默认 IANA 时区 ID。 字符串
keepAwakeEnableStatus 启用或禁用开发框是否应在活动时间内保持唤醒状态。 'Disabled'
'Enabled'

ImageReference

Name Description Value
id 映像 ID 或映像版本 ID。 提供映像 ID 时,将使用其最新版本。 字符串

PoolDevBoxDefinition

Name Description Value
imageReference 图像参考信息。 ImageReference
sku 从池创建的开发框的 SKU。 Sku

PoolProperties

Name Description Value
activeHoursConfiguration 在此池中创建的 Dev Box 的使用时段配置设置。 ActiveHoursConfiguration
devBoxDefinition 从此池创建的计算机的定义。 如果 devBoxDefinitionType 为 Reference 或未提供,则将被忽略。 PoolDevBoxDefinition
devBoxDefinitionName 此池的父项目中的 Dev Box 定义的名称。 如果 devBoxDefinitionType 为 Value,则将被忽略。 字符串
devBoxDefinitionType 指示池是从现有 Dev Box 定义创建的,还是直接提供池。 'Reference'
'Value'
devBoxTunnelEnableStatus 指示是否为池启用了 Dev Box Tunnel。 'Disabled'
'Enabled'
displayName 池的显示名称。 字符串
licenseType 指定指示调用方已获取要创建的开发框的许可证的许可证类型。 'Windows_Client'
localAdministrator 指示此池中的 Dev Box 所有者是否作为本地管理员添加到 Dev Box。 'Disabled'
'Enabled'
managedVirtualNetworkRegions 托管虚拟网络的区域(托管NetworkType 托管时需要)。 string[]
networkConnectionName 此池的父项目中的网络连接的名称。 字符串
singleSignOnStatus 指示是否使用此池中的 Dev Boxes 启用了单一登录。 还需要在租户上启用单一登录。 'Disabled'
'Enabled'
stopOnDisconnect 停止在此池中创建的开发框的连接配置设置。 StopOnDisconnectConfiguration
stopOnNoConnect 停止在此池中创建的开发框没有连接配置设置。 StopOnNoConnectConfiguration
virtualNetworkType 指示池是使用由Microsoft管理的虚拟网络还是客户提供的网络。 'Managed'
'Unmanaged'

Sku

Name Description Value
产能 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略此范围。 int
family 如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。 字符串
name SKU 的名称。 例如 P3。 它通常是字母+数字代码 string (必需)
size SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。 字符串
分层 如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。 'Basic'
'Free'
'Premium'
'Standard'

StopOnDisconnectConfiguration

Name Description Value
gracePeriodMinutes 检测到断开连接后,在停止 Dev Box 之前等待的指定时间(以分钟为单位)。 int
状态 启用宽限期后,是否在断开连接时停止 Dev Box 的功能。 'Disabled'
'Enabled'

StopOnNoConnectConfiguration

Name Description Value
gracePeriodMinutes 在未建立连接的情况下停止 Dev Box 之前等待的指定时间(以分钟为单位)。 int
状态 使该功能能够在未连接到开发框时停止启动的 Dev Box,一旦宽限期失效。 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value