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

Pools - List By Project

项目的Lists池

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

URI 参数

名称 必需 类型 说明
projectName
path True

string

项目的名称。

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

resourceGroupName
path True

string

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

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

$top
query

integer

int32

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

响应

名称 类型 说明
200 OK

PoolListResult

没问题。 请求已成功。

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Pools_ListByProject

示例请求

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

示例响应

{
  "value": [
    {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool",
      "name": "DevPool",
      "type": "Microsoft.DevCenter/pools",
      "properties": {
        "displayName": "Developer Pool",
        "devBoxDefinitionName": "WebDevBox",
        "networkConnectionName": "Network1-westus2",
        "licenseType": "Windows_Client",
        "localAdministrator": "Enabled",
        "stopOnDisconnect": {
          "status": "Enabled",
          "gracePeriodMinutes": 60
        },
        "healthStatus": "Healthy",
        "devBoxCount": 1,
        "provisioningState": "Succeeded",
        "singleSignOnStatus": "Disabled",
        "virtualNetworkType": "Managed",
        "managedVirtualNetworkRegions": [
          "centralus"
        ]
      },
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-11-18T18:00:36.993Z",
        "lastModifiedBy": "user1",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-11-18T18:30:36.993Z"
      },
      "location": "centralus"
    }
  ]
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

HealthStatus

指示池是否可用于创建 Dev Boxes 的运行状况状态。

HealthStatusDetail

池运行状况详细信息。

LicenseType

许可证类型

LocalAdminStatus

本地管理员启用或禁用状态。 指示是否将 Dev Box 的所有者添加为 Dev Box 上的本地管理员。

Pool

虚拟机池。

PoolListResult

计算机池列表操作的结果。

ProvisioningState

资源的预配状态。

SingleSignOnStatus

SingleSignOn (SSO) 启用或禁用状态。 指示池中的 Dev Boxes 是启用还是禁用 SSO。

StopOnDisconnectConfiguration

在此池中创建的 Dev Boxes 断开连接配置设置时停止。

StopOnDisconnectEnableStatus

断开连接时停止启用或禁用状态。 指示在断开连接时停止是启用还是禁用。

systemData

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

VirtualNetworkType

指示池使用由 Microsoft (托管) 管理的虚拟网络,或客户提供的网络 (非托管) 。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

HealthStatus

指示池是否可用于创建 Dev Boxes 的运行状况状态。

名称 类型 说明
Healthy

string

Pending

string

Unhealthy

string

Unknown

string

Warning

string

HealthStatusDetail

池运行状况详细信息。

名称 类型 说明
code

string

问题的标识符。

message

string

描述问题的消息,旨在适合在用户界面中显示

LicenseType

许可证类型

名称 类型 说明
Windows_Client

string

LocalAdminStatus

本地管理员启用或禁用状态。 指示是否将 Dev Box 的所有者添加为 Dev Box 上的本地管理员。

名称 类型 说明
Disabled

string

Enabled

string

Pool

虚拟机池。

名称 类型 说明
id

string

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

location

string

资源所在的地理位置

name

string

资源的名称

properties.devBoxCount

integer

指示此池中预配的开发箱数。

properties.devBoxDefinitionName

string

此池的父项目中 Dev Box 定义的名称

properties.displayName

string

池的显示名称。

properties.healthStatus

HealthStatus

池的总体运行状况。 指示池是否可用于创建开发箱。

properties.healthStatusDetails

HealthStatusDetail[]

有关池运行状况的详细信息,以帮助诊断问题。 仅当池状态指示池处于非正常状态时,才会填充此状态

properties.licenseType

LicenseType

指定许可证类型,指示调用方已获取将要创建的 Dev Boxes 的许可证。

properties.localAdministrator

LocalAdminStatus

指示是否将此池中的 Dev Box 所有者添加为 Dev Box 上的本地管理员。

properties.managedVirtualNetworkRegions

string[]

当 managedNetworkType 为 Managed) 时, (托管虚拟网络的区域。

properties.networkConnectionName

string

此池的父项目中的网络连接的名称

properties.provisioningState

ProvisioningState

资源的预配状态。

properties.singleSignOnStatus

SingleSignOnStatus

指示此池中的 Dev Boxes 是否是在启用单一登录的情况下创建的。 还要求在租户上启用单一登录。

properties.stopOnDisconnect

StopOnDisconnectConfiguration

在此池中创建的 Dev Boxes 断开连接配置设置时停止。

properties.virtualNetworkType

VirtualNetworkType

指示池是使用 Microsoft 管理的虚拟网络还是客户提供的网络。

systemData

systemData

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

tags

object

资源标记。

type

string

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

PoolListResult

计算机池列表操作的结果。

名称 类型 说明
nextLink

string

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

value

Pool[]

结果的当前页。

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

SingleSignOnStatus

SingleSignOn (SSO) 启用或禁用状态。 指示池中的 Dev Boxes 是启用还是禁用 SSO。

名称 类型 说明
Disabled

string

Enabled

string

StopOnDisconnectConfiguration

在此池中创建的 Dev Boxes 断开连接配置设置时停止。

名称 类型 说明
gracePeriodMinutes

integer

检测到断开连接后停止 Dev Box 之前等待的指定时间(以分钟为单位)。

status

StopOnDisconnectEnableStatus

是否启用在宽限期过后断开连接时停止开发箱的功能。

StopOnDisconnectEnableStatus

断开连接时停止启用或禁用状态。 指示在断开连接时停止是启用还是禁用。

名称 类型 说明
Disabled

string

Enabled

string

systemData

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

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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

VirtualNetworkType

指示池使用由 Microsoft (托管) 管理的虚拟网络,或客户提供的网络 (非托管) 。

名称 类型 说明
Managed

string

Unmanaged

string