pools

Creates, updates, deletes, gets or lists a pools resource.

Overview

Name	pools
Type	Resource
Id	azure.developer_devcenter.pools

Fields

The following fields are returned by SELECT queries:

get_pool

Name	Datatype	Description
name	string	Pool name. Required.
hardwareProfile	object	Hardware settings for the Dev Boxes created in this pool.
healthStatus	string	Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. Required. Known values are: "Unknown", "Pending", "Healthy", "Warning", and "Unhealthy". (Unknown, Pending, Healthy, Warning, Unhealthy)
hibernateSupport	string	Indicates whether hibernate is enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and "OsUnsupported". (Enabled, Disabled, OsUnsupported)
imageReference	object	Image settings for Dev Boxes create in this pool.
localAdministrator	string	Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	Azure region where Dev Boxes in the pool are located. Required.
osType	string	The operating system type of Dev Boxes in this pool. "Windows" (Windows)
stopOnDisconnect	object	Stop on disconnect configuration settings for Dev Boxes created in this pool.
storageProfile	object	Storage settings for Dev Box created in this pool.

list_pools

Name	Datatype	Description
name	string	Pool name. Required.
hardwareProfile	object	Hardware settings for the Dev Boxes created in this pool.
healthStatus	string	Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. Required. Known values are: "Unknown", "Pending", "Healthy", "Warning", and "Unhealthy". (Unknown, Pending, Healthy, Warning, Unhealthy)
hibernateSupport	string	Indicates whether hibernate is enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and "OsUnsupported". (Enabled, Disabled, OsUnsupported)
imageReference	object	Image settings for Dev Boxes create in this pool.
localAdministrator	string	Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	Azure region where Dev Boxes in the pool are located. Required.
osType	string	The operating system type of Dev Boxes in this pool. "Windows" (Windows)
stopOnDisconnect	object	Stop on disconnect configuration settings for Dev Boxes created in this pool.
storageProfile	object	Storage settings for Dev Box created in this pool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pool	select	project_name, pool_name, endpoint		Gets a pool.
list_pools	select	project_name, endpoint		Lists available pools.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
pool_name	string	Pool name. Required.
project_name	string	Name of the project. Required.

SELECT examples

get_pool

Gets a pool.

SELECT
name,
hardwareProfile,
healthStatus,
hibernateSupport,
imageReference,
localAdministrator,
location,
osType,
stopOnDisconnect,
storageProfile
FROM azure.developer_devcenter.pools
WHERE project_name = '{{ project_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_pools

Lists available pools.

SELECT
name,
hardwareProfile,
healthStatus,
hibernateSupport,
imageReference,
localAdministrator,
location,
osType,
stopOnDisconnect,
storageProfile
FROM azure.developer_devcenter.pools
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;