Pool Class

A pool of Dev Boxes.

Readonly variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

Pool(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

Pool name. Required.
location
str

Azure region where Dev Boxes in the pool are located. Required.
os_type
str or OSType

The operating system type of Dev Boxes in this pool. "Windows"
hardware_profile
HardwareProfile

Hardware settings for the Dev Boxes created in this pool.
hibernate_support
str or HibernateSupport

Indicates whether hibernate is enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and "OsUnsupported".
storage_profile
StorageProfile

Storage settings for Dev Box created in this pool.
image_reference
ImageReference

Image settings for Dev Boxes create in this pool.
local_administrator
str or LocalAdministratorStatus

Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes. Known values are: "Enabled" and "Disabled".
stop_on_disconnect
StopOnDisconnectConfiguration

Stop on disconnect configuration settings for Dev Boxes created in this pool.
health_status
str or PoolHealthStatus

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".

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

hardware_profile

Hardware settings for the Dev Boxes created in this pool.

hardware_profile: _models.HardwareProfile | None

health_status

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".

health_status: str | _models.PoolHealthStatus

hibernate_support

"Enabled", "Disabled", and "OsUnsupported".

hibernate_support: str | _models.HibernateSupport | None

image_reference

Image settings for Dev Boxes create in this pool.

image_reference: _models.ImageReference | None

local_administrator

Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes. Known values are: "Enabled" and "Disabled".

local_administrator: str | _models.LocalAdministratorStatus | None

location

Azure region where Dev Boxes in the pool are located. Required.

location: str

name

Pool name. Required.

name: str

os_type

The operating system type of Dev Boxes in this pool. "Windows"

os_type: str | _models.OSType | None

stop_on_disconnect

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

stop_on_disconnect: _models.StopOnDisconnectConfiguration | None

storage_profile

Storage settings for Dev Box created in this pool.

storage_profile: _models.StorageProfile | None