DevBox Class

A Dev Box.

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

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

Variables

Name Description
name
str

Display name for the Dev Box. Required.
project_name
str

Name of the project this Dev Box belongs to.
pool_name
str

The name of the Dev Box pool this machine belongs to. Required.
hibernate_support
str or HibernateSupport

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

The current provisioning state of the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Updating", "Starting", "Stopping", "Provisioning", "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
action_state
str

The current action state of the Dev Box. This is state is based on previous action performed by user.
power_state
str or PowerState

The current power state of the Dev Box. Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and "Hibernated".
unique_id
str

A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
error
Error

Provisioning or action error details. Populated only for error states.
location
str

Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.
os_type
str or OSType

The operating system type of this Dev Box. "Windows"
user
str

The AAD object id of the user this Dev Box is assigned to.
hardware_profile
HardwareProfile

Information about the Dev Box's hardware resources.
storage_profile
StorageProfile

Storage settings for this Dev Box.
image_reference
ImageReference

Information about the image used for this Dev Box.
created_time
datetime

Creation time of this Dev Box.
local_administrator
str or LocalAdministratorStatus

Indicates whether the owner of the Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".

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

action_state

The current action state of the Dev Box. This is state is based on previous action performed by user.

action_state: str | None

created_time

Creation time of this Dev Box.

created_time: datetime | None

error

Provisioning or action error details. Populated only for error states.

error: _models.Error | None

hardware_profile

Information about the Dev Box's hardware resources.

hardware_profile: _models.HardwareProfile | None

hibernate_support

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

hibernate_support: str | _models.HibernateSupport | None

image_reference

Information about the image used for this Dev Box.

image_reference: _models.ImageReference | None

local_administrator

Indicates whether the owner of the Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".

local_administrator: str | _models.LocalAdministratorStatus | None

location

Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.

location: str | None

name

Display name for the Dev Box. Required.

name: str

os_type

The operating system type of this Dev Box. "Windows"

os_type: str | _models.OSType | None

pool_name

The name of the Dev Box pool this machine belongs to. Required.

pool_name: str

power_state

"Unknown", "Running", "Deallocated", "PoweredOff", and "Hibernated".

power_state: str | _models.PowerState | None

project_name

Name of the project this Dev Box belongs to.

project_name: str | None

provisioning_state

"Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Updating", "Starting", "Stopping", "Provisioning", "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".

provisioning_state: str | _models.DevBoxProvisioningState | None

storage_profile

Storage settings for this Dev Box.

storage_profile: _models.StorageProfile | None

unique_id

A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

unique_id: str | None

user

The AAD object id of the user this Dev Box is assigned to.

user: str | None