all_dev_boxes

Creates, updates, deletes, gets or lists an all_dev_boxes resource.

Overview

Name	all_dev_boxes
Type	Resource
Id	azure.developer_devcenter.all_dev_boxes

Fields

The following fields are returned by SELECT queries:

list_all_dev_boxes_by_user

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_all_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
list_all_dev_boxes_by_user	select	user_id, endpoint		Lists Dev Boxes in the Dev Center for a particular user.
list_all_dev_boxes	select	endpoint		Lists Dev Boxes that the caller has access to in the DevCenter.

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: )
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

list_all_dev_boxes_by_user

Lists Dev Boxes in the Dev Center 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.all_dev_boxes
WHERE user_id = '{{ user_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_all_dev_boxes

Lists Dev Boxes that the caller has access to in the DevCenter.

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