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

Dev Box Definitions - List By Dev Center

列出开发中心的 Dev Box 定义。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions?api-version=2024-02-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions?api-version=2024-02-01&$top={$top}

URI 参数

名称 必需 类型 说明
devCenterName
path True

string

开发中心的名称。

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

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

$top
query

integer

int32

要从操作返回的最大资源数。 示例:“$top=10”。

响应

名称 类型 说明
200 OK

DevBoxDefinitionListResult

没问题。 请求已成功。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

DevBoxDefinitions_ListByDevCenter

示例请求

GET https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions?api-version=2024-02-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox",
      "name": "WebDevBox",
      "type": "Microsoft.DevCenter/devcenters/devboxdefinitions",
      "properties": {
        "imageReference": {
          "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"
        },
        "sku": {
          "name": "Preview"
        },
        "hibernateSupport": "Enabled",
        "provisioningState": "Succeeded"
      },
      "location": "centralus",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-11-18T18:00:36.993Z",
        "lastModifiedBy": "user1",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-11-18T18:30:36.993Z"
      }
    }
  ]
}

定义

名称 说明
CatalogResourceValidationStatus

目录资源验证状态

createdByType

创建资源的标识类型。

DevBoxDefinition

表示开发人员计算机的定义。

DevBoxDefinitionListResult

Dev Box 定义列表操作的结果。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

HibernateSupport

指示是否启用/禁用休眠。

ImageReference

图像参考信息

ImageValidationErrorDetails

图像验证错误详细信息

ImageValidationStatus

映像验证状态

ProvisioningState

资源的预配状态。

Sku

表示 SKU 的资源模型定义

SkuTier

如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。

systemData

与资源的创建和上次修改相关的元数据。

CatalogResourceValidationStatus

目录资源验证状态

名称 类型 说明
Failed

string

Pending

string

Succeeded

string

Unknown

string

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DevBoxDefinition

表示开发人员计算机的定义。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

location

string

资源所在的地理位置

name

string

资源的名称

properties.activeImageReference

ImageReference

当前活动映像的图像参考信息 (仅在更新) 期间填充。

properties.hibernateSupport

HibernateSupport

指示使用此定义创建的 Dev Boxes 是否能够进入休眠状态。 并非所有映像都能够支持休眠。 若要了解详细信息,请参阅 https://aka.ms/devbox/hibernate

properties.imageReference

ImageReference

图像参考信息。

properties.imageValidationErrorDetails

ImageValidationErrorDetails

图像验证程序错误的详细信息。 图像验证不成功时填充。

properties.imageValidationStatus

ImageValidationStatus

已配置映像的验证状态。

properties.osStorageType

string

用于使用此定义创建的 Dev Boxes 的操作系统磁盘的存储类型。

properties.provisioningState

ProvisioningState

资源的预配状态。

properties.sku

Sku

使用此定义创建的 Dev Boxes 的 SKU。

properties.validationStatus

CatalogResourceValidationStatus

Dev Box 定义的验证状态。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DevBoxDefinitionListResult

Dev Box 定义列表操作的结果。

名称 类型 说明
nextLink

string

用于获取下一组结果的 URL(如果有)。

value

DevBoxDefinition[]

结果的当前页。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

HibernateSupport

指示是否启用/禁用休眠。

名称 类型 说明
Disabled

string

Enabled

string

ImageReference

图像参考信息

名称 类型 说明
exactVersion

string

使用后映像的实际版本。 当 id 引用库映像最新版本时,这表示正在使用的实际版本。

id

string

映像 ID 或映像版本 ID。 提供映像 ID 时,将使用其最新版本。

ImageValidationErrorDetails

图像验证错误详细信息

名称 类型 说明
code

string

错误的标识符。

message

string

描述错误的消息。

ImageValidationStatus

映像验证状态

名称 类型 说明
Failed

string

Pending

string

Succeeded

string

TimedOut

string

Unknown

string

ProvisioningState

资源的预配状态。

名称 类型 说明
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

MovingResources

string

NotSpecified

string

RolloutInProgress

string

Running

string

StorageProvisioningFailed

string

Succeeded

string

TransientFailure

string

Updated

string

Updating

string

Sku

表示 SKU 的资源模型定义

名称 类型 说明
capacity

integer

如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果无法对资源进行横向扩展/缩减,则可能会省略此项。

family

string

如果服务针对同一 SKU 具有不同代系的硬件,则可以在此处捕获。

name

string

SKU 的名称。 例如 P3。 它通常是字母+数字代码

size

string

SKU 大小。 当名称字段是层和一些其他值的组合时,这将是独立代码。

tier

SkuTier

如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。

SkuTier

如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。

名称 类型 说明
Basic

string

Free

string

Premium

string

Standard

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。