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

Dev Boxes - Create Dev Box

创建或替换 Dev Box。

PUT {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}?api-version=2024-02-01

URI 参数

名称 必需 类型 说明
devBoxName
path True

string

Dev Box 的名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

endpoint
path True

string

uri

要在其上运行的特定于 DevCenter 的 URI。

projectName
path True

string

要对其执行操作的 DevCenter 项目。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

userId
path True

string

用户的 AAD 对象 ID。 如果值为“me”,则标识取自身份验证上下文。

正则表达式模式: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
poolName True

string

此计算机所属的 Dev Box 池的名称。

localAdministrator

LocalAdminStatus

指示 Dev Box 的所有者是否为本地管理员。

响应

名称 类型 说明
200 OK

DevBox

请求已成功。

201 Created

DevBox

请求已成功,因此创建了一个新资源。

标头

  • Location: string
  • Operation-Location: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://devcenter.azure.com/.default

示例

Creates or replaces a Dev Box.

示例请求

PUT https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/devboxes/MyDevBox?api-version=2024-02-01

{
  "poolName": "LargeDevWorkStationPool"
}

示例响应

{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox",
  "name": "MyDevBox",
  "provisioningState": "Succeeded",
  "projectName": "ContosoProject",
  "poolName": "LargeDevWorkStationPool",
  "location": "centralus",
  "osType": "Windows",
  "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98",
  "hardwareProfile": {
    "vCPUs": 8,
    "memoryGB": 32
  },
  "storageProfile": {
    "osDisk": {
      "diskSizeGB": 1024
    }
  },
  "hibernateSupport": "Enabled",
  "imageReference": {
    "name": "DevImage",
    "version": "1.0.0",
    "publishedDate": "2022-03-01T00:13:23.323Z"
  }
}
Location: https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0
Operation-Location: https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0
{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox",
  "name": "MyDevBox",
  "provisioningState": "Creating",
  "projectName": "ContosoProject",
  "poolName": "LargeDevWorkStationPool",
  "location": "centralus",
  "osType": "Windows",
  "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98",
  "hardwareProfile": {
    "vCPUs": 8,
    "memoryGB": 32
  },
  "storageProfile": {
    "osDisk": {
      "diskSizeGB": 1024
    }
  },
  "hibernateSupport": "Enabled",
  "imageReference": {
    "name": "DevImage",
    "version": "1.0.0",
    "publishedDate": "2022-03-01T00:13:23.323Z"
  }
}

定义

名称 说明
Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

DevBox

开发盒。

DevBoxProvisioningState

指示 Dev Box 的预配状态。

HardwareProfile

开发盒的硬件规格。

HibernateSupport

指示操作系统是否支持和启用、禁用或不支持休眠。 未知休眠支持表示为 null。

ImageReference

指定有关所用图像的信息。

LocalAdminStatus

指示池中 Dev Boxes 的所有者是否是 Dev Boxes 的本地管理员。

OsDisk

操作系统磁盘的设置。

OsType

操作系统类型。

PowerState

Dev Box 的电源状态。

SkuName

指示 Dev Box 计算。

StorageProfile

Dev Box 磁盘的存储设置。

Azure.Core.Foundations.Error

错误对象。

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

details

Azure.Core.Foundations.Error[]

有关导致此项报告错误的特定错误的详细信息数组。

innererror

Azure.Core.Foundations.InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

target

string

错误的目标。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

名称 类型 说明
error

Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

innererror

Azure.Core.Foundations.InnerError

内部错误。

DevBox

开发盒。

名称 类型 说明
actionState

string

Dev Box 的当前操作状态。 这是基于用户先前执行的操作的状态。

createdTime

string

此 Dev Box 的创建时间。

error

Azure.Core.Foundations.Error

预配或操作错误详细信息。 仅针对错误状态填充。

hardwareProfile

HardwareProfile

有关 Dev Box 硬件资源的信息。

hibernateSupport

HibernateSupport

指示休眠是启用/禁用还是未知。

imageReference

ImageReference

有关用于此 Dev Box 的图像的信息。

localAdministrator

LocalAdminStatus

指示 Dev Box 的所有者是否为本地管理员。

location

string

此 Dev Box 所在的 Azure 区域。 这将与它所附加到虚拟网络是同一区域。

name

string

开发框的显示名称。

osType

OsType

此 Dev Box 的操作系统类型。

poolName

string

此计算机所属的 Dev Box 池的名称。

powerState

PowerState

Dev Box 的当前电源状态。

projectName

string

此 Dev Box 所属的项目的名称。

provisioningState

DevBoxProvisioningState

Dev Box 的当前预配状态。

storageProfile

StorageProfile

此 Dev Box 的存储设置。

uniqueId

string

开发框的唯一标识符。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。

uri

string

开发框的唯一 URI。

user

string

此 Dev Box 分配到的用户的 AAD 对象 ID。

DevBoxProvisioningState

指示 Dev Box 的预配状态。

名称 类型 说明
Canceled

string

已取消 Dev Box 预配。

Creating

string

正在开发开发框。

Deleting

string

正在删除 Dev Box。

Failed

string

Dev Box 无法预配。

InGracePeriod

string

Dev Box 处于宽限期。

NotProvisioned

string

未预配 Dev Box。

ProvisionedWithWarning

string

已预配 Dev Box 警告。

Provisioning

string

Dev Box 正在预配中。

Starting

string

Dev Box 正在启动。

Stopping

string

Dev Box 正在停止。

Succeeded

string

已成功预配 Dev Box。

Updating

string

Dev Box 正在更新。

HardwareProfile

开发盒的硬件规格。

名称 类型 说明
memoryGB

integer

开发箱的可用内存量。

skuName

SkuName

SKU 的名称。

vCPUs

integer

可用于 Dev Box 的 vCPU 数。

HibernateSupport

指示操作系统是否支持和启用、禁用或不支持休眠。 未知休眠支持表示为 null。

名称 类型 说明
Disabled

string

未启用休眠。

Enabled

string

已启用休眠。

OsUnsupported

string

操作系统不支持休眠。

ImageReference

指定有关所用图像的信息。

名称 类型 说明
name

string

所用映像的名称。

operatingSystem

string

映像的操作系统。

osBuildNumber

string

映像的操作系统内部版本号。

publishedDate

string

发布支持映像版本的日期时间。

version

string

映像的版本。

LocalAdminStatus

指示池中 Dev Boxes 的所有者是否是 Dev Boxes 的本地管理员。

名称 类型 说明
Disabled

string

池中 Dev Boxes 的所有者不是 Dev Boxes 的本地管理员。

Enabled

string

池中 Dev Boxes 的所有者是 Dev Boxes 的本地管理员。

OsDisk

操作系统磁盘的设置。

名称 类型 说明
diskSizeGB

integer

OS 磁盘的大小(以 GB 为单位)。

OsType

操作系统类型。

名称 类型 说明
Windows

string

Windows 操作系统。

PowerState

Dev Box 的电源状态。

名称 类型 说明
Deallocated

string

开发箱已解除分配。

Hibernated

string

开发箱处于休眠状态。

PoweredOff

string

Dev Box 已关闭。

Running

string

开发箱正在运行。

Unknown

string

Dev Box 电源状态未知。

SkuName

指示 Dev Box 计算。

名称 类型 说明
general_a_16c64gb1024ssd_v2

string

AMD,16 vCPU,64 GB RAM,1024 GB 存储。

general_a_16c64gb2048ssd_v2

string

AMD,16 vCPU,64 GB RAM,2048 GB 存储。

general_a_16c64gb256ssd_v2

string

AMD,16 vCPU,64 GB RAM,256 GB 存储。

general_a_16c64gb512ssd_v2

string

AMD,16 vCPU,64 GB RAM,512 GB 存储。

general_a_32c128gb1024ssd_v2

string

AMD,32 vCPU,128 GB RAM,1024 GB 存储。

general_a_32c128gb2048ssd_v2

string

AMD,32 vCPU,128 GB RAM,2048 GB 存储。

general_a_32c128gb512ssd_v2

string

AMD,32 vCPU,128 GB RAM,512 GB 存储。

general_a_8c32gb1024ssd_v2

string

AMD,8 vCPU,32 GB RAM,1024 GB 存储。

general_a_8c32gb2048ssd_v2

string

AMD,8 vCPU,32 GB RAM,2048 GB 存储。

general_a_8c32gb256ssd_v2

string

AMD,8 vCPU,32 GB RAM,256 GB 存储。

general_a_8c32gb512ssd_v2

string

AMD,8 vCPU,32 GB RAM,512 GB 存储。

general_i_16c64gb1024ssd_v2

string

Intel,16 vCPU,64 GB RAM,1024 GB 存储。

general_i_16c64gb2048ssd_v2

string

Intel,16 vCPU,64 GB RAM,2048 GB 存储。

general_i_16c64gb256ssd_v2

string

Intel,16 vCPU,64 GB RAM,256 GB 存储。

general_i_16c64gb512ssd_v2

string

Intel,16 vCPU,64 GB RAM,512 GB 存储。

general_i_32c128gb1024ssd_v2

string

Intel,32 vCPU,128 GB RAM,1024 GB 存储。

general_i_32c128gb2048ssd_v2

string

Intel,32 vCPU,128 GB RAM,2048 GB 存储。

general_i_32c128gb512ssd_v2

string

Intel,32 vCPU,128 GB RAM,512 GB 存储。

general_i_8c32gb1024ssd_v2

string

Intel,8 vCPU,32 GB RAM,1024 GB 存储。

general_i_8c32gb2048ssd_v2

string

Intel,8 vCPU,32 GB RAM,2048 GB 存储。

general_i_8c32gb256ssd_v2

string

Intel,8 vCPU,32 GB RAM,256 GB 存储。

general_i_8c32gb512ssd_v2

string

Intel,8 vCPU,32 GB RAM,512 GB 存储。

StorageProfile

Dev Box 磁盘的存储设置。

名称 类型 说明
osDisk

OsDisk

操作系统磁盘的设置。