Dev Boxes - Get Pool

Reference

Service:: Dev Center

API Version:: 2025-02-01

Gets a pool.

GET {endpoint}/projects/{projectName}/pools/{poolName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The DevCenter-specific URI to operate on.
poolName	path	True	string	Pool name. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$`
projectName	path	True	string	Name of the project. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$`
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Pool	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

Pool

The request has succeeded.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://devcenter.azure.com/.default

Examples

Gets a pool.

Sample request

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool?api-version=2025-02-01

Sample response

Status code:: 200

{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool",
  "name": "LargeDevWorkStationPool",
  "location": "centralus",
  "osType": "Windows",
  "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"
  },
  "stopOnDisconnect": {
    "status": "Enabled",
    "gracePeriodMinutes": 60
  },
  "stopOnNoConnect": {
    "status": "Enabled",
    "gracePeriodMinutes": 120
  },
  "healthStatus": "Healthy",
  "displayName": "LargePool"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
HardwareProfile	Hardware specifications for the Dev Box.
HibernateSupport	Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.
ImageReference	Specifies information about the image used.
LocalAdminStatus	Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.
OsDisk	Settings for the operating system disk.
OsType	The operating system type.
Pool	A pool of Dev Boxes.
PoolHealthStatus	Pool status indicating whether a pool is available to create Dev Boxes.
SkuName	Indicates the Dev Box compute.
StopOnDisconnectConfiguration	Stop on disconnect configuration settings for Dev Boxes created in this pool.
StopOnDisconnectEnableStatus	Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.
StopOnNoConnectConfiguration	Stop on no connect configuration settings for Dev Boxes created in this pool.
StopOnNoConnectEnableStatus	Stop on no connect enable or disable status.
StorageProfile	Storage settings for the Dev Box's disks.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

HardwareProfile

Object

Hardware specifications for the Dev Box.

Name	Type	Description
memoryGB	integer	The amount of memory available for the Dev Box.
skuName	SkuName	The name of the SKU.
vCPUs	integer	The number of vCPUs available for the Dev Box.

HibernateSupport

Enumeration

Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.

Value	Description
Disabled	Hibernate is not enabled.
Enabled	Hibernate is enabled.
OsUnsupported	Hibernate is not supported by the operating system.

ImageReference

Object

Specifies information about the image used.

Name	Type	Description
name	string	The name of the image used.
operatingSystem	string	The operating system of the image.
osBuildNumber	string	The operating system build number of the image.
publishedDate	string	The datetime that the backing image version was published, in RFC3339 format.
version	string	The version of the image.

LocalAdminStatus

Enumeration

Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.

Value	Description
Disabled	Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes.
Enabled	Owners of Dev Boxes in the pool are local administrators on the Dev Boxes.

OsDisk

Object

Settings for the operating system disk.

Name	Type	Description
diskSizeGB	integer	The size of the OS Disk in gigabytes.

OsType

Enumeration

The operating system type.

Value	Description
Windows	The Windows operating system.

Pool

Object

A pool of Dev Boxes.

Name	Type	Description
displayName	string	Display name of the pool.
hardwareProfile	HardwareProfile	Hardware settings for the Dev Boxes created in this pool.
healthStatus	PoolHealthStatus	Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
hibernateSupport	HibernateSupport	Indicates whether hibernate is enabled/disabled or unknown.
imageReference	ImageReference	Image settings for Dev Boxes create in this pool.
localAdministrator	LocalAdminStatus	Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes.
location	string	Azure region where Dev Boxes in the pool are located.
name	string	Pool name.
osType	OsType	The operating system type of Dev Boxes in this pool.
stopOnDisconnect	StopOnDisconnectConfiguration	Stop on disconnect configuration settings for Dev Boxes created in this pool.
stopOnNoConnect	StopOnNoConnectConfiguration	Stop on no connect configuration settings for Dev Boxes created in this pool.
storageProfile	StorageProfile	Storage settings for Dev Box created in this pool.
uri	string	The unique URI of the pool.

PoolHealthStatus

Enumeration

Pool status indicating whether a pool is available to create Dev Boxes.

Value	Description
Healthy	The pool health status is healthy.
Pending	The pool health status waiting for health checks to run.
Unhealthy	The pool health status is not healthy.
Unknown	The pool health status is not known.
Warning	The pool health status has one or more warnings.

SkuName

Enumeration

Indicates the Dev Box compute.

Value	Description
general_a_16c64gb1024ssd_v2	AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage.
general_a_16c64gb2048ssd_v2	AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage.
general_a_16c64gb256ssd_v2	AMD, 16 vCPU, 64 GB RAM, 256 GB Storage.
general_a_16c64gb512ssd_v2	AMD, 16 vCPU, 64 GB RAM, 512 GB Storage.
general_a_32c128gb1024ssd_v2	AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage.
general_a_32c128gb2048ssd_v2	AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage.
general_a_32c128gb512ssd_v2	AMD, 32 vCPU, 128 GB RAM, 512 GB Storage.
general_a_8c32gb1024ssd_v2	AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage.
general_a_8c32gb2048ssd_v2	AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage.
general_a_8c32gb256ssd_v2	AMD, 8 vCPU, 32 GB RAM, 256 GB Storage.
general_a_8c32gb512ssd_v2	AMD, 8 vCPU, 32 GB RAM, 512 GB Storage.
general_i_16c64gb1024ssd_v2	Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage.
general_i_16c64gb2048ssd_v2	Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage.
general_i_16c64gb256ssd_v2	Intel, 16 vCPU, 64 GB RAM, 256 GB Storage.
general_i_16c64gb512ssd_v2	Intel, 16 vCPU, 64 GB RAM, 512 GB Storage.
general_i_32c128gb1024ssd_v2	Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage.
general_i_32c128gb2048ssd_v2	Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage.
general_i_32c128gb512ssd_v2	Intel, 32 vCPU, 128 GB RAM, 512 GB Storage.
general_i_8c32gb1024ssd_v2	Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage.
general_i_8c32gb2048ssd_v2	Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage.
general_i_8c32gb256ssd_v2	Intel, 8 vCPU, 32 GB RAM, 256 GB Storage.
general_i_8c32gb512ssd_v2	Intel, 8 vCPU, 32 GB RAM, 512 GB Storage.

StopOnDisconnectConfiguration

Object

Stop on disconnect configuration settings for Dev Boxes created in this pool.

Name	Type	Description
gracePeriodMinutes	integer	The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
status	StopOnDisconnectEnableStatus	Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.

StopOnDisconnectEnableStatus

Enumeration

Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.

Value	Description
Disabled	Stop on disconnect is not enabled on the Dev Box.
Enabled	Stop on disconnect is enabled on the Dev Box.

StopOnNoConnectConfiguration

Object

Stop on no connect configuration settings for Dev Boxes created in this pool.

Name	Type	Description
gracePeriodMinutes	integer	The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled.
status	StopOnNoConnectEnableStatus	Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed.

StopOnNoConnectEnableStatus

Enumeration

Stop on no connect enable or disable status.

Value	Description
Disabled	Stop on no connect is not enabled on the Dev Box.
Enabled	Stop on no connect is enabled on the Dev Box.

StorageProfile

Object

Storage settings for the Dev Box's disks.

Name	Type	Description
osDisk	OsDisk	Settings for the operating system disk.

Share via

Dev Boxes - Get Pool

URI Parameters

Responses

Security

OAuth2Auth

Scopes

Examples

Gets a pool.

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

HardwareProfile

HibernateSupport

ImageReference

LocalAdminStatus

OsDisk

OsType

Pool

PoolHealthStatus

SkuName

StopOnDisconnectConfiguration

StopOnDisconnectEnableStatus

StopOnNoConnectConfiguration

StopOnNoConnectEnableStatus

StorageProfile

Additional resources