dev_boxes

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

Overview

Name	dev_boxes
Type	Resource
Id	azure.developer_devcenter.dev_boxes

Fields

The following fields are returned by SELECT queries:

get_dev_box

Name	Datatype	Description
name	string	Display name for the Dev Box. Required.
actionState	string	The current action state of the Dev Box. This is state is based on previous action performed by user.
createdTime	string (date-time)	Creation time of this Dev Box.
error	object	Provisioning or action error details. Populated only for error states.
hardwareProfile	object	Information about the Dev Box's hardware resources.
hibernateSupport	string	Indicates whether hibernate is enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and "OsUnsupported". (Enabled, Disabled, OsUnsupported)
imageReference	object	Information about the image used for this Dev Box.
localAdministrator	string	Indicates whether the owner of the Dev Box is a local administrator. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.
osType	string	The operating system type of this Dev Box. "Windows" (Windows)
poolName	string	The name of the Dev Box pool this machine belongs to. Required.
powerState	string	The current power state of the Dev Box. Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and "Hibernated". (Unknown, Running, Deallocated, PoweredOff, Hibernated)
projectName	string	Name of the project this Dev Box belongs to.
provisioningState	string	The current provisioning state of the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Updating", "Starting", "Stopping", "Provisioning", "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned". (Succeeded, Failed, Canceled, Creating, Deleting, Updating, Starting, Stopping, Provisioning, ProvisionedWithWarning, InGracePeriod, NotProvisioned)
storageProfile	object	Storage settings for this Dev Box.
uniqueId	string	A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
user	string	The AAD object id of the user this Dev Box is assigned to.

list_dev_boxes

Name	Datatype	Description
name	string	Display name for the Dev Box. Required.
actionState	string	The current action state of the Dev Box. This is state is based on previous action performed by user.
createdTime	string (date-time)	Creation time of this Dev Box.
error	object	Provisioning or action error details. Populated only for error states.
hardwareProfile	object	Information about the Dev Box's hardware resources.
hibernateSupport	string	Indicates whether hibernate is enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and "OsUnsupported". (Enabled, Disabled, OsUnsupported)
imageReference	object	Information about the image used for this Dev Box.
localAdministrator	string	Indicates whether the owner of the Dev Box is a local administrator. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
location	string	Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.
osType	string	The operating system type of this Dev Box. "Windows" (Windows)
poolName	string	The name of the Dev Box pool this machine belongs to. Required.
powerState	string	The current power state of the Dev Box. Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and "Hibernated". (Unknown, Running, Deallocated, PoweredOff, Hibernated)
projectName	string	Name of the project this Dev Box belongs to.
provisioningState	string	The current provisioning state of the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Updating", "Starting", "Stopping", "Provisioning", "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned". (Succeeded, Failed, Canceled, Creating, Deleting, Updating, Starting, Stopping, Provisioning, ProvisionedWithWarning, InGracePeriod, NotProvisioned)
storageProfile	object	Storage settings for this Dev Box.
uniqueId	string	A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
user	string	The AAD object id of the user this Dev Box is assigned to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dev_box	select	project_name, user_id, dev_box_name, endpoint		Gets a Dev Box.
list_dev_boxes	select	project_name, user_id, endpoint		Lists Dev Boxes in the project for a particular user.
create_dev_box	insert	project_name, user_id, dev_box_name, endpoint, poolName		Creates or replaces a Dev Box.
delete_dev_box	delete	project_name, user_id, dev_box_name, endpoint		Deletes a Dev Box.

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
dev_box_name	string	The name of a Dev Box. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
project_name	string	The DevCenter Project upon which to execute operations. Required.
user_id	string	The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.

SELECT examples

get_dev_box

Gets a Dev Box.

SELECT
name,
actionState,
createdTime,
error,
hardwareProfile,
hibernateSupport,
imageReference,
localAdministrator,
location,
osType,
poolName,
powerState,
projectName,
provisioningState,
storageProfile,
uniqueId,
user
FROM azure.developer_devcenter.dev_boxes
WHERE project_name = '{{ project_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND dev_box_name = '{{ dev_box_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_dev_boxes

Lists Dev Boxes in the project for a particular user.

SELECT
name,
actionState,
createdTime,
error,
hardwareProfile,
hibernateSupport,
imageReference,
localAdministrator,
location,
osType,
poolName,
powerState,
projectName,
provisioningState,
storageProfile,
uniqueId,
user
FROM azure.developer_devcenter.dev_boxes
WHERE project_name = '{{ project_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_dev_box

Creates or replaces a Dev Box.

INSERT INTO azure.developer_devcenter.dev_boxes (
poolName,
localAdministrator,
project_name,
user_id,
dev_box_name,
endpoint
)
SELECT 
'{{ poolName }}' /* required */,
'{{ localAdministrator }}',
'{{ project_name }}',
'{{ user_id }}',
'{{ dev_box_name }}',
'{{ endpoint }}'
RETURNING
name,
actionState,
createdTime,
error,
hardwareProfile,
hibernateSupport,
imageReference,
localAdministrator,
location,
osType,
poolName,
powerState,
projectName,
provisioningState,
storageProfile,
uniqueId,
user
;

Manifest

# Description fields are for documentation purposes
- name: dev_boxes
props:
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the dev_boxes resource.
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the dev_boxes resource.
  - name: dev_box_name
    value: "{{ dev_box_name }}"
    description: Required parameter for the dev_boxes resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the dev_boxes resource.
  - name: poolName
    value: "{{ poolName }}"
    description: |
      The name of the Dev Box pool this machine belongs to. Required.
  - name: localAdministrator
    value: "{{ localAdministrator }}"
    description: |
      Indicates whether the owner of the Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
    valid_values: ['Enabled', 'Disabled']

DELETE examples

delete_dev_box

Deletes a Dev Box.

DELETE FROM azure.developer_devcenter.dev_boxes
WHERE project_name = '{{ project_name }}' --required
AND user_id = '{{ user_id }}' --required
AND dev_box_name = '{{ dev_box_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;